Package software.amazon.awssdk.services.sts.model

Interface GetFederationTokenResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetFederationTokenResponse.Builder,GetFederationTokenResponse>, SdkBuilder<GetFederationTokenResponse.Builder,GetFederationTokenResponse>, SdkPojo, SdkResponse.Builder, StsResponse.Builder

Enclosing class:

GetFederationTokenResponse

public static interface GetFederationTokenResponse.Builder
extends StsResponse.Builder, SdkPojo, CopyableBuilder<GetFederationTokenResponse.Builder,GetFederationTokenResponse>

Method Summary

Modifier and Type	Method	Description
default GetFederationTokenResponse.Builder	credentials(Consumer<Credentials.Builder> credentials)	The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
GetFederationTokenResponse.Builder	credentials(Credentials credentials)	The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
default GetFederationTokenResponse.Builder	federatedUser(Consumer<FederatedUser.Builder> federatedUser)	Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob).
GetFederationTokenResponse.Builder	federatedUser(FederatedUser federatedUser)	Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob).
GetFederationTokenResponse.Builder	packedPolicySize(Integer packedPolicySize)	A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.sts.model.StsResponse.Builder

build, responseMetadata, responseMetadata

Method Detail

credentials

GetFederationTokenResponse.Builder credentials(Credentials credentials)

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

Parameters:

credentials - The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

Returns:

Returns a reference to this object so that method calls can be chained together.

credentials

default GetFederationTokenResponse.Builder credentials(Consumer<Credentials.Builder> credentials)

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

This is a convenience method that creates an instance of the Credentials.Builder avoiding the need to create one manually via Credentials.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to credentials(Credentials).

Parameters:

credentials - a consumer that will call methods on Credentials.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

credentials(Credentials)

federatedUser

GetFederationTokenResponse.Builder federatedUser(FederatedUser federatedUser)

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

Parameters:

federatedUser - Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

Returns:

Returns a reference to this object so that method calls can be chained together.

federatedUser

default GetFederationTokenResponse.Builder federatedUser(Consumer<FederatedUser.Builder> federatedUser)

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

This is a convenience method that creates an instance of the FederatedUser.Builder avoiding the need to create one manually via FederatedUser.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to federatedUser(FederatedUser).

Parameters:

federatedUser - a consumer that will call methods on FederatedUser.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

federatedUser(FederatedUser)

packedPolicySize

GetFederationTokenResponse.Builder packedPolicySize(Integer packedPolicySize)

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Parameters:

packedPolicySize - A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Returns:

Returns a reference to this object so that method calls can be chained together.