Class AssumeRoleWithWebIdentityRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class AssumeRoleWithWebIdentityRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description AssumeRoleWithWebIdentityRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssumeRoleWithWebIdentityRequest
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
getProviderId()
The fully qualified host component of the domain name of the identity provider.String
getRoleArn()
The Amazon Resource Name (ARN) of the role that the caller is assuming.String
getRoleSessionName()
An identifier for the assumed role session.String
getWebIdentityToken()
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider.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
setProviderId(String providerId)
The fully qualified host component of the domain name of the identity provider.void
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role that the caller is assuming.void
setRoleSessionName(String roleSessionName)
An identifier for the assumed role session.void
setWebIdentityToken(String webIdentityToken)
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider.String
toString()
Returns a string representation of this object; useful for testing and debugging.AssumeRoleWithWebIdentityRequest
withDurationSeconds(Integer durationSeconds)
The duration, in seconds, of the role session.AssumeRoleWithWebIdentityRequest
withPolicy(String policy)
An IAM policy in JSON format.AssumeRoleWithWebIdentityRequest
withProviderId(String providerId)
The fully qualified host component of the domain name of the identity provider.AssumeRoleWithWebIdentityRequest
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role that the caller is assuming.AssumeRoleWithWebIdentityRequest
withRoleSessionName(String roleSessionName)
An identifier for the assumed role session.AssumeRoleWithWebIdentityRequest
withWebIdentityToken(String webIdentityToken)
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider.-
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 AssumeRoleWithWebIdentityRequest 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.
-
setRoleSessionName
public void setRoleSessionName(String roleSessionName)
An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the
AssumedRoleUser
response element.The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
- Parameters:
roleSessionName
- An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in theAssumedRoleUser
response element.The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
-
getRoleSessionName
public String getRoleSessionName()
An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the
AssumedRoleUser
response element.The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
- Returns:
- An identifier for the assumed role session. Typically, you pass
the name or identifier that is associated with the user who is
using your application. That way, the temporary security
credentials that your application will use are associated with
that user. This session name is included as part of the ARN and
assumed role ID in the
AssumedRoleUser
response element.The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
-
withRoleSessionName
public AssumeRoleWithWebIdentityRequest withRoleSessionName(String roleSessionName)
An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the
AssumedRoleUser
response element.The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
- Parameters:
roleSessionName
- An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in theAssumedRoleUser
response element.The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWebIdentityToken
public void setWebIdentityToken(String webIdentityToken)
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an
AssumeRoleWithWebIdentity
call.- Parameters:
webIdentityToken
- The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes anAssumeRoleWithWebIdentity
call.
-
getWebIdentityToken
public String getWebIdentityToken()
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an
AssumeRoleWithWebIdentity
call.- Returns:
- The OAuth 2.0 access token or OpenID Connect ID token that is
provided by the identity provider. Your application must get this
token by authenticating the user who is using your application
with a web identity provider before the application makes an
AssumeRoleWithWebIdentity
call.
-
withWebIdentityToken
public AssumeRoleWithWebIdentityRequest withWebIdentityToken(String webIdentityToken)
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an
AssumeRoleWithWebIdentity
call.- Parameters:
webIdentityToken
- The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes anAssumeRoleWithWebIdentity
call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setProviderId
public void setProviderId(String providerId)
The fully qualified host component of the domain name of the identity provider.
Specify this value only for OAuth 2.0 access tokens. Currently
www.amazon.com
andgraph.facebook.com
are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.Do not specify this value for OpenID Connect ID tokens.
- Parameters:
providerId
- The fully qualified host component of the domain name of the identity provider.Specify this value only for OAuth 2.0 access tokens. Currently
www.amazon.com
andgraph.facebook.com
are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.Do not specify this value for OpenID Connect ID tokens.
-
getProviderId
public String getProviderId()
The fully qualified host component of the domain name of the identity provider.
Specify this value only for OAuth 2.0 access tokens. Currently
www.amazon.com
andgraph.facebook.com
are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.Do not specify this value for OpenID Connect ID tokens.
- Returns:
- The fully qualified host component of the domain name of the
identity provider.
Specify this value only for OAuth 2.0 access tokens. Currently
www.amazon.com
andgraph.facebook.com
are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.Do not specify this value for OpenID Connect ID tokens.
-
withProviderId
public AssumeRoleWithWebIdentityRequest withProviderId(String providerId)
The fully qualified host component of the domain name of the identity provider.
Specify this value only for OAuth 2.0 access tokens. Currently
www.amazon.com
andgraph.facebook.com
are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.Do not specify this value for OpenID Connect ID tokens.
- Parameters:
providerId
- The fully qualified host component of the domain name of the identity provider.Specify this value only for OAuth 2.0 access tokens. Currently
www.amazon.com
andgraph.facebook.com
are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.Do not specify this value for OpenID Connect ID tokens.
- 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, see Permissions for 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, see Permissions for 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, see Permissions for 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, see Permissions for 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 AssumeRoleWithWebIdentityRequest 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, see Permissions for 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, see Permissions for 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.
- 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.
-
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.
- 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.
-
withDurationSeconds
public AssumeRoleWithWebIdentityRequest 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.
- 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.- 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 AssumeRoleWithWebIdentityRequest 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()
-
-