Idem.AWS.EC2.INSTANCE

Idem.AWS.EC2.INSTANCE
Idem.AWS.EC2.INSTANCE
JSON Example
{
    "account": "string",
    "affinity": "string",
    "auto_recovery_enabled": false,
    "availability_zone": "string",
    "block_device_mappings": [
        {
            "delete_on_termination": false,
            "device_name": "string",
            "encrypted": false,
            "size": 0,
            "type": "string",
            "volume_id": "string"
        }
    ],
    "block_duration_minutes": 0,
    "bootstrap": [
        {}
    ],
    "capacity_reservation_preference": "string",
    "client_token": "string",
    "count": 0,
    "cpu_core_count": 0,
    "cpu_credits": "string",
    "cpu_threads_per_core": 0,
    "disable_api_termination": false,
    "ebs_optimized": false,
    "elastic_gpu_specifications": [
        {
            "Type": "string"
        }
    ],
    "elastic_inference_accelerators": [
        {
            "Count": 0,
            "Type": "string"
        }
    ],
    "enable_resource_name_dns_a_record": false,
    "enable_resource_name_dns_aaaa_record": false,
    "group_name": "string",
    "hibernation_enabled": false,
    "host_id": "string",
    "host_resource_group_arn": "string",
    "hostname_type": "string",
    "http_endpoint_enabled": false,
    "http_protocol_ipv6_enabled": false,
    "http_put_response_hop_limit": 0,
    "http_tokens": "string",
    "iam_instance_profile_arn": "string",
    "image_id": "string",
    "instance_initiated_shutdown_behavior": "string",
    "instance_interruption_behavior": "string",
    "instance_state": "string",
    "instance_type": "string",
    "kernel_id": "string",
    "key_name": "string",
    "license_arns": [
        "string"
    ],
    "market_type": "string",
    "max_price": "string",
    "metadata_tags_enabled": false,
    "monitoring_enabled": false,
    "name": "string",
    "network_interfaces": [
        {
            "device_index": 0,
            "mac_address": "string",
            "network_card_index": 0,
            "network_interface_id": "string",
            "private_ip_address": "string",
            "public_ip_address": "string",
            "subnet_id": "string"
        }
    ],
    "nitro_enclave_enabled": false,
    "owner_id": "string",
    "partition_number": 0,
    "private_ip_address": "string",
    "product_codes": [
        {}
    ],
    "public_ip_address": "string",
    "ram_disk_id": "string",
    "region": "string",
    "reservation_id": "string",
    "resource_id": "string",
    "root_device_name": "string",
    "running": false,
    "security_group_ids": [
        "string"
    ],
    "source_dest_check": false,
    "spot_instance_type": "string",
    "spread_domain": "string",
    "sriov_net_support": "string",
    "subnet_id": "string",
    "tenancy": "string",
    "user_data": "string",
    "valid_until": "string"
}
string
account
Required

The name of the vRA cloud account to use during provisioning

string
affinity
Optional

The affinity setting for the instance on the Dedicated Host.

boolean
auto_recovery_enabled
Optional

Disables the automatic recovery behavior of your instance or sets it to default.

string
availability_zone
Optional

The Availability Zone of the instance.

array of object
block_device_mappings
Optional

The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide. Defaults to None.

integer
block_duration_minutes
Optional

Deprecated.

array of object
bootstrap
Optional

Bootstr options for provisioning an instance with "heist".

string
capacity_reservation_preference
Optional

Indicates the instance's Capacity Reservation preferences.

string
client_token
Optional

The idempotency token for the instance.

integer
count
Optional

The number of resource instances to be created.

integer
cpu_core_count
Optional

The number of CPU cores for the instance.

string
cpu_credits
Optional

The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.

integer
cpu_threads_per_core
Optional

The number of threads per CPU core. To disable multithreading for the instance, specify a value of1 . Otherwise, specify the default value of 2.

boolean
disable_api_termination
Optional

Indicates that an instance cannot be terminated using the Amazon Ec2 console, command line tool, or API.

boolean
ebs_optimized
Optional

Indicates whether the instance is optimized ofr Amazon EBS I/O.

array of object
elastic_gpu_specifications
Optional

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide. Defaults to None.

  • Type (str): The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances.
array of object
elastic_inference_accelerators
Optional

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request. Defaults to None.

boolean
enable_resource_name_dns_a_record
Optional

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

boolean
enable_resource_name_dns_aaaa_record
Optional

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

string
group_name
Optional

The affinity setting for the instance on the Dedicated Host.

boolean
hibernation_enabled
Optional

Indicates whether the instance is configured for hibernation.

string
host_id
Optional

The ID of the Dedicated Host on which the instance resides.

string
host_resource_group_arn
Optional

The ARN of the host resource group in which to launch the instances.

string
hostname_type
Optional

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

boolean
http_endpoint_enabled
Optional

Enables or disables the HTTP metadata endpoint on your instances. If you specify a value of disabled, you cannot access your instance metadata. Default: enabled.

boolean
http_protocol_ipv6_enabled
Optional

Enables or disables the IPv6 endpoint for the instance metadata service.

integer
http_put_response_hop_limit
Optional

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Default: 1 Possible values: Integers from 1 to 64.

string
http_tokens
Optional

The state of token usage for your instance metadata requests. If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned. If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available. Default: Optional.

string
iam_instance_profile_arn
Optional

The IAM instance profile ARN.

string
image_id
Required

The ID of an AMI.

string
instance_initiated_shutdown_behavior
Optional

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

string
instance_interruption_behavior
Optional

The behavior when a Spot Instance is interrupted. The default is terminate.

object
instance_requirements
Optional

The attributes for the instance type. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

string
instance_state
Optional

The reported state of the instance, possible values are: pending, running, shutting-down, terminated, stopping, stopped

string
instance_type
Optional

The instance type to use for this instance on creation.

string
kernel_id
Optional

The kernel associated with this instance, if applicable.

string
key_name
Optional

The name of the keypair.

array of string
license_arns
Optional

The license configuration arns.

string
market_type
Optional

The market (purchasing) option for the instance.

string
max_price
Optional

The maximum hourly price you're willing to pay for the Spot Instances.

boolean
metadata_tags_enabled
Optional

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata. Default: disabled.

boolean
monitoring_enabled
Optional

Indicates whether detailed monitoring is enabled.

string
name
Required

An Idem name of the resource.

array of object
network_interfaces
Optional

The network interfaces to associate with the instance. This manages the network interface attachment to the instance, network interfaces themselves are managed in a separate state. Defaults to None.

boolean
nitro_enclave_enabled
Optional

Indicates whether the instance is enabled for AWS Nitro Enclaves.

string
owner_id
Optional

The ID of the AWS account that owns the reservation.

integer
partition_number
Optional

The number of the partition that the instance is in.

string
private_ip_address
Optional

The Ipv4 address of the network interface within the subnet.

array of object
product_codes
Optional

product_codes

string
public_ip_address
Optional

The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable. A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

string
ram_disk_id
Optional

The ID of the RAM disk, if applicable.

string
region
Required

vRA cloud account region to use during provisioning

string
reservation_id
Optional

The ID of the reservation

string
resource_id
Optional

AWS Ec2 Instance ID.

string
root_device_name
Optional

The device name of the root device (for example, /dev/sda1).

boolean
running
Optional

Indicates whether the instance should be in the "running" state.

array of string
security_group_ids
Optional

The IDs of the security groups. If you specify a network interface, you must specify any security groups as part of the network interface. Default: Amazon EC2 uses the default security group.

boolean
source_dest_check
Optional

Indicates whether source/destination checking is enabled.

string
spot_instance_type
Optional

The Spot Instance request type. Persistent Spot Instance requests are only supported when the instance interruption behavior is either hibernate or stop.

string
spread_domain
Optional

Not yet documented by AWS.

string
sriov_net_support
Optional

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

string
subnet_id
Optional

The ID of the subnet in which the instance is running.

object
tags
Optional

The tags to apply to the resource. Defaults to None.

string
tenancy
Optional

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

string
user_data
Optional

The user data for the instance.

string
valid_until
Optional

The end date of the request, in UTC format (YYYY -MM -DD THH :MM :SS Z). Supported only for persistent requests.