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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Sts_assume_role

Defined in:

lib/ansible/ruby/modules/generated/extras/cloud/amazon/sts_assume_role.rb

Instance Method Summary

• #duration_seconds ⇒ Object^?

  The duration, in seconds, of the role session.

• #external_id ⇒ Object^?

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

• #mfa_serial_number ⇒ Object^?

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

• #mfa_token ⇒ Object^?

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

• #policy ⇒ Object^?

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

• #role_arn ⇒ Object

  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).

• #role_session_name ⇒ Object

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

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #initialize, #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 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

Returns:

• (Object, nil) —

  The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

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

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.

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

attribute :external_id

#mfa_serial_number ⇒ Object^?

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

Returns:

• (Object, nil) —

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

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

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.

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

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.

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

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:

• (Object) —

  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)

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

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

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

attribute :role_session_name