amazon.cloud.autoscaling_launch_configuration (0.4.0) — module

Creates and manages a web ACL association.

| "added in version" 0.3.0 of amazon.cloud"

Authors: Ansible Cloud Team (@ansible-collections)

Install collection

Install with ansible-galaxy collection install amazon.cloud:==0.4.0


Add to requirements.yml

  collections:
    - name: amazon.cloud
      version: 0.4.0

Description

Creates and manages a web ACL association.

Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource.


Requirements

Inputs

    
wait:
    default: false
    description:
    - Wait for operation to complete before returning.
    type: bool

force:
    default: false
    description:
    - Cancel IN_PROGRESS and PENDING resource requestes.
    - Because you can only perform a single operation on a given resource at a time, there
      might be cases where you need to cancel the current resource operation to make the
      resource available so that another operation may be performed on it.
    type: bool

state:
    choices:
    - present
    - absent
    - list
    - describe
    - get
    default: present
    description:
    - Goal state for resource.
    - I(state=present) creates the resource if it doesn't exist, or updates to the provided
      state if the resource already exists.
    - I(state=absent) ensures an existing instance is deleted.
    - I(state=list) get all the existing resources.
    - I(state=describe) or I(state=get) retrieves information on an existing resource.
    type: str

region:
    aliases:
    - aws_region
    - ec2_region
    description:
    - The AWS region to use.
    - For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
    - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
    - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
    - The C(ec2_region) alias has been deprecated and will be removed in a release after
      2024-12-01
    - Support for the C(EC2_REGION) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

profile:
    aliases:
    - aws_profile
    description:
    - A named AWS profile to use for authentication.
    - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
    - The C(AWS_PROFILE) environment variable may also be used.
    - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
      and I(security_token) options.
    type: str

image_id:
    description:
    - Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during
      registration.
    type: str

key_name:
    description:
    - Provides the name of the EC2 key pair.
    type: str

kernel_id:
    description:
    - Provides the ID of the kernel associated with the EC2 AMI.
    type: str

user_data:
    description:
    - The Base64-encoded user data to make available to the launched EC2 instances.
    type: str

access_key:
    aliases:
    - aws_access_key_id
    - aws_access_key
    - ec2_access_key
    description:
    - AWS access key ID.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
      may also be used in decreasing order of preference.
    - The I(aws_access_key) and I(profile) options are mutually exclusive.
    - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
      AWS botocore SDK.
    - The I(ec2_access_key) alias has been deprecated and will be removed in a release
      after 2024-12-01.
    - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

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

secret_key:
    aliases:
    - aws_secret_access_key
    - aws_secret_key
    - ec2_secret_key
    description:
    - AWS secret access key.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
      variables may also be used in decreasing order of preference.
    - The I(secret_key) and I(profile) options are mutually exclusive.
    - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
      the AWS botocore SDK.
    - The I(ec2_secret_key) alias has been deprecated and will be removed in a release
      after 2024-12-01.
    - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

spot_price:
    description:
    - The maximum hourly price you are willing to pay for any Spot Instances launched
      to fulfill the request.
    type: str

instance_id:
    description:
    - The ID of the Amazon EC2 instance you want to use to create the launch configuration.
    type: str

ram_disk_id:
    description:
    - The ID of the RAM disk to select.
    type: str

endpoint_url:
    aliases:
    - ec2_url
    - aws_endpoint_url
    - s3_url
    description:
    - URL to connect to instead of the default AWS endpoints.  While this can be used
      to connection to other AWS-compatible services the amazon.aws and community.aws
      collections are only tested against AWS.
    - The  C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
      order of preference.
    - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
      a release after 2024-12-01.
    - Support for the C(EC2_URL) environment variable has been deprecated and will be
      removed in a release after 2024-12-01.
    type: str

wait_timeout:
    default: 320
    description:
    - How many seconds to wait for an operation to complete before timing out.
    type: int

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - The C(AWS_CA_BUNDLE) environment variable may also be used.
    type: path

ebs_optimized:
    description:
    - Specifies whether the launch configuration is optimized for EBS I/O (true) or not
      (false).
    type: bool

instance_type:
    description:
    - Specifies the instance type of the EC2 instance.
    type: str

session_token:
    aliases:
    - aws_session_token
    - security_token
    - aws_security_token
    - access_token
    description:
    - AWS STS session token for use with temporary credentials.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
      variables may also be used in decreasing order of preference.
    - The I(security_token) and I(profile) options are mutually exclusive.
    - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
      the parameter being renamed from I(security_token) to I(session_token) in release
      6.0.0.
    - The I(security_token), I(aws_security_token), and I(access_token) aliases have been
      deprecated and will be removed in a release after 2024-12-01.
    - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
      has been deprecated and will be removed in a release after 2024-12-01.
    type: str

validate_certs:
    default: true
    description:
    - When set to C(false), SSL certificates will not be validated for communication with
      the AWS APIs.
    - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
      setting I(aws_ca_bundle) instead.
    type: bool

security_groups:
    description:
    - A list that contains the security groups to assign to the instances in the Auto
      Scaling group.
    elements: str
    type: list

metadata_options:
    description:
    - The metadata options for the instances.I(metadata_options) is a property of AWS::AutoScaling::LaunchConfiguration
      that describes metadata options for the instances.
    suboptions:
      http_endpoint:
        description:
        - This parameter enables or disables the HTTP metadata endpoint on your instances.
        type: str
      http_put_response_hop_limit:
        description:
        - The desired HTTP PUT response hop limit for instance metadata requests.
        type: int
      http_tokens:
        description:
        - The state of token usage for your instance metadata requests.
        type: str
    type: dict

placement_tenancy:
    description:
    - The tenancy of the instance, either default or dedicated.
    type: str

classic_link_vpc_id:
    description:
    - The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
    type: str

instance_monitoring:
    description:
    - Controls whether instances in this group are launched with detailed (true) or basic
      (false) monitoring.
    type: bool

iam_instance_profile:
    description:
    - Provides the name or the Amazon Resource Name (ARN) of the instance profile associated
      with the IAM role for the instance.
    - The instance profile contains the IAM role.
    type: str

block_device_mappings:
    description:
    - I(block_device_mapping) is a property of AWS::AutoScaling::LaunchConfiguration that
      describes a block device mapping for an Auto Scaling group.
    elements: dict
    suboptions:
      device_name:
        description:
        - The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).
        type: str
      ebs:
        description:
        - Parameters used to automatically set up EBS volumes when an instance is launched.I(block_device)
          is a subproperty of I(block_device_mapping) that describes an Amazon EBS volume.
        suboptions:
          delete_on_termination:
            description:
            - Indicates whether the volume is deleted on instance termination.
            type: bool
          encrypted:
            description:
            - Specifies whether the volume should be encrypted.
            type: bool
          iops:
            description:
            - The number of input/output (I/O) operations per second (IOPS) to provision
              for the volume.
            type: int
          snapshot_id:
            description:
            - The snapshot ID of the volume to use.
            type: str
          throughput:
            description:
            - The throughput (MiBps) to provision for a gp3 volume.
            type: int
          volume_size:
            description:
            - The volume size, in GiBs.
            type: int
          volume_type:
            description:
            - The volume type.
            type: str
        type: dict
      no_device:
        description:
        - Setting this value to true suppresses the specified device included in the block
          device mapping of the AMI.
        type: bool
      virtual_name:
        description:
        - The name of the virtual device.
        type: str
    type: list

launch_configuration_name:
    description:
    - The name of the launch configuration.
    - This name must be unique per Region per account.
    type: str

associate_public_ip_address:
    description:
    - For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies
      whether to assign a public IP address to the groups instances.
    type: bool

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

classic_link_vpc_security_groups:
    description:
    - The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId
      property.
    elements: str
    type: list

Outputs

result:
  contains:
    identifier:
      description: The unique identifier of the resource.
      type: str
    properties:
      description: The resource properties.
      type: dict
  description:
  - When I(state=list), it is a list containing dictionaries of resource information.
  - Otherwise, it is a dictionary of resource information.
  - When I(state=absent), it is an empty dictionary.
  returned: always
  type: complex