| 1 | |||
| 2 | package Paws::STS::AssumeRoleWithWebIdentityResponse; | ||
| 3 | use Moose; | ||
| 4 | has AssumedRoleUser => (is => 'ro', isa => 'Paws::STS::AssumedRoleUser'); | ||
| 5 | has Audience => (is => 'ro', isa => 'Str'); | ||
| 6 | has Credentials => (is => 'ro', isa => 'Paws::STS::Credentials'); | ||
| 7 | has PackedPolicySize => (is => 'ro', isa => 'Int'); | ||
| 8 | has Provider => (is => 'ro', isa => 'Str'); | ||
| 9 | has SourceIdentity => (is => 'ro', isa => 'Str'); | ||
| 10 | has SubjectFromWebIdentityToken => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::STS::AssumeRoleWithWebIdentityResponse | ||
| 20 | |||
| 21 | =head1 ATTRIBUTES | ||
| 22 | |||
| 23 | |||
| 24 | =head2 AssumedRoleUser => L<Paws::STS::AssumedRoleUser> | ||
| 25 | |||
| 26 | The Amazon Resource Name (ARN) and the assumed role ID, which are | ||
| 27 | identifiers that you can use to refer to the resulting temporary | ||
| 28 | security credentials. For example, you can reference these credentials | ||
| 29 | as a principal in a resource-based policy by using the ARN or assumed | ||
| 30 | role ID. The ARN and ID include the C<RoleSessionName> that you | ||
| 31 | specified when you called C<AssumeRole>. | ||
| 32 | |||
| 33 | |||
| 34 | =head2 Audience => Str | ||
| 35 | |||
| 36 | The intended audience (also known as client ID) of the web identity | ||
| 37 | token. This is traditionally the client identifier issued to the | ||
| 38 | application that requested the web identity token. | ||
| 39 | |||
| 40 | |||
| 41 | =head2 Credentials => L<Paws::STS::Credentials> | ||
| 42 | |||
| 43 | The temporary security credentials, which include an access key ID, a | ||
| 44 | secret access key, and a security token. | ||
| 45 | |||
| 46 | The size of the security token that STS API operations return is not | ||
| 47 | fixed. We strongly recommend that you make no assumptions about the | ||
| 48 | maximum size. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 PackedPolicySize => Int | ||
| 52 | |||
| 53 | A percentage value that indicates the packed size of the session | ||
| 54 | policies and session tags combined passed in the request. The request | ||
| 55 | fails if the packed size is greater than 100 percent, which means the | ||
| 56 | policies and tags exceeded the allowed space. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Provider => Str | ||
| 60 | |||
| 61 | The issuing authority of the web identity token presented. For OpenID | ||
| 62 | Connect ID tokens, this contains the value of the C<iss> field. For | ||
| 63 | OAuth 2.0 access tokens, this contains the value of the C<ProviderId> | ||
| 64 | parameter that was passed in the C<AssumeRoleWithWebIdentity> request. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 SourceIdentity => Str | ||
| 68 | |||
| 69 | The value of the source identity that is returned in the JSON web token | ||
| 70 | (JWT) from the identity provider. | ||
| 71 | |||
| 72 | You can require users to set a source identity value when they assume a | ||
| 73 | role. You do this by using the C<sts:SourceIdentity> condition key in a | ||
| 74 | role trust policy. That way, actions that are taken with the role are | ||
| 75 | associated with that user. After the source identity is set, the value | ||
| 76 | cannot be changed. It is present in the request for all actions that | ||
| 77 | are taken by the role and persists across chained role | ||
| 78 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining) | ||
| 79 | sessions. You can configure your identity provider to use an attribute | ||
| 80 | associated with your users, like user name or email, as the source | ||
| 81 | identity when calling C<AssumeRoleWithWebIdentity>. You do this by | ||
| 82 | adding a claim to the JSON web token. To learn more about OIDC tokens | ||
| 83 | and claims, see Using Tokens with User Pools | ||
| 84 | (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html) | ||
| 85 | in the I<Amazon Cognito Developer Guide>. For more information about | ||
| 86 | using source identity, see Monitor and control actions taken with | ||
| 87 | assumed roles | ||
| 88 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) | ||
| 89 | in the I<IAM User Guide>. | ||
| 90 | |||
| 91 | The regex used to validate this parameter is a string of characters | ||
| 92 | consisting of upper- and lower-case alphanumeric characters with no | ||
| 93 | spaces. You can also include underscores or any of the following | ||
| 94 | characters: =,.@- | ||
| 95 | |||
| 96 | |||
| 97 | =head2 SubjectFromWebIdentityToken => Str | ||
| 98 | |||
| 99 | The unique user identifier that is returned by the identity provider. | ||
| 100 | This identifier is associated with the C<WebIdentityToken> that was | ||
| 101 | submitted with the C<AssumeRoleWithWebIdentity> call. The identifier is | ||
| 102 | typically unique to the user and the application that acquired the | ||
| 103 | C<WebIdentityToken> (pairwise identifier). For OpenID Connect ID | ||
| 104 | tokens, this field contains the value returned by the identity provider | ||
| 105 | as the token's C<sub> (Subject) claim. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 _request_id => Str | ||
| 109 | |||
| 110 | |||
| 111 | =cut | ||
| 112 |