ansible.builtin.ec2_lc (v2.3.3.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Can create or delete AWS Autoscaling Configurations

Works with the ec2_asg module to manage Autoscaling Groups

Requirements

• boto >= 2.39.0
• boto3 >= 1.17.0
• botocore >= 1.20.0
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- ec2_lc:
    name: special
    image_id: ami-XXX
    key_name: default
    security_groups: ['group', 'group2' ]
    instance_type: t1.micro
    volumes:
    - device_name: /dev/sda1
      volume_size: 100
      device_type: io1
      iops: 3000
      delete_on_termination: true
    - device_name: /dev/sdb
      ephemeral: ephemeral0

Inputs

    
name:
    description:
    - Unique name for configuration
    required: true

state:
    choices:
    - present
    - absent
    description:
    - register or deregister the instance
    required: true

region:
    aliases:
    - aws_region
    - ec2_region
    description:
    - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
      environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
    type: str

ec2_url:
    aliases:
    - aws_endpoint_url
    - endpoint_url
    description:
    - URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
      use EC2 endpoints). Ignored for modules where region is required. Must be specified
      for all other modules if region is not used. If not set then the value of the EC2_URL
      environment variable, if any, is used.
    type: str

profile:
    aliases:
    - aws_profile
    description:
    - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
      and I(security_token) options.
    type: str

volumes:
    description:
    - a list of volume dicts, each containing device name and optionally ephemeral id
      or snapshot id. Size and type (and number of iops for io device type) must be specified
      for a new volume or a root volume, and may be passed for a snapshot volume. For
      any volume, a volume size less than 1 will be interpreted as a request not to create
      the volume.
    required: false

image_id:
    description:
    - The AMI unique identifier to be used for the group
    required: false

key_name:
    description:
    - The SSH key name to be used for access to managed instances
    required: false

kernel_id:
    description:
    - Kernel id for the EC2 instance
    required: false

user_data:
    description:
    - opaque blob of data which is made available to the ec2 instance. Mutually exclusive
      with I(user_data_path).
    required: false

aws_config:
    description:
    - A dictionary to modify the botocore configuration.
    - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
    type: dict

ramdisk_id:
    description:
    - A RAM disk id for the instances.
    required: false
    version_added: '1.8'
    version_added_collection: ansible.builtin

spot_price:
    description:
    - The spot price you are bidding. Only applies for an autoscaling group with spot
      instances.
    required: false

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
      from the controller if not run locally.'
    type: path

ebs_optimized:
    default: false
    description:
    - Specifies whether the instance is optimized for EBS I/O (true) or not (false).
    required: false
    version_added: '1.8'
    version_added_collection: ansible.builtin

instance_type:
    aliases: []
    default: null
    description:
    - instance type to use for the instance
    required: true

aws_access_key:
    aliases:
    - ec2_access_key
    - access_key
    description:
    - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
      or C(EC2_ACCESS_KEY) environment variable is used.
    - The I(aws_access_key) and I(profile) options are mutually exclusive.
    type: str

aws_secret_key:
    aliases:
    - ec2_secret_key
    - secret_key
    description:
    - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
      or C(EC2_SECRET_KEY) environment variable is used.
    - The I(aws_secret_key) and I(profile) options are mutually exclusive.
    type: str

security_token:
    aliases:
    - aws_session_token
    - session_token
    - aws_security_token
    - access_token
    description:
    - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
      or C(EC2_SECURITY_TOKEN) environment variable is used.
    - The I(security_token) and I(profile) options are mutually exclusive.
    - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
    type: str

user_data_path:
    description:
    - Path to the file that contains userdata for the ec2 instances. Mutually exclusive
      with I(user_data).
    required: false
    version_added: '2.3'
    version_added_collection: ansible.builtin

validate_certs:
    default: true
    description:
    - When set to "no", SSL certificates will not be validated for communication with
      the AWS APIs.
    type: bool

security_groups:
    description:
    - A list of security groups to apply to the instances. For VPC instances, specify
      security group IDs. For EC2-Classic, specify either security group names or IDs.
    required: false

assign_public_ip:
    description:
    - Used for Auto Scaling groups that launch instances into an Amazon Virtual Private
      Cloud. Specifies whether to assign a public IP address to each instance launched
      in a Amazon VPC.
    required: false
    version_added: '1.8'
    version_added_collection: ansible.builtin

classic_link_vpc_id:
    description:
    - Id of ClassicLink enabled VPC
    required: false
    version_added: '2.0'
    version_added_collection: ansible.builtin

instance_monitoring:
    default: false
    description:
    - whether instances in group are launched with detailed monitoring.

instance_profile_name:
    description:
    - The name or the Amazon Resource Name (ARN) of the instance profile associated with
      the IAM role for the instances.
    required: false
    version_added: '1.8'
    version_added_collection: ansible.builtin

debug_botocore_endpoint_logs:
    default: 'no'
    description:
    - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
      API calls made during a task, outputing the set to the resource_actions key in the
      task results. Use the aws_resource_action callback to output to total list made
      during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
      be used.
    type: bool

classic_link_vpc_security_groups:
    description:
    - A list of security group id's with which to associate the ClassicLink VPC instances.
    required: false
    version_added: '2.0'
    version_added_collection: ansible.builtin