Class: Ansible::Ruby::Modules::Efs

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

Overview

Module allows create, search and destroy Amazon EFS file systems

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

#encrypt ⇒ :yes, ...

Returns A boolean value that, if true, creates an encrypted file system. This can not be modfied after the file system is created.

Returns:

  • (:yes, :no, nil) —

    A boolean value that, if true, creates an encrypted file system. This can not be modfied after the file system is created.



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

attribute :encrypt

#id ⇒ Object?

Returns ID of Amazon EFS. Either name or ID required for delete.

Returns:

  • (Object, nil) —

    ID of Amazon EFS. Either name or ID required for delete.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/efs.rb', line 31

attribute :id

#kms_key_id ⇒ Object?

Returns The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. The key id can be Key ID, Key ID ARN, Key Alias or Key Alias ARN.

Returns:

  • (Object, nil) —

    The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. The key id can be Key ID, Key ID ARN, Key Alias or Key Alias ARN.



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

attribute :kms_key_id

#name ⇒ String?

Returns Creation Token of Amazon EFS file system. Required for create and update. Either name or ID required for delete.

Returns:

  • (String, nil) —

    Creation Token of Amazon EFS file system. Required for create and update. Either name or ID required for delete.



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

attribute :name

#performance_mode ⇒ :general_purpose, ...

Returns File system’s performance mode to use. Only takes effect during creation.

Returns:

  • (:general_purpose, :max_io, nil) —

    File system’s performance mode to use. Only takes effect during creation.



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

attribute :performance_mode

#purge_tags ⇒ :yes, ...

Returns If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then tags will not be modified.

Returns:

  • (:yes, :no, nil) —

    If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then tags will not be modified.



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/efs.rb', line 19

attribute :purge_tags

#state ⇒ :present, ...

Returns Allows to create, search and destroy Amazon EFS file system.

Returns:

  • (:present, :absent, nil) —

    Allows to create, search and destroy Amazon EFS file system



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

attribute :state

#tags ⇒ Hash?

Returns List of tags of Amazon EFS. Should be defined as dictionary In case of ‘present’ state with list of tags and existing EFS (matched by ‘name’), tags of EFS will be replaced with provided data.

Returns:

  • (Hash, nil) —

    List of tags of Amazon EFS. Should be defined as dictionary In case of ‘present’ state with list of tags and existing EFS (matched by ‘name’), tags of EFS will be replaced with provided data.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/efs.rb', line 38

attribute :tags

#targets ⇒ Array<Hash>, ...

Returns List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: - subnet_id - Mandatory. The ID of the subnet to add the mount target in. - ip_address - Optional. A valid IPv4 address within the address range of the specified subnet. - security_groups - Optional. List of security group IDs, of the form ‘sg-xxxxxxxx’. These must be for the same VPC as subnet specified This data may be modified for existing EFS using state ‘present’ and new list of mount targets.

Returns:

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

    List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: - subnet_id - Mandatory. The ID of the subnet to add the mount target in. - ip_address - Optional. A valid IPv4 address within the address range of the specified subnet. - security_groups - Optional. List of security group IDs, of the form ‘sg-xxxxxxxx’. These must be for the same VPC as subnet specified This data may be modified for existing EFS using state ‘present’ and new list of mount targets.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/efs.rb', line 42

attribute :targets

#wait ⇒ :yes, ...

Returns In case of ‘present’ state should wait for EFS ‘available’ life cycle state (of course, if current state not ‘deleting’ or ‘deleted’) In case of ‘absent’ state should wait for EFS ‘deleted’ life cycle state.

Returns:

  • (:yes, :no, nil) —

    In case of ‘present’ state should wait for EFS ‘available’ life cycle state (of course, if current state not ‘deleting’ or ‘deleted’) In case of ‘absent’ state should wait for EFS ‘deleted’ life cycle state



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/efs.rb', line 46

attribute :wait

#wait_timeout ⇒ Integer?

Returns How long the module should wait (in seconds) for desired state before returning. Zero means wait as long as necessary.

Returns:

  • (Integer, nil) —

    How long the module should wait (in seconds) for desired state before returning. Zero means wait as long as necessary.



50
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/efs.rb', line 50

attribute :wait_timeout