Package com.amazonaws.services.securitytoken.model

Class AssumeRoleWithSAMLRequest

    • Constructor Detail

      • AssumeRoleWithSAMLRequest

        public AssumeRoleWithSAMLRequest()

    • Method Detail

      • setRoleArn

        public void setRoleArn​(String roleArn)

        The Amazon Resource Name (ARN) of the role that the caller is assuming.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of the role that the caller is assuming.

      • getRoleArn

        public String getRoleArn()

        The Amazon Resource Name (ARN) of the role that the caller is assuming.

        Returns:
        The Amazon Resource Name (ARN) of the role that the caller is assuming.

      • withRoleArn

        public AssumeRoleWithSAMLRequest withRoleArn​(String roleArn)

        The Amazon Resource Name (ARN) of the role that the caller is assuming.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of the role that the caller is assuming.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setPrincipalArn

        public void setPrincipalArn​(String principalArn)

        The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

        Parameters:
        principalArn - The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

      • getPrincipalArn

        public String getPrincipalArn()

        The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

        Returns:
        The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

      • withPrincipalArn

        public AssumeRoleWithSAMLRequest withPrincipalArn​(String principalArn)

        The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

        Parameters:
        principalArn - The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setPolicy

        public void setPolicy​(String policy)

        An IAM policy in JSON format.

        The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

        The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

        The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

        Parameters:
        policy - An IAM policy in JSON format.

        The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

        The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

        The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

      • getPolicy

        public String getPolicy()

        An IAM policy in JSON format.

        The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

        The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

        The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

        Returns:
        An IAM policy in JSON format.

        The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

        The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

        The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

      • withPolicy

        public AssumeRoleWithSAMLRequest withPolicy​(String policy)

        An IAM policy in JSON format.

        The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

        The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

        The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

        Parameters:
        policy - An IAM policy in JSON format.

        The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

        The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

        The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

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

      • setDurationSeconds

        public void setDurationSeconds​(Integer durationSeconds)

        The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.

        The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

        Parameters:
        durationSeconds - The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.

        The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

      • getDurationSeconds

        public Integer getDurationSeconds()

        The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.

        The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

        Returns:
        The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.

        The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

      • withDurationSeconds

        public AssumeRoleWithSAMLRequest withDurationSeconds​(Integer durationSeconds)

        The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.

        The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

        Parameters:
        durationSeconds - The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.

        The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

        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:
        Object.toString()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object