/**
* 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 AssumeRoleWithSAML 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 (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.
The value of the NameID
element in the Subject
* element of the SAML assertion.
The value of the NameID
element in the Subject
* element of the SAML assertion.
The value of the NameID
element in the Subject
* element of the SAML assertion.
The value of the NameID
element in the Subject
* element of the SAML assertion.
The value of the NameID
element in the Subject
* element of the SAML assertion.
The value of the NameID
element in the Subject
* element of the SAML assertion.
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.
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.
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.
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.
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.
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.
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.
The value of the Issuer
element of the SAML assertion.
The value of the Issuer
element of the SAML assertion.
The value of the Issuer
element of the SAML assertion.
The value of the Issuer
element of the SAML assertion.
The value of the Issuer
element of the SAML assertion.
The value of the Issuer
element of the SAML assertion.
The value of the Issuer
element of the SAML assertion.
The value of the Recipient
attribute of the
* SubjectConfirmationData
element of the SAML assertion.
The value of the Recipient
attribute of the
* SubjectConfirmationData
element of the SAML assertion.
The value of the Recipient
attribute of the
* SubjectConfirmationData
element of the SAML assertion.
The value of the Recipient
attribute of the
* SubjectConfirmationData
element of the SAML assertion.
The value of the Recipient
attribute of the
* SubjectConfirmationData
element of the SAML assertion.
The value of the Recipient
attribute of the
* SubjectConfirmationData
element of the SAML assertion.
The value of the Recipient
attribute of the
* SubjectConfirmationData
element of the SAML assertion.
A hash value based on the concatenation of the following:
The Issuer
response value.
The Amazon Web * Services account ID.
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 user.
The following pseudocode shows how the hash value is * calculated:
BASE64 ( SHA1 ( "https://example.com/saml" +
* "123456789012" + "/MySAMLIdP" ) )
A hash value based on the concatenation of the following:
The Issuer
response value.
The Amazon Web * Services account ID.
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 user.
The following pseudocode shows how the hash value is * calculated:
BASE64 ( SHA1 ( "https://example.com/saml" +
* "123456789012" + "/MySAMLIdP" ) )
A hash value based on the concatenation of the following:
The Issuer
response value.
The Amazon Web * Services account ID.
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 user.
The following pseudocode shows how the hash value is * calculated:
BASE64 ( SHA1 ( "https://example.com/saml" +
* "123456789012" + "/MySAMLIdP" ) )
A hash value based on the concatenation of the following:
The Issuer
response value.
The Amazon Web * Services account ID.
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 user.
The following pseudocode shows how the hash value is * calculated:
BASE64 ( SHA1 ( "https://example.com/saml" +
* "123456789012" + "/MySAMLIdP" ) )
A hash value based on the concatenation of the following:
The Issuer
response value.
The Amazon Web * Services account ID.
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 user.
The following pseudocode shows how the hash value is * calculated:
BASE64 ( SHA1 ( "https://example.com/saml" +
* "123456789012" + "/MySAMLIdP" ) )
A hash value based on the concatenation of the following:
The Issuer
response value.
The Amazon Web * Services account ID.
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 user.
The following pseudocode shows how the hash value is * calculated:
BASE64 ( SHA1 ( "https://example.com/saml" +
* "123456789012" + "/MySAMLIdP" ) )
A hash value based on the concatenation of the following:
The Issuer
response value.
The Amazon Web * Services account ID.
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 user.
The following pseudocode shows how the hash value is * calculated:
BASE64 ( SHA1 ( "https://example.com/saml" +
* "123456789012" + "/MySAMLIdP" ) )
The value in the SourceIdentity
attribute in the SAML assertion.
*
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 SAML identity provider to use an
* attribute associated with your users, like user name or email, as the source
* identity when calling AssumeRoleWithSAML
. You do this by adding an
* attribute to the SAML assertion. 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 in the SourceIdentity
attribute in the SAML assertion.
*
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 SAML identity provider to use an
* attribute associated with your users, like user name or email, as the source
* identity when calling AssumeRoleWithSAML
. You do this by adding an
* attribute to the SAML assertion. 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 in the SourceIdentity
attribute in the SAML assertion.
*
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 SAML identity provider to use an
* attribute associated with your users, like user name or email, as the source
* identity when calling AssumeRoleWithSAML
. You do this by adding an
* attribute to the SAML assertion. 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 in the SourceIdentity
attribute in the SAML assertion.
*
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 SAML identity provider to use an
* attribute associated with your users, like user name or email, as the source
* identity when calling AssumeRoleWithSAML
. You do this by adding an
* attribute to the SAML assertion. 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 in the SourceIdentity
attribute in the SAML assertion.
*
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 SAML identity provider to use an
* attribute associated with your users, like user name or email, as the source
* identity when calling AssumeRoleWithSAML
. You do this by adding an
* attribute to the SAML assertion. 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 AssumeRoleWithSAMLResult& WithSourceIdentity(const Aws::String& value) { SetSourceIdentity(value); return *this;} /** *The value in the SourceIdentity
attribute in the SAML assertion.
*
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 SAML identity provider to use an
* attribute associated with your users, like user name or email, as the source
* identity when calling AssumeRoleWithSAML
. You do this by adding an
* attribute to the SAML assertion. 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 AssumeRoleWithSAMLResult& WithSourceIdentity(Aws::String&& value) { SetSourceIdentity(std::move(value)); return *this;} /** *The value in the SourceIdentity
attribute in the SAML assertion.
*
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 SAML identity provider to use an
* attribute associated with your users, like user name or email, as the source
* identity when calling AssumeRoleWithSAML
. You do this by adding an
* attribute to the SAML assertion. 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 AssumeRoleWithSAMLResult& 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 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; Aws::String m_sourceIdentity; ResponseMetadata m_responseMetadata; }; } // namespace Model } // namespace STS } // namespace Aws