Join AnsibleFest at Red Hat Summit!

amazon.aws.ec2_dedicated_host module – Create, update or delete (release) EC2 dedicated host

Note

This module is part of the amazon.aws collection (version 9.3.0).

You might already have this collection installed if you are using the ansible package. 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.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.ec2_dedicated_host.

New in amazon.aws 9.3.0

Synopsis

  • Create, update or delete (release) EC2 dedicated host.

Requirements

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

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

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.

asset_ids

list / elements=string

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts.

Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads.

This parameter is supported only if you specify outpost_arn.

If you specify this parameter, you can omit quantity.

If you specify both asset_ids and quantity, then the value for quantity must be equal to the number of asset_ids specified.

auto_placement

string

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.

Choices:

  • "on"

  • "off" ← (default)

availability_zone

string

The Availability Zone in which to allocate the Dedicated Host.

Required if state=present.

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.

client_token

string

case-sensitive identifier that you provide to ensure the idempotency of the request.

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

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.

host_id

string

The IDs of the Dedicated Hosts to release or modify

host_maintenance

string

Indicates whether to enable or disable host maintenance for the Dedicated Host.

Choices:

  • "on"

  • "off" ← (default)

host_recovery

string

Indicates whether to enable or disable host recovery for the Dedicated Host.

Host recovery is disabled by default.

Choices:

  • "on"

  • "off" ← (default)

instance_family

string

Specifies the instance family to be supported by the Dedicated Hosts.

If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

At least one of instance_family or instance_type must be specified when allocating dedicated host.

Mutually exclusive with paramter instance_type.

instance_type

string

Specifies the instance type to be supported by the Dedicated Hosts.

If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

At least one of instance_family or instance_type must be specified when allocating dedicated host.

Mutually exclusive with paramter instance_family.

lookup

string

Look up EC2 dedicated host by either tags or by host_id.

If lookup=tag and tags is not specified then no lookup for an existing dedicated host is performed and a new dedicated host will be created.

When using lookup=tag, multiple matches being found will result in a failure and no changes will be made.

To change the tags of a dedicated host, use lookup=host_id.

Choices:

  • "tag" ← (default)

  • "host_id"

outpost_arn

string

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.

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.

purge_tags

boolean

If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.

If the tags parameter is not set then tags will not be modified, even if purge_tags=True.

Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Choices:

  • false

  • true ← (default)

quantity

integer

The number of Dedicated Hosts to allocate to your account with these parameters.

Required when state=present.

If you are allocating the Dedicated Hosts on an Outpost, and you specify asset_ids, you can omit this parameter.

If you specify both asset_ids and quantity, then the value that you specify for quantity must be equal to the number of asset_ids specified.

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.

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.

state

string

Create or delete dedicated host.

Choices:

  • "present" ← (default)

  • "absent"

tags

aliases: resource_tags

dictionary

A dictionary representing the tags to be applied to the resource.

If the tags parameter is not set then tags will not be modified.

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)

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

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Release dedicated hosts
- name: Release dedicated host
  amazon.aws.ec2_dedicated_host:
    host_id: "h-0123456789abcdef0"

# Allocate dedicated host using instance type
- name: Allocate dedicated host using instance_type
  amazon.aws.ec2_dedicated_host:
    availability_zone: us-east-1a
    quantity: 1
    instance_type: mac2.metal
    tags:
      Scope: Mac

Return Values

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

Key

Description

host

complex

Information about the dedicated host created/updated.

Returned: When state=present

allocation_time

string

The time that the Dedicated Host was allocated.

Returned: always

Sample: "2025-02-12T12:09:22+00:00"

allows_multiple_instance_types

string

Indicates whether the Dedicated Host supports multiple instance types of the same instance family.

Returned: always

Sample: "off"

asset_id

string

The ID of the Outpost hardware asset on which the Dedicated Host is allocated.

Returned: always

Sample: "abcdefgh"

auto_placement

string

Whether auto-placement is on or off.

Returned: always

Sample: "off"

availability_zone

string

The Availability Zone of the Dedicated Host.

Returned: always

Sample: "us-east-1b"

availability_zone_id

string

The ID of the Availability Zone in which the Dedicated Host is allocated.

Returned: always

Sample: "use1-az6"

available_capacity

dictionary

Information about the instances running on the Dedicated Host.

Returned: always

available_instance_capacity

complex

The number of instances that can be launched onto the Dedicated Host.

Returned: always

available_capacity

integer

The number of instances that can be launched onto the Dedicated Host.

Returned: always

Sample: 1

instance_type

string

The instance type supported by the Dedicated Host.

Returned: always

Sample: "mac2.metal"

total_capacity

dictionary

The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.

Returned: always

Sample: 1

available_v_cpus

integer

The number of vCPUs available for launching instances onto the Dedicated Host.

Returned: always

Sample: 8

client_token

string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returned: always

Sample: "token-0123456789a"

host_id

string

The ID of the Dedicated Host.

Returned: always

Sample: "h-03f51341e6e39f848"

host_maintenance

string

Indicates whether host maintenance is enabled or disabled for the Dedicated Host.

Returned: always

Sample: "off"

host_properties

dictionary

The hardware specifications of the Dedicated Host.

Returned: always

cores

integer

The number of cores on the Dedicated Host.

Returned: always

Sample: 8

instance_family

string

The instance family supported by the Dedicated Host.

Returned: if defined

Sample: "mac2"

instance_type

string

The instance type supported by the Dedicated Host.

Returned: always

Sample: "mac2.metal"

sockets

integer

The number of sockets on the Dedicated Host.

Returned: always

Sample: 1

total_v_cpus

integer

The total number of vCPUs on the Dedicated Host.

Returned: always

Sample: 8

host_recovery

string

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

Returned: always

Sample: "off"

host_reservation_id

string

The reservation ID of the Dedicated Host.

Returned: always

instances

complex

The IDs and instance type that are currently running on the Dedicated Host.

Returned: always

instance_id

string

The ID of instance that is running on the Dedicated Host.

Returned: always

Sample: "i-0123456789abcd"

instance_type

string

The instance type of the running instance.

Returned: always

Sample: "ec2.micro"

owner_id

string

The ID of the Amazon Web Services account that owns the instance.

Returned: always

Sample: "0123456789"

member_of_service_linked_resource_group

boolean

Indicates whether the Dedicated Host is in a host resource group.

Returned: always

Sample: false

outpost_arn

string

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.

Returned: always

Sample: "arn:aws:outposts:us-east-1:0123012301230123:outpost/op-0123456789abcdef0"

owner_id

string

The ID of the Amazon Web Services account that owns the Dedicated Host.

Returned: always

Sample: "0123456789"

release_time

string

The time that the Dedicated Host was released.

Returned: always

Sample: "2025-02-12T12:09:22+00:00"

state

string

The state of the Dedicated Host.

Returned: always

Sample: "available"

tags

dictionary

Dictionary of tags added to the dedicated host.

Returned: always

Sample: {}

Authors

  • Aubin Bikouo (@abikouo)