/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Contains the response to a successful AssumeRoleWithWebIdentity
* request, including temporary Amazon Web Services credentials that can be used to
* make Amazon Web Services requests. See Also:
AWS
* API Reference
The temporary security credentials, which include an access key ID, a secret * access key, and a security token.
The size of the security token * that STS API operations return is not fixed. We strongly recommend that you make * no assumptions about the maximum size.
*/ inline const Credentials& GetCredentials() const{ return m_credentials; } /** *The temporary security credentials, which include an access key ID, a secret * access key, and a security token.
The size of the security token * that STS API operations return is not fixed. We strongly recommend that you make * no assumptions about the maximum size.
*/ inline void SetCredentials(const Credentials& value) { m_credentials = value; } /** *The temporary security credentials, which include an access key ID, a secret * access key, and a security token.
The size of the security token * that STS API operations return is not fixed. We strongly recommend that you make * no assumptions about the maximum size.
*/ inline void SetCredentials(Credentials&& value) { m_credentials = std::move(value); } /** *The temporary security credentials, which include an access key ID, a secret * access key, and a security token.
The size of the security token * that STS API operations return is not fixed. We strongly recommend that you make * no assumptions about the maximum size.
*/ inline AssumeRoleWithWebIdentityResult& WithCredentials(const Credentials& value) { SetCredentials(value); return *this;} /** *The temporary security credentials, which include an access key ID, a secret * access key, and a security token.
The size of the security token * that STS API operations return is not fixed. We strongly recommend that you make * no assumptions about the maximum size.
*/ inline AssumeRoleWithWebIdentityResult& WithCredentials(Credentials&& value) { SetCredentials(std::move(value)); return *this;} /** *The unique user identifier that is returned by the identity provider. This
* identifier is associated with the WebIdentityToken
that was
* submitted with the AssumeRoleWithWebIdentity
call. The identifier
* is typically unique to the user and the application that acquired the
* WebIdentityToken
(pairwise identifier). For OpenID Connect ID
* tokens, this field contains the value returned by the identity provider as the
* token's sub
(Subject) claim.
The unique user identifier that is returned by the identity provider. This
* identifier is associated with the WebIdentityToken
that was
* submitted with the AssumeRoleWithWebIdentity
call. The identifier
* is typically unique to the user and the application that acquired the
* WebIdentityToken
(pairwise identifier). For OpenID Connect ID
* tokens, this field contains the value returned by the identity provider as the
* token's sub
(Subject) claim.
The unique user identifier that is returned by the identity provider. This
* identifier is associated with the WebIdentityToken
that was
* submitted with the AssumeRoleWithWebIdentity
call. The identifier
* is typically unique to the user and the application that acquired the
* WebIdentityToken
(pairwise identifier). For OpenID Connect ID
* tokens, this field contains the value returned by the identity provider as the
* token's sub
(Subject) claim.
The unique user identifier that is returned by the identity provider. This
* identifier is associated with the WebIdentityToken
that was
* submitted with the AssumeRoleWithWebIdentity
call. The identifier
* is typically unique to the user and the application that acquired the
* WebIdentityToken
(pairwise identifier). For OpenID Connect ID
* tokens, this field contains the value returned by the identity provider as the
* token's sub
(Subject) claim.
The unique user identifier that is returned by the identity provider. This
* identifier is associated with the WebIdentityToken
that was
* submitted with the AssumeRoleWithWebIdentity
call. The identifier
* is typically unique to the user and the application that acquired the
* WebIdentityToken
(pairwise identifier). For OpenID Connect ID
* tokens, this field contains the value returned by the identity provider as the
* token's sub
(Subject) claim.
The unique user identifier that is returned by the identity provider. This
* identifier is associated with the WebIdentityToken
that was
* submitted with the AssumeRoleWithWebIdentity
call. The identifier
* is typically unique to the user and the application that acquired the
* WebIdentityToken
(pairwise identifier). For OpenID Connect ID
* tokens, this field contains the value returned by the identity provider as the
* token's sub
(Subject) claim.
The unique user identifier that is returned by the identity provider. This
* identifier is associated with the WebIdentityToken
that was
* submitted with the AssumeRoleWithWebIdentity
call. The identifier
* is typically unique to the user and the application that acquired the
* WebIdentityToken
(pairwise identifier). For OpenID Connect ID
* tokens, this field contains the value returned by the identity provider as the
* token's sub
(Subject) claim.
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers
* that you can use to refer to the resulting temporary security credentials. For
* example, you can reference these credentials as a principal in a resource-based
* policy by using the ARN or assumed role ID. The ARN and ID include the
* RoleSessionName
that you specified when you called
* AssumeRole
.
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers
* that you can use to refer to the resulting temporary security credentials. For
* example, you can reference these credentials as a principal in a resource-based
* policy by using the ARN or assumed role ID. The ARN and ID include the
* RoleSessionName
that you specified when you called
* AssumeRole
.
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers
* that you can use to refer to the resulting temporary security credentials. For
* example, you can reference these credentials as a principal in a resource-based
* policy by using the ARN or assumed role ID. The ARN and ID include the
* RoleSessionName
that you specified when you called
* AssumeRole
.
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers
* that you can use to refer to the resulting temporary security credentials. For
* example, you can reference these credentials as a principal in a resource-based
* policy by using the ARN or assumed role ID. The ARN and ID include the
* RoleSessionName
that you specified when you called
* AssumeRole
.
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers
* that you can use to refer to the resulting temporary security credentials. For
* example, you can reference these credentials as a principal in a resource-based
* policy by using the ARN or assumed role ID. The ARN and ID include the
* RoleSessionName
that you specified when you called
* AssumeRole
.
A percentage value that indicates the packed size of the session policies and * session tags combined passed in the request. The request fails if the packed * size is greater than 100 percent, which means the policies and tags exceeded the * allowed space.
*/ inline int GetPackedPolicySize() const{ return m_packedPolicySize; } /** *A percentage value that indicates the packed size of the session policies and * session tags combined passed in the request. The request fails if the packed * size is greater than 100 percent, which means the policies and tags exceeded the * allowed space.
*/ inline void SetPackedPolicySize(int value) { m_packedPolicySize = value; } /** *A percentage value that indicates the packed size of the session policies and * session tags combined passed in the request. The request fails if the packed * size is greater than 100 percent, which means the policies and tags exceeded the * allowed space.
*/ inline AssumeRoleWithWebIdentityResult& WithPackedPolicySize(int value) { SetPackedPolicySize(value); return *this;} /** * The issuing authority of the web identity token presented. For OpenID
* Connect ID tokens, this contains the value of the iss
field. For
* OAuth 2.0 access tokens, this contains the value of the ProviderId
* parameter that was passed in the AssumeRoleWithWebIdentity
* request.
The issuing authority of the web identity token presented. For OpenID
* Connect ID tokens, this contains the value of the iss
field. For
* OAuth 2.0 access tokens, this contains the value of the ProviderId
* parameter that was passed in the AssumeRoleWithWebIdentity
* request.
The issuing authority of the web identity token presented. For OpenID
* Connect ID tokens, this contains the value of the iss
field. For
* OAuth 2.0 access tokens, this contains the value of the ProviderId
* parameter that was passed in the AssumeRoleWithWebIdentity
* request.
The issuing authority of the web identity token presented. For OpenID
* Connect ID tokens, this contains the value of the iss
field. For
* OAuth 2.0 access tokens, this contains the value of the ProviderId
* parameter that was passed in the AssumeRoleWithWebIdentity
* request.
The issuing authority of the web identity token presented. For OpenID
* Connect ID tokens, this contains the value of the iss
field. For
* OAuth 2.0 access tokens, this contains the value of the ProviderId
* parameter that was passed in the AssumeRoleWithWebIdentity
* request.
The issuing authority of the web identity token presented. For OpenID
* Connect ID tokens, this contains the value of the iss
field. For
* OAuth 2.0 access tokens, this contains the value of the ProviderId
* parameter that was passed in the AssumeRoleWithWebIdentity
* request.
The issuing authority of the web identity token presented. For OpenID
* Connect ID tokens, this contains the value of the iss
field. For
* OAuth 2.0 access tokens, this contains the value of the ProviderId
* parameter that was passed in the AssumeRoleWithWebIdentity
* request.
The intended audience (also known as client ID) of the web identity token. * This is traditionally the client identifier issued to the application that * requested the web identity token.
*/ inline const Aws::String& GetAudience() const{ return m_audience; } /** *The intended audience (also known as client ID) of the web identity token. * This is traditionally the client identifier issued to the application that * requested the web identity token.
*/ inline void SetAudience(const Aws::String& value) { m_audience = value; } /** *The intended audience (also known as client ID) of the web identity token. * This is traditionally the client identifier issued to the application that * requested the web identity token.
*/ inline void SetAudience(Aws::String&& value) { m_audience = std::move(value); } /** *The intended audience (also known as client ID) of the web identity token. * This is traditionally the client identifier issued to the application that * requested the web identity token.
*/ inline void SetAudience(const char* value) { m_audience.assign(value); } /** *The intended audience (also known as client ID) of the web identity token. * This is traditionally the client identifier issued to the application that * requested the web identity token.
*/ inline AssumeRoleWithWebIdentityResult& WithAudience(const Aws::String& value) { SetAudience(value); return *this;} /** *The intended audience (also known as client ID) of the web identity token. * This is traditionally the client identifier issued to the application that * requested the web identity token.
*/ inline AssumeRoleWithWebIdentityResult& WithAudience(Aws::String&& value) { SetAudience(std::move(value)); return *this;} /** *The intended audience (also known as client ID) of the web identity token. * This is traditionally the client identifier issued to the application that * requested the web identity token.
*/ inline AssumeRoleWithWebIdentityResult& WithAudience(const char* value) { SetAudience(value); return *this;} /** *The value of the source identity that is returned in the JSON web token (JWT) * from the identity provider.
You can require users to set a source
* identity value when they assume a role. You do this by using the
* sts:SourceIdentity
condition key in a role trust policy. That way,
* actions that are taken with the role are associated with that user. After the
* source identity is set, the value cannot be changed. It is present in the
* request for all actions that are taken by the role and persists across chained
* role sessions. You can configure your identity provider to use an attribute
* associated with your users, like user name or email, as the source identity when
* calling AssumeRoleWithWebIdentity
. You do this by adding a claim to
* the JSON web token. To learn more about OIDC tokens and claims, see Using
* Tokens with User Pools in the Amazon Cognito Developer Guide. For
* more information about using source identity, see Monitor
* and control actions taken with assumed roles in the IAM User
* Guide.
The regex used to validate this parameter is a string of * characters consisting of upper- and lower-case alphanumeric characters with no * spaces. You can also include underscores or any of the following characters: * =,.@-
*/ inline const Aws::String& GetSourceIdentity() const{ return m_sourceIdentity; } /** *The value of the source identity that is returned in the JSON web token (JWT) * from the identity provider.
You can require users to set a source
* identity value when they assume a role. You do this by using the
* sts:SourceIdentity
condition key in a role trust policy. That way,
* actions that are taken with the role are associated with that user. After the
* source identity is set, the value cannot be changed. It is present in the
* request for all actions that are taken by the role and persists across chained
* role sessions. You can configure your identity provider to use an attribute
* associated with your users, like user name or email, as the source identity when
* calling AssumeRoleWithWebIdentity
. You do this by adding a claim to
* the JSON web token. To learn more about OIDC tokens and claims, see Using
* Tokens with User Pools in the Amazon Cognito Developer Guide. For
* more information about using source identity, see Monitor
* and control actions taken with assumed roles in the IAM User
* Guide.
The regex used to validate this parameter is a string of * characters consisting of upper- and lower-case alphanumeric characters with no * spaces. You can also include underscores or any of the following characters: * =,.@-
*/ inline void SetSourceIdentity(const Aws::String& value) { m_sourceIdentity = value; } /** *The value of the source identity that is returned in the JSON web token (JWT) * from the identity provider.
You can require users to set a source
* identity value when they assume a role. You do this by using the
* sts:SourceIdentity
condition key in a role trust policy. That way,
* actions that are taken with the role are associated with that user. After the
* source identity is set, the value cannot be changed. It is present in the
* request for all actions that are taken by the role and persists across chained
* role sessions. You can configure your identity provider to use an attribute
* associated with your users, like user name or email, as the source identity when
* calling AssumeRoleWithWebIdentity
. You do this by adding a claim to
* the JSON web token. To learn more about OIDC tokens and claims, see Using
* Tokens with User Pools in the Amazon Cognito Developer Guide. For
* more information about using source identity, see Monitor
* and control actions taken with assumed roles in the IAM User
* Guide.
The regex used to validate this parameter is a string of * characters consisting of upper- and lower-case alphanumeric characters with no * spaces. You can also include underscores or any of the following characters: * =,.@-
*/ inline void SetSourceIdentity(Aws::String&& value) { m_sourceIdentity = std::move(value); } /** *The value of the source identity that is returned in the JSON web token (JWT) * from the identity provider.
You can require users to set a source
* identity value when they assume a role. You do this by using the
* sts:SourceIdentity
condition key in a role trust policy. That way,
* actions that are taken with the role are associated with that user. After the
* source identity is set, the value cannot be changed. It is present in the
* request for all actions that are taken by the role and persists across chained
* role sessions. You can configure your identity provider to use an attribute
* associated with your users, like user name or email, as the source identity when
* calling AssumeRoleWithWebIdentity
. You do this by adding a claim to
* the JSON web token. To learn more about OIDC tokens and claims, see Using
* Tokens with User Pools in the Amazon Cognito Developer Guide. For
* more information about using source identity, see Monitor
* and control actions taken with assumed roles in the IAM User
* Guide.
The regex used to validate this parameter is a string of * characters consisting of upper- and lower-case alphanumeric characters with no * spaces. You can also include underscores or any of the following characters: * =,.@-
*/ inline void SetSourceIdentity(const char* value) { m_sourceIdentity.assign(value); } /** *The value of the source identity that is returned in the JSON web token (JWT) * from the identity provider.
You can require users to set a source
* identity value when they assume a role. You do this by using the
* sts:SourceIdentity
condition key in a role trust policy. That way,
* actions that are taken with the role are associated with that user. After the
* source identity is set, the value cannot be changed. It is present in the
* request for all actions that are taken by the role and persists across chained
* role sessions. You can configure your identity provider to use an attribute
* associated with your users, like user name or email, as the source identity when
* calling AssumeRoleWithWebIdentity
. You do this by adding a claim to
* the JSON web token. To learn more about OIDC tokens and claims, see Using
* Tokens with User Pools in the Amazon Cognito Developer Guide. For
* more information about using source identity, see Monitor
* and control actions taken with assumed roles in the IAM User
* Guide.
The regex used to validate this parameter is a string of * characters consisting of upper- and lower-case alphanumeric characters with no * spaces. You can also include underscores or any of the following characters: * =,.@-
*/ inline AssumeRoleWithWebIdentityResult& WithSourceIdentity(const Aws::String& value) { SetSourceIdentity(value); return *this;} /** *The value of the source identity that is returned in the JSON web token (JWT) * from the identity provider.
You can require users to set a source
* identity value when they assume a role. You do this by using the
* sts:SourceIdentity
condition key in a role trust policy. That way,
* actions that are taken with the role are associated with that user. After the
* source identity is set, the value cannot be changed. It is present in the
* request for all actions that are taken by the role and persists across chained
* role sessions. You can configure your identity provider to use an attribute
* associated with your users, like user name or email, as the source identity when
* calling AssumeRoleWithWebIdentity
. You do this by adding a claim to
* the JSON web token. To learn more about OIDC tokens and claims, see Using
* Tokens with User Pools in the Amazon Cognito Developer Guide. For
* more information about using source identity, see Monitor
* and control actions taken with assumed roles in the IAM User
* Guide.
The regex used to validate this parameter is a string of * characters consisting of upper- and lower-case alphanumeric characters with no * spaces. You can also include underscores or any of the following characters: * =,.@-
*/ inline AssumeRoleWithWebIdentityResult& WithSourceIdentity(Aws::String&& value) { SetSourceIdentity(std::move(value)); return *this;} /** *The value of the source identity that is returned in the JSON web token (JWT) * from the identity provider.
You can require users to set a source
* identity value when they assume a role. You do this by using the
* sts:SourceIdentity
condition key in a role trust policy. That way,
* actions that are taken with the role are associated with that user. After the
* source identity is set, the value cannot be changed. It is present in the
* request for all actions that are taken by the role and persists across chained
* role sessions. You can configure your identity provider to use an attribute
* associated with your users, like user name or email, as the source identity when
* calling AssumeRoleWithWebIdentity
. You do this by adding a claim to
* the JSON web token. To learn more about OIDC tokens and claims, see Using
* Tokens with User Pools in the Amazon Cognito Developer Guide. For
* more information about using source identity, see Monitor
* and control actions taken with assumed roles in the IAM User
* Guide.
The regex used to validate this parameter is a string of * characters consisting of upper- and lower-case alphanumeric characters with no * spaces. You can also include underscores or any of the following characters: * =,.@-
*/ inline AssumeRoleWithWebIdentityResult& WithSourceIdentity(const char* value) { SetSourceIdentity(value); return *this;} inline const ResponseMetadata& GetResponseMetadata() const{ return m_responseMetadata; } inline void SetResponseMetadata(const ResponseMetadata& value) { m_responseMetadata = value; } inline void SetResponseMetadata(ResponseMetadata&& value) { m_responseMetadata = std::move(value); } inline AssumeRoleWithWebIdentityResult& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;} inline AssumeRoleWithWebIdentityResult& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;} private: Credentials m_credentials; Aws::String m_subjectFromWebIdentityToken; AssumedRoleUser m_assumedRoleUser; int m_packedPolicySize; Aws::String m_provider; Aws::String m_audience; Aws::String m_sourceIdentity; ResponseMetadata m_responseMetadata; }; } // namespace Model } // namespace STS } // namespace Aws