/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Xml { class XmlDocument; } // namespace Xml } // namespace Utils namespace STS { namespace Model { /** *

Contains the response to a successful AssumeRoleWithWebIdentity * request, including temporary AWS credentials that can be used to make AWS * requests.

See Also:

AWS * API Reference

*/ class AWS_STS_API AssumeRoleWithWebIdentityResult { public: AssumeRoleWithWebIdentityResult(); AssumeRoleWithWebIdentityResult(const Aws::AmazonWebServiceResult& result); AssumeRoleWithWebIdentityResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

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.

*/ inline const Aws::String& GetSubjectFromWebIdentityToken() const{ return m_subjectFromWebIdentityToken; } /** *

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.

*/ inline void SetSubjectFromWebIdentityToken(const Aws::String& value) { m_subjectFromWebIdentityToken = value; } /** *

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.

*/ inline void SetSubjectFromWebIdentityToken(Aws::String&& value) { m_subjectFromWebIdentityToken = std::move(value); } /** *

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.

*/ inline void SetSubjectFromWebIdentityToken(const char* value) { m_subjectFromWebIdentityToken.assign(value); } /** *

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.

*/ inline AssumeRoleWithWebIdentityResult& WithSubjectFromWebIdentityToken(const Aws::String& value) { SetSubjectFromWebIdentityToken(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.

*/ inline AssumeRoleWithWebIdentityResult& WithSubjectFromWebIdentityToken(Aws::String&& value) { SetSubjectFromWebIdentityToken(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.

*/ inline AssumeRoleWithWebIdentityResult& WithSubjectFromWebIdentityToken(const char* value) { SetSubjectFromWebIdentityToken(value); return *this;} /** *

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.

*/ inline const AssumedRoleUser& GetAssumedRoleUser() const{ return m_assumedRoleUser; } /** *

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.

*/ inline void SetAssumedRoleUser(const AssumedRoleUser& value) { m_assumedRoleUser = value; } /** *

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.

*/ inline void SetAssumedRoleUser(AssumedRoleUser&& value) { m_assumedRoleUser = std::move(value); } /** *

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.

*/ inline AssumeRoleWithWebIdentityResult& WithAssumedRoleUser(const AssumedRoleUser& value) { SetAssumedRoleUser(value); return *this;} /** *

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.

*/ inline AssumeRoleWithWebIdentityResult& WithAssumedRoleUser(AssumedRoleUser&& value) { SetAssumedRoleUser(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetProvider() const{ return m_provider; } /** *

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.

*/ inline void SetProvider(const Aws::String& value) { m_provider = value; } /** *

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.

*/ inline void SetProvider(Aws::String&& value) { m_provider = std::move(value); } /** *

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.

*/ inline void SetProvider(const char* value) { m_provider.assign(value); } /** *

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.

*/ inline AssumeRoleWithWebIdentityResult& WithProvider(const Aws::String& value) { SetProvider(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.

*/ inline AssumeRoleWithWebIdentityResult& WithProvider(Aws::String&& value) { SetProvider(std::move(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.

*/ inline AssumeRoleWithWebIdentityResult& WithProvider(const char* value) { SetProvider(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 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;} 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; ResponseMetadata m_responseMetadata; }; } // namespace Model } // namespace STS } // namespace Aws