/** * 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 AssumeRole request, including * temporary Amazon Web Services credentials that can be used to make Amazon Web * Services requests.

See Also:

AWS * API Reference

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

The temporary security credentials, which include an access key ID, a secret * access key, and a security (or session) 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 (or session) 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 (or session) 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 (or session) 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 AssumeRoleResult& 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 (or session) 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 AssumeRoleResult& WithCredentials(Credentials&& value) { SetCredentials(std::move(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 AssumeRoleResult& 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 AssumeRoleResult& 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 AssumeRoleResult& WithPackedPolicySize(int value) { SetPackedPolicySize(value); return *this;} /** *

The source identity specified by the principal that is calling the * AssumeRole operation.

You can require users to specify a * source identity when they assume a role. You do this by using the * sts:SourceIdentity condition key in a role trust policy. You can * use source identity information in CloudTrail logs to determine who took actions * with a role. You can use the aws:SourceIdentity condition key to * further control access to Amazon Web Services resources based on the value of * source identity. 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 source identity specified by the principal that is calling the * AssumeRole operation.

You can require users to specify a * source identity when they assume a role. You do this by using the * sts:SourceIdentity condition key in a role trust policy. You can * use source identity information in CloudTrail logs to determine who took actions * with a role. You can use the aws:SourceIdentity condition key to * further control access to Amazon Web Services resources based on the value of * source identity. 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 source identity specified by the principal that is calling the * AssumeRole operation.

You can require users to specify a * source identity when they assume a role. You do this by using the * sts:SourceIdentity condition key in a role trust policy. You can * use source identity information in CloudTrail logs to determine who took actions * with a role. You can use the aws:SourceIdentity condition key to * further control access to Amazon Web Services resources based on the value of * source identity. 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 source identity specified by the principal that is calling the * AssumeRole operation.

You can require users to specify a * source identity when they assume a role. You do this by using the * sts:SourceIdentity condition key in a role trust policy. You can * use source identity information in CloudTrail logs to determine who took actions * with a role. You can use the aws:SourceIdentity condition key to * further control access to Amazon Web Services resources based on the value of * source identity. 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 source identity specified by the principal that is calling the * AssumeRole operation.

You can require users to specify a * source identity when they assume a role. You do this by using the * sts:SourceIdentity condition key in a role trust policy. You can * use source identity information in CloudTrail logs to determine who took actions * with a role. You can use the aws:SourceIdentity condition key to * further control access to Amazon Web Services resources based on the value of * source identity. 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 AssumeRoleResult& WithSourceIdentity(const Aws::String& value) { SetSourceIdentity(value); return *this;} /** *

The source identity specified by the principal that is calling the * AssumeRole operation.

You can require users to specify a * source identity when they assume a role. You do this by using the * sts:SourceIdentity condition key in a role trust policy. You can * use source identity information in CloudTrail logs to determine who took actions * with a role. You can use the aws:SourceIdentity condition key to * further control access to Amazon Web Services resources based on the value of * source identity. 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 AssumeRoleResult& WithSourceIdentity(Aws::String&& value) { SetSourceIdentity(std::move(value)); return *this;} /** *

The source identity specified by the principal that is calling the * AssumeRole operation.

You can require users to specify a * source identity when they assume a role. You do this by using the * sts:SourceIdentity condition key in a role trust policy. You can * use source identity information in CloudTrail logs to determine who took actions * with a role. You can use the aws:SourceIdentity condition key to * further control access to Amazon Web Services resources based on the value of * source identity. 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 AssumeRoleResult& 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 AssumeRoleResult& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;} inline AssumeRoleResult& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;} private: Credentials m_credentials; AssumedRoleUser m_assumedRoleUser; int m_packedPolicySize; Aws::String m_sourceIdentity; ResponseMetadata m_responseMetadata; }; } // namespace Model } // namespace STS } // namespace Aws