public static interface GetFederationTokenRequest.Builder extends StsRequest.Builder, SdkPojo, CopyableBuilder<GetFederationTokenRequest.Builder,GetFederationTokenRequest>
| Modifier and Type | Method and Description |
|---|---|
GetFederationTokenRequest.Builder |
durationSeconds(Integer durationSeconds)
The duration, in seconds, that the session should last.
|
GetFederationTokenRequest.Builder |
name(String name)
The name of the federated user.
|
GetFederationTokenRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GetFederationTokenRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
GetFederationTokenRequest.Builder |
policy(String policy)
An IAM policy in JSON format that you want to use as an inline session policy.
|
GetFederationTokenRequest.Builder |
policyArns(Collection<PolicyDescriptorType> policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session
policy.
|
GetFederationTokenRequest.Builder |
policyArns(Consumer<PolicyDescriptorType.Builder>... policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session
policy.
|
GetFederationTokenRequest.Builder |
policyArns(PolicyDescriptorType... policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session
policy.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGetFederationTokenRequest.Builder name(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 regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or 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 regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
GetFederationTokenRequest.Builder policy(String policy)
An IAM policy in JSON format that you want to use as an inline session policy.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated
user session has no permissions. The only exception is when the credentials are used to access a resource
that has a resource-based policy that specifically references the federated user session in the
Principal element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS
conversion compresses the session policies into a packed binary format that has a separate limit. This is the
enforced limit. The PackedPolicySize response element indicates by percentage how close the
policy is to the upper size limit.
policy - An IAM policy in JSON format that you want to use as an inline session policy.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.
This parameter is optional. However, if you do not pass any session policies, then the resulting
federated user session has no permissions. The only exception is when the credentials are used to
access a resource that has a resource-based policy that specifically references the federated user
session in the Principal element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
The characters in this parameter count towards the 2048 character session policy guideline. However,
an AWS conversion compresses the session policies into a packed binary format that has a separate
limit. This is the enforced limit. The PackedPolicySize response element indicates by
percentage how close the policy is to the upper size limit.
GetFederationTokenRequest.Builder policyArns(Collection<PolicyDescriptorType> policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated
user session has no permissions. The only exception is when the credentials are used to access a resource
that has a resource-based policy that specifically references the federated user session in the
Principal element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS
conversion compresses the session policies into a packed binary format that has a separate limit. This is the
enforced limit. The PackedPolicySize response element indicates by percentage how close the
policy is to the upper size limit.
policyArns - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session
policy. The policies must exist in the same account as the IAM user that is requesting federated
access.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting
federated user session has no permissions. The only exception is when the credentials are used to
access a resource that has a resource-based policy that specifically references the federated user
session in the Principal element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The characters in this parameter count towards the 2048 character session policy guideline. However,
an AWS conversion compresses the session policies into a packed binary format that has a separate
limit. This is the enforced limit. The PackedPolicySize response element indicates by
percentage how close the policy is to the upper size limit.
GetFederationTokenRequest.Builder policyArns(PolicyDescriptorType... policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated
user session has no permissions. The only exception is when the credentials are used to access a resource
that has a resource-based policy that specifically references the federated user session in the
Principal element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS
conversion compresses the session policies into a packed binary format that has a separate limit. This is the
enforced limit. The PackedPolicySize response element indicates by percentage how close the
policy is to the upper size limit.
policyArns - The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session
policy. The policies must exist in the same account as the IAM user that is requesting federated
access.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting
federated user session has no permissions. The only exception is when the credentials are used to
access a resource that has a resource-based policy that specifically references the federated user
session in the Principal element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The characters in this parameter count towards the 2048 character session policy guideline. However,
an AWS conversion compresses the session policies into a packed binary format that has a separate
limit. This is the enforced limit. The PackedPolicySize response element indicates by
percentage how close the policy is to the upper size limit.
GetFederationTokenRequest.Builder policyArns(Consumer<PolicyDescriptorType.Builder>... policyArns)
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated
user session has no permissions. The only exception is when the credentials are used to access a resource
that has a resource-based policy that specifically references the federated user session in the
Principal element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS
conversion compresses the session policies into a packed binary format that has a separate limit. This is the
enforced limit. The PackedPolicySize response element indicates by percentage how close the
policy is to the upper size limit.
List.Builder
avoiding the need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #policyArns(List) .policyArns - a consumer that will call methods on List.Builder #policyArns(List) GetFederationTokenRequest.Builder durationSeconds(Integer durationSeconds)
The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using AWS account root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user 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 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as
the default. Sessions obtained using AWS account root user credentials are restricted to a maximum of
3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by
using root user credentials defaults to one hour.GetFederationTokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGetFederationTokenRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2019. All rights reserved.