Class AssumeRoleWithSAMLResult

java.lang.Object
com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLResult
All Implemented Interfaces:
Serializable, Cloneable

public class AssumeRoleWithSAMLResult extends Object implements 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 Details

    • AssumeRoleWithSAMLResult

      public AssumeRoleWithSAMLResult()
  • Method Details

    • setCredentials

      public void setCredentials(Credentials 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.

      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

      public Credentials 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

      public AssumeRoleWithSAMLResult withCredentials(Credentials 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.

      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

      public void setAssumedRoleUser(AssumedRoleUser assumedRoleUser)

      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

      public AssumedRoleUser 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

      public AssumeRoleWithSAMLResult withAssumedRoleUser(AssumedRoleUser assumedRoleUser)

      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

      public void setPackedPolicySize(Integer 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.

      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

      public Integer 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

      public AssumeRoleWithSAMLResult withPackedPolicySize(Integer 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.

      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

      public void setSubject(String subject)

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

      Parameters:
      subject - The value of the NameID element in the Subject element of the SAML assertion.
    • getSubject

      public String getSubject()

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

      Returns:
      The value of the NameID element in the Subject element of the SAML assertion.
    • withSubject

      public AssumeRoleWithSAMLResult withSubject(String subject)

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

      Parameters:
      subject - The value of the NameID element in the Subject element of the SAML assertion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSubjectType

      public void setSubjectType(String 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.

      Parameters:
      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.

    • getSubjectType

      public String getSubjectType()

      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.

      Returns:
      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.

    • withSubjectType

      public AssumeRoleWithSAMLResult withSubjectType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setIssuer

      public void setIssuer(String issuer)

      The value of the Issuer element of the SAML assertion.

      Parameters:
      issuer - The value of the Issuer element of the SAML assertion.
    • getIssuer

      public String getIssuer()

      The value of the Issuer element of the SAML assertion.

      Returns:
      The value of the Issuer element of the SAML assertion.
    • withIssuer

      public AssumeRoleWithSAMLResult withIssuer(String issuer)

      The value of the Issuer element of the SAML assertion.

      Parameters:
      issuer - The value of the Issuer element of the SAML assertion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAudience

      public void setAudience(String audience)

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

      Parameters:
      audience - The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
    • getAudience

      public String getAudience()

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

      Returns:
      The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
    • withAudience

      public AssumeRoleWithSAMLResult withAudience(String audience)

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

      Parameters:
      audience - The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNameQualifier

      public void setNameQualifier(String 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" ) )

      Parameters:
      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" ) )

    • getNameQualifier

      public String 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 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" ) )

      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 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" ) )

    • withNameQualifier

      public AssumeRoleWithSAMLResult withNameQualifier(String 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" ) )

      Parameters:
      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" ) )

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public AssumeRoleWithSAMLResult clone()
      Overrides:
      clone in class Object