/** * 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 AssumeRoleWithSAML request, * including temporary AWS credentials that can be used to make AWS requests. *

See Also:

AWS * API Reference

*/ class AWS_STS_API AssumeRoleWithSAMLResult { public: AssumeRoleWithSAMLResult(); AssumeRoleWithSAMLResult(const Aws::AmazonWebServiceResult& result); AssumeRoleWithSAMLResult& 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 AssumeRoleWithSAMLResult& 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 AssumeRoleWithSAMLResult& WithCredentials(Credentials&& value) { SetCredentials(std::move(value)); return *this;} /** *

The identifiers for the temporary security credentials that the operation * returns.

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

The identifiers for the temporary security credentials that the operation * returns.

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

The identifiers for the temporary security credentials that the operation * returns.

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

The identifiers for the temporary security credentials that the operation * returns.

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

The identifiers for the temporary security credentials that the operation * returns.

*/ inline AssumeRoleWithSAMLResult& 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 AssumeRoleWithSAMLResult& WithPackedPolicySize(int value) { SetPackedPolicySize(value); return *this;} /** *

The value of the NameID element in the Subject * element of the SAML assertion.

*/ inline const Aws::String& GetSubject() const{ return m_subject; } /** *

The value of the NameID element in the Subject * element of the SAML assertion.

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

The value of the NameID element in the Subject * element of the SAML assertion.

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

The value of the NameID element in the Subject * element of the SAML assertion.

*/ inline void SetSubject(const char* value) { m_subject.assign(value); } /** *

The value of the NameID element in the Subject * element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithSubject(const Aws::String& value) { SetSubject(value); return *this;} /** *

The value of the NameID element in the Subject * element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithSubject(Aws::String&& value) { SetSubject(std::move(value)); return *this;} /** *

The value of the NameID element in the Subject * element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithSubject(const char* value) { SetSubject(value); return *this;} /** *

The format of the name ID, as defined by the Format attribute * in the NameID element of the SAML assertion. Typical examples of * the format are transient or persistent.

If * the format includes the prefix * urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. * For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is * returned as transient. If the format includes any other prefix, the * format is returned with no modifications.

*/ inline const Aws::String& GetSubjectType() const{ return m_subjectType; } /** *

The format of the name ID, as defined by the Format attribute * in the NameID element of the SAML assertion. Typical examples of * the format are transient or persistent.

If * the format includes the prefix * urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. * For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is * returned as transient. If the format includes any other prefix, the * format is returned with no modifications.

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

The format of the name ID, as defined by the Format attribute * in the NameID element of the SAML assertion. Typical examples of * the format are transient or persistent.

If * the format includes the prefix * urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. * For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is * returned as transient. If the format includes any other prefix, the * format is returned with no modifications.

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

The format of the name ID, as defined by the Format attribute * in the NameID element of the SAML assertion. Typical examples of * the format are transient or persistent.

If * the format includes the prefix * urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. * For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is * returned as transient. If the format includes any other prefix, the * format is returned with no modifications.

*/ inline void SetSubjectType(const char* value) { m_subjectType.assign(value); } /** *

The format of the name ID, as defined by the Format attribute * in the NameID element of the SAML assertion. Typical examples of * the format are transient or persistent.

If * the format includes the prefix * urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. * For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is * returned as transient. If the format includes any other prefix, the * format is returned with no modifications.

*/ inline AssumeRoleWithSAMLResult& WithSubjectType(const Aws::String& value) { SetSubjectType(value); return *this;} /** *

The format of the name ID, as defined by the Format attribute * in the NameID element of the SAML assertion. Typical examples of * the format are transient or persistent.

If * the format includes the prefix * urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. * For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is * returned as transient. If the format includes any other prefix, the * format is returned with no modifications.

*/ inline AssumeRoleWithSAMLResult& WithSubjectType(Aws::String&& value) { SetSubjectType(std::move(value)); return *this;} /** *

The format of the name ID, as defined by the Format attribute * in the NameID element of the SAML assertion. Typical examples of * the format are transient or persistent.

If * the format includes the prefix * urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. * For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is * returned as transient. If the format includes any other prefix, the * format is returned with no modifications.

*/ inline AssumeRoleWithSAMLResult& WithSubjectType(const char* value) { SetSubjectType(value); return *this;} /** *

The value of the Issuer element of the SAML assertion.

*/ inline const Aws::String& GetIssuer() const{ return m_issuer; } /** *

The value of the Issuer element of the SAML assertion.

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

The value of the Issuer element of the SAML assertion.

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

The value of the Issuer element of the SAML assertion.

*/ inline void SetIssuer(const char* value) { m_issuer.assign(value); } /** *

The value of the Issuer element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithIssuer(const Aws::String& value) { SetIssuer(value); return *this;} /** *

The value of the Issuer element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithIssuer(Aws::String&& value) { SetIssuer(std::move(value)); return *this;} /** *

The value of the Issuer element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithIssuer(const char* value) { SetIssuer(value); return *this;} /** *

The value of the Recipient attribute of the * SubjectConfirmationData element of the SAML assertion.

*/ inline const Aws::String& GetAudience() const{ return m_audience; } /** *

The value of the Recipient attribute of the * SubjectConfirmationData element of the SAML assertion.

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

The value of the Recipient attribute of the * SubjectConfirmationData element of the SAML assertion.

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

The value of the Recipient attribute of the * SubjectConfirmationData element of the SAML assertion.

*/ inline void SetAudience(const char* value) { m_audience.assign(value); } /** *

The value of the Recipient attribute of the * SubjectConfirmationData element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithAudience(const Aws::String& value) { SetAudience(value); return *this;} /** *

The value of the Recipient attribute of the * SubjectConfirmationData element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithAudience(Aws::String&& value) { SetAudience(std::move(value)); return *this;} /** *

The value of the Recipient attribute of the * SubjectConfirmationData element of the SAML assertion.

*/ inline AssumeRoleWithSAMLResult& WithAudience(const char* value) { SetAudience(value); return *this;} /** *

A hash value based on the concatenation of the Issuer response * value, the AWS account ID, and the friendly name (the last part of the ARN) of * the SAML provider in IAM. The combination of NameQualifier and * Subject can be used to uniquely identify a federated user.

*

The following pseudocode shows how the hash value is calculated:

* BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" * ) )

*/ inline const Aws::String& GetNameQualifier() const{ return m_nameQualifier; } /** *

A hash value based on the concatenation of the Issuer response * value, the AWS account ID, and the friendly name (the last part of the ARN) of * the SAML provider in IAM. The combination of NameQualifier and * Subject can be used to uniquely identify a federated user.

*

The following pseudocode shows how the hash value is calculated:

* BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" * ) )

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

A hash value based on the concatenation of the Issuer response * value, the AWS account ID, and the friendly name (the last part of the ARN) of * the SAML provider in IAM. The combination of NameQualifier and * Subject can be used to uniquely identify a federated user.

*

The following pseudocode shows how the hash value is calculated:

* BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" * ) )

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

A hash value based on the concatenation of the Issuer response * value, the AWS account ID, and the friendly name (the last part of the ARN) of * the SAML provider in IAM. The combination of NameQualifier and * Subject can be used to uniquely identify a federated user.

*

The following pseudocode shows how the hash value is calculated:

* BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" * ) )

*/ inline void SetNameQualifier(const char* value) { m_nameQualifier.assign(value); } /** *

A hash value based on the concatenation of the Issuer response * value, the AWS account ID, and the friendly name (the last part of the ARN) of * the SAML provider in IAM. The combination of NameQualifier and * Subject can be used to uniquely identify a federated user.

*

The following pseudocode shows how the hash value is calculated:

* BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" * ) )

*/ inline AssumeRoleWithSAMLResult& WithNameQualifier(const Aws::String& value) { SetNameQualifier(value); return *this;} /** *

A hash value based on the concatenation of the Issuer response * value, the AWS account ID, and the friendly name (the last part of the ARN) of * the SAML provider in IAM. The combination of NameQualifier and * Subject can be used to uniquely identify a federated user.

*

The following pseudocode shows how the hash value is calculated:

* BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" * ) )

*/ inline AssumeRoleWithSAMLResult& WithNameQualifier(Aws::String&& value) { SetNameQualifier(std::move(value)); return *this;} /** *

A hash value based on the concatenation of the Issuer response * value, the AWS account ID, and the friendly name (the last part of the ARN) of * the SAML provider in IAM. The combination of NameQualifier and * Subject can be used to uniquely identify a federated user.

*

The following pseudocode shows how the hash value is calculated:

* BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" * ) )

*/ inline AssumeRoleWithSAMLResult& WithNameQualifier(const char* value) { SetNameQualifier(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 AssumeRoleWithSAMLResult& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;} inline AssumeRoleWithSAMLResult& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;} private: Credentials m_credentials; AssumedRoleUser m_assumedRoleUser; int m_packedPolicySize; Aws::String m_subject; Aws::String m_subjectType; Aws::String m_issuer; Aws::String m_audience; Aws::String m_nameQualifier; ResponseMetadata m_responseMetadata; }; } // namespace Model } // namespace STS } // namespace Aws