com.amazonaws.auth

Class STSAssumeRoleSessionCredentialsProvider.Builder

java.lang.Object

com.amazonaws.auth.STSAssumeRoleSessionCredentialsProvider.Builder

Enclosing class:

STSAssumeRoleSessionCredentialsProvider

public static final class STSAssumeRoleSessionCredentialsProvider.Builder
extends Object

Provides a builder pattern to avoid combinatorial explosion of the number of parameters that are passed to constructors. The builder introspects which parameters have been set and calls the appropriate constructor.

Constructor Summary

Constructors

Constructor and Description
Builder(String roleArn, String roleSessionName)

Method Summary

Modifier and Type	Method and Description
STSAssumeRoleSessionCredentialsProvider	build() Build the configured provider
STSAssumeRoleSessionCredentialsProvider.Builder	withClientConfiguration(ClientConfiguration clientConfiguration) Set the client configuration used to create the AWSSecurityTokenService
STSAssumeRoleSessionCredentialsProvider.Builder	withExternalId(String roleExternalId) Set the roleExternalId parameter that is used when retrieving session credentials under an assumed role.
STSAssumeRoleSessionCredentialsProvider.Builder	withLongLivedCredentials(AWSCredentials longLivedCredentials) Set credentials to use when retrieving session credentials This is not the recommended approach.
STSAssumeRoleSessionCredentialsProvider.Builder	withLongLivedCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider) Set credentials provider to use when retrieving session credentials
STSAssumeRoleSessionCredentialsProvider.Builder	withRoleSessionDurationSeconds(int roleSessionDurationSeconds) Set the roleSessionDurationSeconds that is used when creating a new assumed role session.
STSAssumeRoleSessionCredentialsProvider.Builder	withScopeDownPolicy(String scopeDownPolicy) An IAM policy in JSON format to scope down permissions granted from the assume role.
STSAssumeRoleSessionCredentialsProvider.Builder	withServiceEndpoint(String serviceEndpoint) Sets the AWS Security Token Service (STS) endpoint where session credentials are retrieved from.
STSAssumeRoleSessionCredentialsProvider.Builder	withStsClient(AWSSecurityTokenService sts) Sets a preconfigured STS client to use for the credentials provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(String roleArn,
               String roleSessionName)

Parameters:

roleArn - Required roleArn parameter used when starting a session

roleSessionName - Required roleSessionName parameter used when starting a session

Method Detail

withLongLivedCredentials

public STSAssumeRoleSessionCredentialsProvider.Builder withLongLivedCredentials(AWSCredentials longLivedCredentials)

Set credentials to use when retrieving session credentials This is not the recommended approach. Instead, consider using the CredentialsProvider field.

Parameters:

longLivedCredentials - Credentials used to generate sessions in the assumed role

Returns:

the builder itself for chained calls

withLongLivedCredentialsProvider

public STSAssumeRoleSessionCredentialsProvider.Builder withLongLivedCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider)

Set credentials provider to use when retrieving session credentials

Parameters:

longLivedCredentialsProvider - A credentials provider used to generate sessions in the assumed role

Returns:

the builder itself for chained calls

withClientConfiguration

public STSAssumeRoleSessionCredentialsProvider.Builder withClientConfiguration(ClientConfiguration clientConfiguration)

Set the client configuration used to create the AWSSecurityTokenService

Parameters:

clientConfiguration - ClientConfiguration for the AWSSecurityTokenService client

Returns:

the builder itself for chained calls

withExternalId

public STSAssumeRoleSessionCredentialsProvider.Builder withExternalId(String roleExternalId)

Set the roleExternalId parameter that is used when retrieving session credentials under an assumed role.

Parameters:

roleExternalId - An external id used in the service call used to retrieve session credentials

Returns:

the builder itself for chained calls

withRoleSessionDurationSeconds

public STSAssumeRoleSessionCredentialsProvider.Builder withRoleSessionDurationSeconds(int roleSessionDurationSeconds)

Set the roleSessionDurationSeconds that is used when creating a new assumed role session.

Parameters:

roleSessionDurationSeconds - The duration for which we want to have an assumed role session to be active.

Returns:

the itself for chained calls

withServiceEndpoint

public STSAssumeRoleSessionCredentialsProvider.Builder withServiceEndpoint(String serviceEndpoint)

Sets the AWS Security Token Service (STS) endpoint where session credentials are retrieved from.

The default AWS Security Token Service (STS) endpoint ("sts.amazonaws.com") works for all accounts that are not for China (Beijing) region or GovCloud. You only need to change the endpoint to "sts.cn-north-1.amazonaws.com.cn" when you are requesting session credentials for services in China(Beijing) region or "sts.us-gov-west-1.amazonaws.com" for GovCloud.

withScopeDownPolicy

public STSAssumeRoleSessionCredentialsProvider.Builder withScopeDownPolicy(String scopeDownPolicy)

An IAM policy in JSON format to scope down permissions granted from the assume role.

This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

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.

Parameters:

scopeDownPolicy - An IAM policy in JSON format.

This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

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.

Returns:

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

withStsClient

public STSAssumeRoleSessionCredentialsProvider.Builder withStsClient(AWSSecurityTokenService sts)

Sets a preconfigured STS client to use for the credentials provider. A custom client is mutually exclusive to any other client related settings (withClientConfiguration(ClientConfiguration), withLongLivedCredentials(AWSCredentials), withServiceEndpoint(String), etc).

Parameters:

sts - Custom STS client to use.

Returns:

This object for chained calls.

build

public STSAssumeRoleSessionCredentialsProvider build()

Build the configured provider

Returns:

the configured STSAssumeRoleSessionCredentialsProvider