Class: Ansible::Ruby::Modules::Aws_kms

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

Overview

Manage role/user access to a KMS key. Not designed for encrypting/decrypting.

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

#clean_invalid_entries ⇒ Boolean?

Returns If adding/removing a role and invalid grantees are found, remove them. These entries will cause an update to fail in all known cases.,Only cleans if changes are being made.

Returns:

  • (Boolean, nil) —

    If adding/removing a role and invalid grantees are found, remove them. These entries will cause an update to fail in all known cases.,Only cleans if changes are being made.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_kms.rb', line 34

attribute :clean_invalid_entries

#grant_types ⇒ Array<String>, ...

Returns List of grants to give to user/role. Likely “role,role grant” or “role,role grant,admin”. Required when C(mode=grant).

Returns:

  • (Array<String>, String, nil) —

    List of grants to give to user/role. Likely “role,role grant” or “role,role grant,admin”. Required when C(mode=grant).



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

attribute :grant_types

#key_alias ⇒ String?

Returns Alias label to the key. One of C(key_alias) or C(key_arn) are required.

Returns:

  • (String, nil) —

    Alias label to the key. One of C(key_alias) or C(key_arn) are required.



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

attribute :key_alias

#key_arn ⇒ Object?

Returns Full ARN to the key. One of C(key_alias) or C(key_arn) are required.

Returns:

  • (Object, nil) —

    Full ARN to the key. One of C(key_alias) or C(key_arn) are required.



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

attribute :key_arn

#mode ⇒ :grant, :deny

Returns Grant or deny access.

Returns:

  • (:grant, :deny) —

    Grant or deny access.



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

attribute :mode

#role_arn ⇒ Object?

Returns ARN of role to allow/deny access. One of C(role_name) or C(role_arn) are required.

Returns:

  • (Object, nil) —

    ARN of role to allow/deny access. One of C(role_name) or C(role_arn) are required.



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

attribute :role_arn

#role_name ⇒ String?

Returns Role to allow/deny access. One of C(role_name) or C(role_arn) are required.

Returns:

  • (String, nil) —

    Role to allow/deny access. One of C(role_name) or C(role_arn) are required.



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

attribute :role_name