@Generated(value="software.amazon.awssdk:codegen") public final class GetFederationTokenRequest extends StsRequest implements ToCopyableBuilder<GetFederationTokenRequest.Builder,GetFederationTokenRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetFederationTokenRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetFederationTokenRequest.Builder |
builder() |
Integer |
durationSeconds()
The duration, in seconds, that the session should last.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasPolicyArns()
For responses, this returns true if the service returned a value for the PolicyArns property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
name()
The name of the federated user.
|
String |
policy()
An IAM policy in JSON format that you want to use as an inline session policy.
|
List<PolicyDescriptorType> |
policyArns()
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetFederationTokenRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of session tags.
|
GetFederationTokenRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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: =,.@-
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: =,.@-
public final 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.
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 resulting credentials can be used to access a resource that has a resource-based policy. If that policy
specifically references the federated user session in the Principal
element of the policy, the
session has the permissions allowed by the policy. These permissions are granted in addition to the permissions
that are granted by the session policies.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 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.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary
format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other
requirements. The PackedPolicySize
response element indicates by percentage how close the policies
and tags for your request are to the upper size limit.
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.
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 resulting credentials can be used to access a resource that has a resource-based policy. If that
policy specifically references the federated user session in the Principal
element of the
policy, the session has the permissions allowed by the policy. These permissions are granted in addition
to the permissions that are granted by the session policies.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 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.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed
binary format that has a separate limit. Your request can fail for this limit even if your plaintext
meets the other requirements. The PackedPolicySize
response element indicates by percentage
how close the policies and tags for your request are to the upper size limit.
public final boolean hasPolicyArns()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<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 plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.
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 resulting credentials can be used to access a resource that has a resource-based policy. If that policy
specifically references the federated user session in the Principal
element of the policy, the
session has the permissions allowed by the policy. These permissions are granted in addition to the permissions
that are granted by the session policies.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary
format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other
requirements. The PackedPolicySize
response element indicates by percentage how close the policies
and tags for your request are to the upper size limit.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasPolicyArns()
method.
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 plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.
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 resulting credentials can be used to access a resource that has a resource-based policy. If that
policy specifically references the federated user session in the Principal
element of the
policy, the session has the permissions allowed by the policy. These permissions are granted in addition
to the permissions that are granted by the session policies.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed
binary format that has a separate limit. Your request can fail for this limit even if your plaintext
meets the other requirements. The PackedPolicySize
response element indicates by percentage
how close the policies and tags for your request are to the upper size limit.
public final 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 Amazon Web Services 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.
public final boolean hasTags()
isEmpty()
method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
A list of session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary
format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other
requirements. The PackedPolicySize
response element indicates by percentage how close the policies
and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the user you are federating. When you do, session tags override a user tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate
Department
and department
tag keys. Assume that the role has the
Department
=Marketing
tag and you pass the department
=
engineering
session tag. Department
and department
are not saved as
separate tags, and the session tag passed in the request takes precedence over the role tag.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags()
method.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed session policies and session tags into a packed
binary format that has a separate limit. Your request can fail for this limit even if your plaintext
meets the other requirements. The PackedPolicySize
response element indicates by percentage
how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the user you are federating. When you do, session tags override a user tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have
separate Department
and department
tag keys. Assume that the role has the
Department
=Marketing
tag and you pass the department
=
engineering
session tag. Department
and department
are not saved
as separate tags, and the session tag passed in the request takes precedence over the role tag.
public GetFederationTokenRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetFederationTokenRequest.Builder,GetFederationTokenRequest>
toBuilder
in class StsRequest
public static GetFederationTokenRequest.Builder builder()
public static Class<? extends GetFederationTokenRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.