Class: Ansible::Ruby::Modules::Sts_assume_role

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/sts_assume_role.rb

Overview

Assume a role using AWS Security Token Service and obtain temporary credentials

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#duration_seconds ⇒ Object?

Returns The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 43200 seconds (12 hours). The max dependis on the IAM role’s sessions duration setting. By default, the value is set to 3600 seconds.s.

Returns:

  • (Object, nil) —

    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 43200 seconds (12 hours). The max dependis on the IAM role’s sessions duration setting. By default, the value is set to 3600 seconds.s



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sts_assume_role.rb', line 23

attribute :duration_seconds

#external_id ⇒ Object?

Returns A unique identifier that is used by third parties to assume a role in their customers’ accounts.

Returns:

  • (Object, nil) —

    A unique identifier that is used by third parties to assume a role in their customers’ accounts.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sts_assume_role.rb', line 26

attribute :external_id

#mfa_serial_number ⇒ Object?

Returns The identification number of the MFA device that is associated with the user who is making the AssumeRole call.

Returns:

  • (Object, nil) —

    The identification number of the MFA device that is associated with the user who is making the AssumeRole call.



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sts_assume_role.rb', line 29

attribute :mfa_serial_number

#mfa_token ⇒ Object?

Returns The value provided by the MFA device, if the trust policy of the role being assumed requires MFA.

Returns:

  • (Object, nil) —

    The value provided by the MFA device, if the trust policy of the role being assumed requires MFA.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sts_assume_role.rb', line 32

attribute :mfa_token

#policy ⇒ Object?

Returns Supplemental policy to use in addition to assumed role’s policies.

Returns:

  • (Object, nil) —

    Supplemental policy to use in addition to assumed role’s policies.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sts_assume_role.rb', line 20

attribute :policy

#role_arn ⇒ Object

Returns The Amazon Resource Name (ARN) of the role that the caller is assuming (docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs).

Returns:



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sts_assume_role.rb', line 12

attribute :role_arn

#role_session_name ⇒ Object

Returns Name of the role’s session - will be used by CloudTrail.

Returns:

  • (Object) —

    Name of the role’s session - will be used by CloudTrail



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sts_assume_role.rb', line 16

attribute :role_session_name