Class: Ansible::Ruby::Modules::Ec2

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb,
lib/ansible/ruby/modules/custom/cloud/core/amazon/ec2.rb

Overview

Creates or terminates ec2 instances.

Instance Method Summary

• #assign_public_ip ⇒ Symbol^?

  When provisioning within vpc, assign a public IP address.

• #count ⇒ Integer^?

  Number of instances to launch.

• #count_tag ⇒ Hash, ...

  Used with ‘exact_count’ to determine how many nodes based on a specific tag criteria should be running.

• #ebs_optimized ⇒ String^?

  Whether instance is using optimized EBS volumes, see U(docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html).

• #exact_count ⇒ Integer^?

  An integer value which indicates how many instances that match the ‘count_tag’ parameter should be running.

• #group ⇒ Array<String>, ...

  Security group (or list of groups) to use with the instance.

• #group_id ⇒ String^?

  Security group id (or list of ids) to use with the instance.

• #id ⇒ Object^?

  Identifier for this instance or set of instances, so that the module will be idempotent with respect to EC2 instances.

• #image ⇒ String

  I(ami) ID to use for the instance.

• #instance_ids ⇒ Array<String>, ...

  List of instance ids, currently used for states: absent, running, stopped.

• #instance_initiated_shutdown_behavior ⇒ :stop, ...

  Set whether AWS will Stop or Terminate an instance on shutdown.

• #instance_profile_name ⇒ Object^?

  Name of the IAM instance profile (i.e. what the EC2 console refers to as an “IAM Role”) to use.

• #instance_tags ⇒ Hash^?

  A hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’.

• #instance_type ⇒ String

  Instance type to use for the instance, see U(docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html).

• #kernel ⇒ Object^?

  Kernel I(eki) to use for the instance.

• #key_name ⇒ String^?

  Key pair to use on the instance.

• #monitoring ⇒ :yes, ...

  Enable detailed monitoring (CloudWatch) for instance.

• #network_interfaces ⇒ Array<String>, ...

  A list of existing network interfaces to attach to the instance at launch.

• #placement_group ⇒ Object^?

  Placement group for the instance when using EC2 Clustered Compute.

• #private_ip ⇒ Object^?

  The private ip address to assign the instance (from the vpc subnet).

• #ramdisk ⇒ Object^?

  Ramdisk I(eri) to use for the instance.

• #region ⇒ String^?

  The AWS region to use.

• #source_dest_check ⇒ Symbol^?

  Enable or Disable the Source/Destination checks (for NAT instances and Virtual Routers).

• #spot_launch_group ⇒ String^?

  Launch group for spot request, see U(docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-spot-instances-work.html#spot-launch-group).

• #spot_price ⇒ Float^?

  Maximum spot price to bid, If not set a regular on-demand instance is requested.

• #spot_type ⇒ :"one-time", ...

  Type of spot request; one of “one-time” or “persistent”.

• #spot_wait_timeout ⇒ Integer^?

  How long to wait for the spot instance request to be fulfilled.

• #state ⇒ :present, ...

  Create, terminate, start, stop or restart instances.

• #tenancy ⇒ :default, ...

  An instance with a tenancy of “dedicated” runs on single-tenant hardware and can only be launched into a VPC.

• #termination_protection ⇒ :yes, ...

  Enable or Disable the Termination Protection.

• #user_data ⇒ Object^?

  Opaque blob of data which is made available to the ec2 instance.

• #volumes ⇒ Array<Hash>, ...

  A list of hash/dictionaries of volumes to add to the new instance; ‘[“key”:“value”]’; keys allowed are - device_name (str; required), delete_on_termination (bool; False), device_type (deprecated), ephemeral (str), encrypted (bool; False), snapshot (str), volume_type (str), volume_size (int, GB), iops (int) - device_type is deprecated use volume_type, iops must be set when volume_type=‘io1’, ephemeral and snapshot are mutually exclusive.

• #vpc_subnet_id ⇒ String^?

  The subnet ID in which to launch the instance (VPC).

• #wait ⇒ :yes, ...

  Wait for the instance to reach its desired state before returning.

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

• #zone ⇒ Object^?

  AWS availability zone in which to launch the instance.

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

#assign_public_ip ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 94

attribute :assign_public_ip

#count ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 72

attribute :count

#count_tag ⇒ Hash, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 136

attribute :count_tag

#ebs_optimized ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 128

attribute :ebs_optimized

#exact_count ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 132

attribute :exact_count

#group ⇒ Array<String>, ...

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

attribute :group

#group_id ⇒ String^?

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

attribute :group_id

#id ⇒ Object^?

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

attribute :id

#image ⇒ String

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

attribute :image

#instance_ids ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 104

attribute :instance_ids

#instance_initiated_shutdown_behavior ⇒ :stop, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 116

attribute :instance_initiated_shutdown_behavior

#instance_profile_name ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 101

attribute :instance_profile_name

#instance_tags ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 83

attribute :instance_tags

#instance_type ⇒ String

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

attribute :instance_type

#kernel ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 54

attribute :kernel

#key_name ⇒ String^?

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

attribute :key_name

#monitoring ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 76

attribute :monitoring

#network_interfaces ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 140

attribute :network_interfaces

#placement_group ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 87

attribute :placement_group

#private_ip ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 98

attribute :private_ip

#ramdisk ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 57

attribute :ramdisk

#region ⇒ String^?

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

attribute :region

#source_dest_check ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 108

attribute :source_dest_check

#spot_launch_group ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 144

attribute :spot_launch_group

#spot_price ⇒ Float^?

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

attribute :spot_price

#spot_type ⇒ :"one-time", ...

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

attribute :spot_type

#spot_wait_timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 68

attribute :spot_wait_timeout

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 120

attribute :state

#tenancy ⇒ :default, ...

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

attribute :tenancy

#termination_protection ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 112

attribute :termination_protection

#user_data ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 80

attribute :user_data

#volumes ⇒ Array<Hash>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 124

attribute :volumes

#vpc_subnet_id ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 90

attribute :vpc_subnet_id

#wait ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 60

attribute :wait

#wait_timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2.rb', line 64

attribute :wait_timeout

#zone ⇒ Object^?

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

attribute :zone