amazon.cloud.autoscaling_launch_configuration module – Creates and manages a web ACL association.

Note

This module is part of the amazon.cloud collection (version 0.4.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.cloud.autoscaling_launch_configuration.

New in amazon.cloud 0.3.0

Synopsis

  • 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

The below requirements are needed on the host that executes this module.

  • python >= 3.9

  • boto3 >= 1.25.0

  • botocore >= 1.28.0

  • jsonpatch

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

associate_public_ip_address

boolean

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.

Choices:

  • false

  • true

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

block_device_mappings

list / elements=dictionary

block_device_mapping is a property of AWS::AutoScaling::LaunchConfiguration that describes a block device mapping for an Auto Scaling group.

device_name

string

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

ebs

dictionary

Parameters used to automatically set up EBS volumes when an instance is launched.block_device is a subproperty of block_device_mapping that describes an Amazon EBS volume.

delete_on_termination

boolean

Indicates whether the volume is deleted on instance termination.

Choices:

  • false

  • true

encrypted

boolean

Specifies whether the volume should be encrypted.

Choices:

  • false

  • true

iops

integer

The number of input/output (I/O) operations per second (IOPS) to provision for the volume.

snapshot_id

string

The snapshot ID of the volume to use.

throughput

integer

The throughput (MiBps) to provision for a gp3 volume.

volume_size

integer

The volume size, in GiBs.

volume_type

string

The volume type.

no_device

boolean

Setting this value to true suppresses the specified device included in the block device mapping of the AMI.

Choices:

  • false

  • true

virtual_name

string

The name of the virtual device.

string

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

list / elements=string

The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • false ← (default)

  • true

ebs_optimized

boolean

Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false).

Choices:

  • false

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

force

boolean

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.

Choices:

  • false ← (default)

  • true

iam_instance_profile

string

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.

image_id

string

Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.

instance_id

string

The ID of the Amazon EC2 instance you want to use to create the launch configuration.

instance_monitoring

boolean

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

Choices:

  • false

  • true

instance_type

string

Specifies the instance type of the EC2 instance.

kernel_id

string

Provides the ID of the kernel associated with the EC2 AMI.

key_name

string

Provides the name of the EC2 key pair.

launch_configuration_name

string

The name of the launch configuration.

This name must be unique per Region per account.

metadata_options

dictionary

The metadata options for the instances.metadata_options is a property of AWS::AutoScaling::LaunchConfiguration that describes metadata options for the instances.

http_endpoint

string

This parameter enables or disables the HTTP metadata endpoint on your instances.

http_put_response_hop_limit

integer

The desired HTTP PUT response hop limit for instance metadata requests.

http_tokens

string

The state of token usage for your instance metadata requests.

placement_tenancy

string

The tenancy of the instance, either default or dedicated.

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

ram_disk_id

string

The ID of the RAM disk to select.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

security_groups

list / elements=string

A list that contains the security groups to assign to the instances in the Auto Scaling group.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

spot_price

string

The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.

state

string

Goal state for resource.

state=present creates the resource if it doesn’t exist, or updates to the provided state if the resource already exists.

state=absent ensures an existing instance is deleted.

state=list get all the existing resources.

state=describe or state=get retrieves information on an existing resource.

Choices:

  • "present" ← (default)

  • "absent"

  • "list"

  • "describe"

  • "get"

user_data

string

The Base64-encoded user data to make available to the launched EC2 instances.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

wait

boolean

Wait for operation to complete before returning.

Choices:

  • false ← (default)

  • true

wait_timeout

integer

How many seconds to wait for an operation to complete before timing out.

Default: 320

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

complex

When state=list, it is a list containing dictionaries of resource information.

Otherwise, it is a dictionary of resource information.

When state=absent, it is an empty dictionary.

Returned: always

identifier

string

The unique identifier of the resource.

Returned: success

properties

dictionary

The resource properties.

Returned: success

Authors

  • Ansible Cloud Team (@ansible-collections)