Class GetFederationTokenRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.securitytoken.model.GetFederationTokenRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description GetFederationTokenRequest()
Default constructor for GetFederationTokenRequest object.GetFederationTokenRequest(String name)
Constructs a new GetFederationTokenRequest object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetFederationTokenRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Integer
getDurationSeconds()
The duration, in seconds, that the session should last.String
getName()
The name of the federated user.String
getPolicy()
An IAM policy in JSON format that is passed with theGetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
.int
hashCode()
void
setDurationSeconds(Integer durationSeconds)
The duration, in seconds, that the session should last.void
setName(String name)
The name of the federated user.void
setPolicy(String policy)
An IAM policy in JSON format that is passed with theGetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
.String
toString()
Returns a string representation of this object; useful for testing and debugging.GetFederationTokenRequest
withDurationSeconds(Integer durationSeconds)
The duration, in seconds, that the session should last.GetFederationTokenRequest
withName(String name)
The name of the federated user.GetFederationTokenRequest
withPolicy(String policy)
An IAM policy in JSON format that is passed with theGetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
.-
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
-
-
-
-
Constructor Detail
-
GetFederationTokenRequest
public GetFederationTokenRequest()
Default constructor for GetFederationTokenRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
GetFederationTokenRequest
public GetFederationTokenRequest(String name)
Constructs a new GetFederationTokenRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
name
- The name of the federated user. The name is used as an identifier for the temporary security credentials (such asBob
). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.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: =,.@-
-
-
Method Detail
-
setName
public void setName(String name)
The name of the federated user. The name is used as an identifier for the temporary security credentials (such as
Bob
). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.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:
name
- The name of the federated user. The name is used as an identifier for the temporary security credentials (such asBob
). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.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: =,.@-
-
getName
public String getName()
The name of the federated user. The name is used as an identifier for the temporary security credentials (such as
Bob
). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.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:
- The name of the federated user. The name is used as an identifier
for the temporary security credentials (such as
Bob
). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.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: =,.@-
-
withName
public GetFederationTokenRequest withName(String name)
The name of the federated user. The name is used as an identifier for the temporary security credentials (such as
Bob
). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.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:
name
- The name of the federated user. The name is used as an identifier for the temporary security credentials (such asBob
). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.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.
-
setPolicy
public void setPolicy(String policy)
An IAM policy in JSON format that is passed with the
GetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
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.
For more information about how permissions work, see Permissions for GetFederationToken.
- Parameters:
policy
- An IAM policy in JSON format that is passed with theGetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
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.
For more information about how permissions work, see Permissions for GetFederationToken.
-
getPolicy
public String getPolicy()
An IAM policy in JSON format that is passed with the
GetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
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.
For more information about how permissions work, see Permissions for GetFederationToken.
- Returns:
- An IAM policy in JSON format that is passed with the
GetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
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.
For more information about how permissions work, see Permissions for GetFederationToken.
-
withPolicy
public GetFederationTokenRequest withPolicy(String policy)
An IAM policy in JSON format that is passed with the
GetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
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.
For more information about how permissions work, see Permissions for GetFederationToken.
- Parameters:
policy
- An IAM policy in JSON format that is passed with theGetFederationToken
call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to callGetFederationToken
. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
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.
For more information about how permissions work, see Permissions for GetFederationToken.
- 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, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.
- Parameters:
durationSeconds
- The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.
-
getDurationSeconds
public Integer getDurationSeconds()
The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.
- Returns:
- The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.
-
withDurationSeconds
public GetFederationTokenRequest withDurationSeconds(Integer durationSeconds)
The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.
- Parameters:
durationSeconds
- The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.- 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 GetFederationTokenRequest 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()
-
-