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

Class AssumeRootRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sts.model.StsRequest

software.amazon.awssdk.services.sts.model.AssumeRootRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssumeRootRequest.Builder,AssumeRootRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AssumeRootRequest
extends StsRequest
implements ToCopyableBuilder<AssumeRootRequest.Builder,AssumeRootRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssumeRootRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AssumeRootRequest.Builder	builder()
Integer	durationSeconds()	The duration, in seconds, of the privileged session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AssumeRootRequest.Builder>	serializableBuilderClass()
String	targetPrincipal()	The member account principal ARN or account ID.
PolicyDescriptorType	taskPolicyArn()	The identity based policy that scopes the session to the privileged tasks that can be performed.
AssumeRootRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

targetPrincipal

public final String targetPrincipal()

The member account principal ARN or account ID.

Returns:

The member account principal ARN or account ID.

taskPolicyArn

public final 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

Returns:

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

durationSeconds

public final 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.

Returns:

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.

toBuilder

public AssumeRootRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssumeRootRequest.Builder,AssumeRootRequest>

Specified by:

toBuilder in class StsRequest

builder

public static AssumeRootRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssumeRootRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo