public class GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
GetFederationTokenRequest()
Default constructor for GetFederationTokenRequest object.
|
GetFederationTokenRequest(String name)
Constructs a new GetFederationTokenRequest object.
|
| Modifier and Type | Method and 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 the
GetFederationToken call and evaluated along with the policy
or policies that are attached to the IAM user whose credentials are used
to call GetFederationToken. |
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 the
GetFederationToken call and evaluated along with the policy
or policies that are attached to the IAM user whose credentials are used
to call GetFederationToken. |
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 the
GetFederationToken call and evaluated along with the policy
or policies that are attached to the IAM user whose credentials are used
to call GetFederationToken. |
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic GetFederationTokenRequest()
public GetFederationTokenRequest(String name)
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: =,.@-
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: =,.@-
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: =,.@-
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: =,.@-
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: =,.@-
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: =,.@-
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: =,.@-
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 call GetFederationToken. 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.
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 call GetFederationToken. 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.
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 call GetFederationToken. 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.
GetFederationToken call and evaluated along with the
policy or policies that are attached to the IAM user whose
credentials are used to call GetFederationToken. 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.
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 call GetFederationToken. 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.
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 call GetFederationToken. 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.
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.
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.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.
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.
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.public String toString()
toString in class ObjectObject.toString()public GetFederationTokenRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.