Class: Aws::STS::Types::AssumeRootRequest

Inherits:

Struct

• Object
• Struct
• Aws::STS::Types::AssumeRootRequest

Defined in:

gems/aws-sdk-core/lib/aws-sdk-sts/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #duration_seconds ⇒ Integer

  The duration, in seconds, of the privileged session.

• #minimum_session_token_size ⇒ Integer

  The minimum size, in bytes, of the session token that STS issues for the request.

• #target_principal ⇒ String

  The member account principal ARN or account ID.

• #task_policy_arn ⇒ Types::PolicyDescriptorType

  The identity based policy that scopes the session to the privileged tasks that can be performed.

Instance Attribute Details

#duration_seconds ⇒ Integer

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:

• (Integer)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1068

class AssumeRootRequest < Struct.new(
  :target_principal,
  :task_policy_arn,
  :duration_seconds,
  :minimum_session_token_size)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_session_token_size ⇒ Integer

The minimum size, in bytes, of the session token that STS issues for the request. STS increases the session token to at least this size, regardless of its actual content. The value must not exceed 4,096 bytes. When set to 0 or not specified, the session token size is unchanged.

Returns:

• (Integer)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1068

class AssumeRootRequest < Struct.new(
  :target_principal,
  :task_policy_arn,
  :duration_seconds,
  :minimum_session_token_size)
  SENSITIVE = []
  include Aws::Structure
end

#target_principal ⇒ String

The member account principal ARN or account ID.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1068

class AssumeRootRequest < Struct.new(
  :target_principal,
  :task_policy_arn,
  :duration_seconds,
  :minimum_session_token_size)
  SENSITIVE = []
  include Aws::Structure
end

#task_policy_arn ⇒ Types::PolicyDescriptorType

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

• IAMAuditRootUserCredentials

• IAMCreateRootUserPassword

• IAMDeleteRootUserCredentials

• S3UnlockBucketPolicy

• SQSUnlockQueuePolicy

Returns:

• (Types::PolicyDescriptorType)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1068

class AssumeRootRequest < Struct.new(
  :target_principal,
  :task_policy_arn,
  :duration_seconds,
  :minimum_session_token_size)
  SENSITIVE = []
  include Aws::Structure
end