Interface AssumeRootRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<AssumeRootRequest.Builder,AssumeRootRequest>, SdkBuilder<AssumeRootRequest.Builder,AssumeRootRequest>, SdkPojo, SdkRequest.Builder, StsRequest.Builder

Enclosing class:

AssumeRootRequest

public static interface AssumeRootRequest.Builder
extends StsRequest.Builder, SdkPojo, CopyableBuilder<AssumeRootRequest.Builder,AssumeRootRequest>

Method Summary

Modifier and Type	Method	Description
AssumeRootRequest.Builder	durationSeconds(Integer durationSeconds)	The duration, in seconds, of the privileged session.
AssumeRootRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
AssumeRootRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
AssumeRootRequest.Builder	targetPrincipal(String targetPrincipal)	The member account principal ARN or account ID.
default AssumeRootRequest.Builder	taskPolicyArn(Consumer<PolicyDescriptorType.Builder> taskPolicyArn)	The identity based policy that scopes the session to the privileged tasks that can be performed.
AssumeRootRequest.Builder	taskPolicyArn(PolicyDescriptorType taskPolicyArn)	The identity based policy that scopes the session to the privileged tasks that can be performed.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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, sdkFieldNameToField, sdkFields

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

build

Method Details

targetPrincipal

AssumeRootRequest.Builder targetPrincipal(String targetPrincipal)

The member account principal ARN or account ID.

Parameters:

targetPrincipal - The member account principal ARN or account ID.

Returns:

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

taskPolicyArn

AssumeRootRequest.Builder taskPolicyArn(PolicyDescriptorType taskPolicyArn)

The identity based policy that scopes the session to the privileged tasks that can be performed. You can use one of following Amazon Web Services managed policies to scope root session actions.

• IAMAuditRootUserCredentials

• IAMCreateRootUserPassword

• IAMDeleteRootUserCredentials

• S3UnlockBucketPolicy

• SQSUnlockQueuePolicy

Parameters:

taskPolicyArn - The identity based policy that scopes the session to the privileged tasks that can be performed. You can use one of following Amazon Web Services managed policies to scope root session actions.

• IAMAuditRootUserCredentials

• IAMCreateRootUserPassword

• IAMDeleteRootUserCredentials

• S3UnlockBucketPolicy

• SQSUnlockQueuePolicy

Returns:

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

taskPolicyArn

default AssumeRootRequest.Builder taskPolicyArn(Consumer<PolicyDescriptorType.Builder> taskPolicyArn)

The identity based policy that scopes the session to the privileged tasks that can be performed. You can use one of following Amazon Web Services managed policies to scope root session actions.

• IAMAuditRootUserCredentials

• IAMCreateRootUserPassword

• IAMDeleteRootUserCredentials

• S3UnlockBucketPolicy

• SQSUnlockQueuePolicy

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

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

Parameters:

taskPolicyArn - a consumer that will call methods on PolicyDescriptorType.Builder

Returns:

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

See Also:

• taskPolicyArn(PolicyDescriptorType)

durationSeconds

AssumeRootRequest.Builder durationSeconds(Integer durationSeconds)

The duration, in seconds, of the privileged session. The value can range from 0 seconds up to the maximum session duration of 900 seconds (15 minutes). If you specify a value higher than this setting, the operation fails.

By default, the value is set to 900 seconds.

Parameters:

durationSeconds - The duration, in seconds, of the privileged session. The value can range from 0 seconds up to the maximum session duration of 900 seconds (15 minutes). If you specify a value higher than this setting, the operation fails.

By default, the value is set to 900 seconds.

Returns:

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

overrideConfiguration

AssumeRootRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

AssumeRootRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.