Class: Ansible::Ruby::Modules::Aws_ssm_parameter_store

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/aws_ssm_parameter_store.rb

Overview

Manage key-value pairs in aws parameter store.

Instance Method Summary

• #decryption ⇒ Boolean^?

  Work with SecureString type to get plain text secrets,Boolean.

• #description ⇒ String^?

  Parameter key desciption.

• #key_id ⇒ String^?

  Aws KMS key to decrypt the secrets.

• #name ⇒ String

  Parameter key name.

• #overwrite_value ⇒ :never, ...

  Option to overwrite an existing value if it already exists.,String.

• #region ⇒ Object^?

  Region.

• #state ⇒ :present, ...

  Creates or modifies an existing parameter,Deletes a parameter.

• #string_type ⇒ :String, ...

  Parameter String type.

• #value ⇒ String^?

  Parameter value.

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

#decryption ⇒ Boolean^?

Returns Work with SecureString type to get plain text secrets,Boolean.

Returns:

• (Boolean, nil) —

  Work with SecureString type to get plain text secrets,Boolean

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

attribute :decryption

#description ⇒ String^?

Returns parameter key desciption.

Returns:

• (String, nil) —

  parameter key desciption.

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

attribute :description

#key_id ⇒ String^?

Returns aws KMS key to decrypt the secrets.

Returns:

• (String, nil) —

  aws KMS key to decrypt the secrets.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ssm_parameter_store.rb', line 36

attribute :key_id

#name ⇒ String

Returns parameter key name.

Returns:

• (String) —

  parameter key name.

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

attribute :name

#overwrite_value ⇒ :never, ...

Returns Option to overwrite an existing value if it already exists.,String.

Returns:

• (:never, :changed, :always, nil) —

  Option to overwrite an existing value if it already exists.,String

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ssm_parameter_store.rb', line 40

attribute :overwrite_value

#region ⇒ Object^?

Returns region.

Returns:

• (Object, nil) —

  region.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ssm_parameter_store.rb', line 44

attribute :region

#state ⇒ :present, ...

Returns Creates or modifies an existing parameter,Deletes a parameter.

Returns:

• (:present, :absent, nil) —

  Creates or modifies an existing parameter,Deletes a parameter

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

attribute :state

#string_type ⇒ :String, ...

Returns Parameter String type.

Returns:

• (:String, :StringList, :SecureString, nil) —

  Parameter String type

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ssm_parameter_store.rb', line 28

attribute :string_type

#value ⇒ String^?

Returns Parameter value.

Returns:

• (String, nil) —

  Parameter value.

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

attribute :value