Class: Ansible::Ruby::Modules::Iam_cert

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

Overview

Allows for the management of server certificates

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#aws_access_key ⇒ Object?

Returns AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.



48
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam_cert.rb', line 48

attribute :aws_access_key

#aws_secret_key ⇒ Object?

Returns AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.



45
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam_cert.rb', line 45

attribute :aws_secret_key

#cert ⇒ String?

Returns The path to the certificate body in PEM encoded format.

Returns:

  • (String, nil) —

    The path to the certificate body in PEM encoded format.



33
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam_cert.rb', line 33

attribute :cert

#cert_chain ⇒ String?

Returns The path to the CA certificate chain in PEM encoded format.

Returns:

  • (String, nil) —

    The path to the CA certificate chain in PEM encoded format.



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

attribute :cert_chain

#dup_ok ⇒ Boolean?

Returns By default the module will not upload a certificate that is already uploaded into AWS. If set to True, it will upload the certificate as long as the name is unique.

Returns:

  • (Boolean, nil) —

    By default the module will not upload a certificate that is already uploaded into AWS. If set to True, it will upload the certificate as long as the name is unique.



41
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam_cert.rb', line 41

attribute :dup_ok

#key ⇒ String?

Returns The path to the private key of the certificate in PEM encoded format.

Returns:

  • (String, nil) —

    The path to the private key of the certificate in PEM encoded format.



37
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam_cert.rb', line 37

attribute :key

#name ⇒ String

Returns Name of certificate to add, update or remove.

Returns:

  • (String) —

    Name of certificate to add, update or remove.



11
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam_cert.rb', line 11

attribute :name

#new_name ⇒ Object?

Returns When present, this will update the name of the cert with the value passed here.

Returns:

  • (Object, nil) —

    When present, this will update the name of the cert with the value passed here.



15
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam_cert.rb', line 15

attribute :new_name

#new_path ⇒ Object?

Returns When present, this will update the path of the cert with the value passed here.

Returns:

  • (Object, nil) —

    When present, this will update the path of the cert with the value passed here.



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

attribute :new_path

#path ⇒ String?

Returns When creating or updating, specify the desired path of the certificate.

Returns:

  • (String, nil) —

    When creating or updating, specify the desired path of the certificate



25
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam_cert.rb', line 25

attribute :path

#state ⇒ :present, :absent

Returns Whether to create, delete certificate. When present is specified it will attempt to make an update if new_path or new_name is specified.

Returns:

  • (:present, :absent) —

    Whether to create, delete certificate. When present is specified it will attempt to make an update if new_path or new_name is specified.



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

attribute :state