Class: Aws::AccountAccessRuntime::Types::GetRoleCredentialsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-accountaccessruntime/lib/aws-sdk-accountaccessruntime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_type ⇒ String

The type of access to request for the role. Specify PROGRAMMATIC_ACCESS to receive access key credentials for use with the CLI or an Amazon Web Services SDK.

Returns:

  • (String) 


112
113
114
115
116
117
118
119
120
 
# File 'gems/aws-sdk-accountaccessruntime/lib/aws-sdk-accountaccessruntime/types.rb', line 112

class GetRoleCredentialsRequest < Struct.new(
  :tenant_id,
  :role_arn,
  :access_type,
  :session_name,
  :session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the role to retrieve credentials for. You must be entitled to assume this role.

Returns:

  • (String) 


112
113
114
115
116
117
118
119
120
 
# File 'gems/aws-sdk-accountaccessruntime/lib/aws-sdk-accountaccessruntime/types.rb', line 112

class GetRoleCredentialsRequest < Struct.new(
  :tenant_id,
  :role_arn,
  :access_type,
  :session_name,
  :session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#session_duration ⇒ Integer

The duration, in seconds, that the returned credentials remain valid. If you don't specify a value, the service uses the default session duration. The maximum value can't exceed the maximum session duration configured for the role.

Returns:

  • (Integer) 


112
113
114
115
116
117
118
119
120
 
# File 'gems/aws-sdk-accountaccessruntime/lib/aws-sdk-accountaccessruntime/types.rb', line 112

class GetRoleCredentialsRequest < Struct.new(
  :tenant_id,
  :role_arn,
  :access_type,
  :session_name,
  :session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#session_name ⇒ String

An optional name for the role session. The name can be 2 to 64 characters and can contain alphanumeric characters and the following symbols: plus (+), equal (=), comma (,), period (.), at (@), and hyphen (-). The session name appears in CloudTrail logs for the assumed role session.

Returns:

  • (String) 


112
113
114
115
116
117
118
119
120
 
# File 'gems/aws-sdk-accountaccessruntime/lib/aws-sdk-accountaccessruntime/types.rb', line 112

class GetRoleCredentialsRequest < Struct.new(
  :tenant_id,
  :role_arn,
  :access_type,
  :session_name,
  :session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#tenant_id ⇒ String

The identifier of the tenant that the request applies to. A tenant ID begins with aa- and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.

Returns:

  • (String) 


112
113
114
115
116
117
118
119
120
 
# File 'gems/aws-sdk-accountaccessruntime/lib/aws-sdk-accountaccessruntime/types.rb', line 112

class GetRoleCredentialsRequest < Struct.new(
  :tenant_id,
  :role_arn,
  :access_type,
  :session_name,
  :session_duration)
  SENSITIVE = []
  include Aws::Structure
end