Class AssumeRoleWithSAMLRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class AssumeRoleWithSAMLRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description AssumeRoleWithSAMLRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssumeRoleWithSAMLRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Integer
getDurationSeconds()
The duration, in seconds, of the role session.String
getPolicy()
An IAM policy in JSON format.String
getPrincipalArn()
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.String
getRoleArn()
The Amazon Resource Name (ARN) of the role that the caller is assuming.String
getSAMLAssertion()
The base-64 encoded SAML authentication response provided by the IdP.int
hashCode()
void
setDurationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session.void
setPolicy(String policy)
An IAM policy in JSON format.void
setPrincipalArn(String principalArn)
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.void
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role that the caller is assuming.void
setSAMLAssertion(String sAMLAssertion)
The base-64 encoded SAML authentication response provided by the IdP.String
toString()
Returns a string representation of this object; useful for testing and debugging.AssumeRoleWithSAMLRequest
withDurationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session.AssumeRoleWithSAMLRequest
withPolicy(String policy)
An IAM policy in JSON format.AssumeRoleWithSAMLRequest
withPrincipalArn(String principalArn)
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.AssumeRoleWithSAMLRequest
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role that the caller is assuming.AssumeRoleWithSAMLRequest
withSAMLAssertion(String sAMLAssertion)
The base-64 encoded SAML authentication response provided by the IdP.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
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.
-
setSAMLAssertion
public void setSAMLAssertion(String sAMLAssertion)
The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
- Parameters:
sAMLAssertion
- The base-64 encoded SAML authentication response provided by the IdP.For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
-
getSAMLAssertion
public String getSAMLAssertion()
The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
- Returns:
- The base-64 encoded SAML authentication response provided by the
IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
-
withSAMLAssertion
public AssumeRoleWithSAMLRequest withSAMLAssertion(String sAMLAssertion)
The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
- Parameters:
sAMLAssertion
- The base-64 encoded SAML authentication response provided by the IdP.For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
- 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'sSessionNotOnOrAfter
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'sSessionNotOnOrAfter
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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public AssumeRoleWithSAMLRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-