Class AssumeRoleWithSAMLResult
- All Implemented Interfaces:
Serializable
,Cloneable
Contains the response to a successful AssumeRoleWithSAML request, including temporary AWS credentials that can be used to make AWS requests.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The identifiers for the temporary security credentials that the operation returns.The value of theRecipient
attribute of theSubjectConfirmationData
element of the SAML assertion.The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.The value of theIssuer
element of the SAML assertion.A hash value based on the concatenation of theIssuer
response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM.A percentage value that indicates the size of the policy in packed form.The value of theNameID
element in theSubject
element of the SAML assertion.The format of the name ID, as defined by theFormat
attribute in theNameID
element of the SAML assertion.int
hashCode()
void
setAssumedRoleUser
(AssumedRoleUser assumedRoleUser) The identifiers for the temporary security credentials that the operation returns.void
setAudience
(String audience) The value of theRecipient
attribute of theSubjectConfirmationData
element of the SAML assertion.void
setCredentials
(Credentials credentials) The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.void
The value of theIssuer
element of the SAML assertion.void
setNameQualifier
(String nameQualifier) A hash value based on the concatenation of theIssuer
response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM.void
setPackedPolicySize
(Integer packedPolicySize) A percentage value that indicates the size of the policy in packed form.void
setSubject
(String subject) The value of theNameID
element in theSubject
element of the SAML assertion.void
setSubjectType
(String subjectType) The format of the name ID, as defined by theFormat
attribute in theNameID
element of the SAML assertion.toString()
Returns a string representation of this object; useful for testing and debugging.withAssumedRoleUser
(AssumedRoleUser assumedRoleUser) The identifiers for the temporary security credentials that the operation returns.withAudience
(String audience) The value of theRecipient
attribute of theSubjectConfirmationData
element of the SAML assertion.withCredentials
(Credentials credentials) The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.withIssuer
(String issuer) The value of theIssuer
element of the SAML assertion.withNameQualifier
(String nameQualifier) A hash value based on the concatenation of theIssuer
response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM.withPackedPolicySize
(Integer packedPolicySize) A percentage value that indicates the size of the policy in packed form.withSubject
(String subject) The value of theNameID
element in theSubject
element of the SAML assertion.withSubjectType
(String subjectType) The format of the name ID, as defined by theFormat
attribute in theNameID
element of the SAML assertion.
-
Constructor Details
-
AssumeRoleWithSAMLResult
public AssumeRoleWithSAMLResult()
-
-
Method Details
-
setCredentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Parameters:
credentials
- The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
-
getCredentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Returns:
- The temporary security credentials, which include an access key
ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
-
withCredentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Parameters:
credentials
- The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAssumedRoleUser
The identifiers for the temporary security credentials that the operation returns.
- Parameters:
assumedRoleUser
- The identifiers for the temporary security credentials that the operation returns.
-
getAssumedRoleUser
The identifiers for the temporary security credentials that the operation returns.
- Returns:
- The identifiers for the temporary security credentials that the operation returns.
-
withAssumedRoleUser
The identifiers for the temporary security credentials that the operation returns.
- Parameters:
assumedRoleUser
- The identifiers for the temporary security credentials that the operation returns.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPackedPolicySize
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Parameters:
packedPolicySize
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
-
getPackedPolicySize
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Returns:
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
-
withPackedPolicySize
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Parameters:
packedPolicySize
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSubject
The value of the
NameID
element in theSubject
element of the SAML assertion.- Parameters:
subject
- The value of theNameID
element in theSubject
element of the SAML assertion.
-
getSubject
The value of the
NameID
element in theSubject
element of the SAML assertion.- Returns:
- The value of the
NameID
element in theSubject
element of the SAML assertion.
-
withSubject
The value of the
NameID
element in theSubject
element of the SAML assertion.- Parameters:
subject
- The value of theNameID
element in theSubject
element of the SAML assertion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSubjectType
The format of the name ID, as defined by the
Format
attribute in theNameID
element of the SAML assertion. Typical examples of the format aretransient
orpersistent
.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 astransient
. If the format includes any other prefix, the format is returned with no modifications.- Parameters:
subjectType
- The format of the name ID, as defined by theFormat
attribute in theNameID
element of the SAML assertion. Typical examples of the format aretransient
orpersistent
.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 astransient
. If the format includes any other prefix, the format is returned with no modifications.
-
getSubjectType
The format of the name ID, as defined by the
Format
attribute in theNameID
element of the SAML assertion. Typical examples of the format aretransient
orpersistent
.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 astransient
. If the format includes any other prefix, the format is returned with no modifications.- Returns:
- The format of the name ID, as defined by the
Format
attribute in theNameID
element of the SAML assertion. Typical examples of the format aretransient
orpersistent
.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 astransient
. If the format includes any other prefix, the format is returned with no modifications.
-
withSubjectType
The format of the name ID, as defined by the
Format
attribute in theNameID
element of the SAML assertion. Typical examples of the format aretransient
orpersistent
.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 astransient
. If the format includes any other prefix, the format is returned with no modifications.- Parameters:
subjectType
- The format of the name ID, as defined by theFormat
attribute in theNameID
element of the SAML assertion. Typical examples of the format aretransient
orpersistent
.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 astransient
. If the format includes any other prefix, the format is returned with no modifications.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIssuer
The value of the
Issuer
element of the SAML assertion.- Parameters:
issuer
- The value of theIssuer
element of the SAML assertion.
-
getIssuer
The value of the
Issuer
element of the SAML assertion.- Returns:
- The value of the
Issuer
element of the SAML assertion.
-
withIssuer
The value of the
Issuer
element of the SAML assertion.- Parameters:
issuer
- The value of theIssuer
element of the SAML assertion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAudience
The value of the
Recipient
attribute of theSubjectConfirmationData
element of the SAML assertion.- Parameters:
audience
- The value of theRecipient
attribute of theSubjectConfirmationData
element of the SAML assertion.
-
getAudience
The value of the
Recipient
attribute of theSubjectConfirmationData
element of the SAML assertion.- Returns:
- The value of the
Recipient
attribute of theSubjectConfirmationData
element of the SAML assertion.
-
withAudience
The value of the
Recipient
attribute of theSubjectConfirmationData
element of the SAML assertion.- Parameters:
audience
- The value of theRecipient
attribute of theSubjectConfirmationData
element of the SAML assertion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNameQualifier
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 ofNameQualifier
andSubject
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" ) )
- Parameters:
nameQualifier
- A hash value based on the concatenation of theIssuer
response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination ofNameQualifier
andSubject
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" ) )
-
getNameQualifier
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 ofNameQualifier
andSubject
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" ) )
- Returns:
- 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 ofNameQualifier
andSubject
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" ) )
-
withNameQualifier
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 ofNameQualifier
andSubject
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" ) )
- Parameters:
nameQualifier
- A hash value based on the concatenation of theIssuer
response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination ofNameQualifier
andSubject
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" ) )
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-