Class: Ansible::Ruby::Modules::Ec2_snapshot

Inherits:

Base

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

Defined in:

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

Overview

creates an EC2 snapshot from an existing EBS volume

Instance Method Summary

• #description ⇒ String^?

  Description to be applied to the snapshot.

• #device_name ⇒ String^?

  Device name of a mounted volume to be snapshotted.

• #instance_id ⇒ String^?

  Instance that has the required volume to snapshot mounted.

• #last_snapshot_min_age ⇒ Integer^?

  If the volume’s most recent snapshot has started less than ‘last_snapshot_min_age’ minutes ago, a new snapshot will not be created.

• #snapshot_id ⇒ String^?

  Snapshot id to remove.

• #snapshot_tags ⇒ Hash^?

  A hash/dictionary of tags to add to the snapshot.

• #state ⇒ :absent, ...

  Whether to add or create a snapshot.

• #volume_id ⇒ String^?

  Volume from which to take the snapshot.

• #wait ⇒ Boolean^?

  Wait for the snapshot to be ready.

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds,specify 0 to wait forever.

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

#description ⇒ String^?

Returns description to be applied to the snapshot.

Returns:

• (String, nil) —

  description to be applied to the snapshot

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

attribute :description

#device_name ⇒ String^?

Returns device name of a mounted volume to be snapshotted.

Returns:

• (String, nil) —

  device name of a mounted volume to be snapshotted

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

attribute :device_name

#instance_id ⇒ String^?

Returns instance that has the required volume to snapshot mounted.

Returns:

• (String, nil) —

  instance that has the required volume to snapshot mounted

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

attribute :instance_id

#last_snapshot_min_age ⇒ Integer^?

Returns If the volume’s most recent snapshot has started less than ‘last_snapshot_min_age’ minutes ago, a new snapshot will not be created.

Returns:

• (Integer, nil) —

  If the volume’s most recent snapshot has started less than ‘last_snapshot_min_age’ minutes ago, a new snapshot will not be created.

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

attribute :last_snapshot_min_age

#snapshot_id ⇒ String^?

Returns snapshot id to remove.

Returns:

• (String, nil) —

  snapshot id to remove

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

attribute :snapshot_id

#snapshot_tags ⇒ Hash^?

Returns a hash/dictionary of tags to add to the snapshot.

Returns:

• (Hash, nil) —

  a hash/dictionary of tags to add to the snapshot

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

attribute :snapshot_tags

#state ⇒ :absent, ...

Returns whether to add or create a snapshot.

Returns:

• (:absent, :present, nil) —

  whether to add or create a snapshot

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

attribute :state

#volume_id ⇒ String^?

Returns volume from which to take the snapshot.

Returns:

• (String, nil) —

  volume from which to take the snapshot

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

attribute :volume_id

#wait ⇒ Boolean^?

Returns wait for the snapshot to be ready.

Returns:

• (Boolean, nil) —

  wait for the snapshot to be ready

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

attribute :wait

#wait_timeout ⇒ Integer^?

Returns how long before wait gives up, in seconds,specify 0 to wait forever.

Returns:

• (Integer, nil) —

  how long before wait gives up, in seconds,specify 0 to wait forever

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

attribute :wait_timeout