Skip to content

/AWS1/CL_EC2PLACEMENT

Describes the placement of an instance.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_AVAILABILITYZONE TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported for CreateFleet.

IV_AFFINITY TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The affinity setting for the instance on the Dedicated Host.

This parameter is not supported for CreateFleet or ImportInstance.

IV_GROUPNAME TYPE /AWS1/EC2PLACEMENTGROUPNAME /AWS1/EC2PLACEMENTGROUPNAME

The name of the placement group that the instance is in. If you specify GroupName, you can't specify GroupId.

IV_PARTITIONNUMBER TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.

This parameter is not supported for CreateFleet.

IV_HOSTID TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

This parameter is not supported for CreateFleet or ImportInstance.

IV_TENANCY TYPE /AWS1/EC2TENANCY /AWS1/EC2TENANCY

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

IV_SPREADDOMAIN TYPE /AWS1/EC2STRING /AWS1/EC2STRING

Reserved for future use.

IV_HOSTRESOURCEGROUPARN TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

If you specify this parameter, either omit the Tenancy parameter or set it to host.

This parameter is not supported for CreateFleet.

IV_GROUPID TYPE /AWS1/EC2PLACEMENTGROUPID /AWS1/EC2PLACEMENTGROUPID

The ID of the placement group that the instance is in. If you specify GroupId, you can't specify GroupName.


Queryable Attributes

AvailabilityZone

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported for CreateFleet.

Accessible with the following methods

Method Description
GET_AVAILABILITYZONE() Getter for AVAILABILITYZONE, with configurable default
ASK_AVAILABILITYZONE() Getter for AVAILABILITYZONE w/ exceptions if field has no va
HAS_AVAILABILITYZONE() Determine if AVAILABILITYZONE has a value

Affinity

The affinity setting for the instance on the Dedicated Host.

This parameter is not supported for CreateFleet or ImportInstance.

Accessible with the following methods

Method Description
GET_AFFINITY() Getter for AFFINITY, with configurable default
ASK_AFFINITY() Getter for AFFINITY w/ exceptions if field has no value
HAS_AFFINITY() Determine if AFFINITY has a value

GroupName

The name of the placement group that the instance is in. If you specify GroupName, you can't specify GroupId.

Accessible with the following methods

Method Description
GET_GROUPNAME() Getter for GROUPNAME, with configurable default
ASK_GROUPNAME() Getter for GROUPNAME w/ exceptions if field has no value
HAS_GROUPNAME() Determine if GROUPNAME has a value

PartitionNumber

The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.

This parameter is not supported for CreateFleet.

Accessible with the following methods

Method Description
GET_PARTITIONNUMBER() Getter for PARTITIONNUMBER, with configurable default
ASK_PARTITIONNUMBER() Getter for PARTITIONNUMBER w/ exceptions if field has no val
HAS_PARTITIONNUMBER() Determine if PARTITIONNUMBER has a value

HostId

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

This parameter is not supported for CreateFleet or ImportInstance.

Accessible with the following methods

Method Description
GET_HOSTID() Getter for HOSTID, with configurable default
ASK_HOSTID() Getter for HOSTID w/ exceptions if field has no value
HAS_HOSTID() Determine if HOSTID has a value

Tenancy

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

Accessible with the following methods

Method Description
GET_TENANCY() Getter for TENANCY, with configurable default
ASK_TENANCY() Getter for TENANCY w/ exceptions if field has no value
HAS_TENANCY() Determine if TENANCY has a value

SpreadDomain

Reserved for future use.

Accessible with the following methods

Method Description
GET_SPREADDOMAIN() Getter for SPREADDOMAIN, with configurable default
ASK_SPREADDOMAIN() Getter for SPREADDOMAIN w/ exceptions if field has no value
HAS_SPREADDOMAIN() Determine if SPREADDOMAIN has a value

HostResourceGroupArn

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

If you specify this parameter, either omit the Tenancy parameter or set it to host.

This parameter is not supported for CreateFleet.

Accessible with the following methods

Method Description
GET_HOSTRESOURCEGROUPARN() Getter for HOSTRESOURCEGROUPARN, with configurable default
ASK_HOSTRESOURCEGROUPARN() Getter for HOSTRESOURCEGROUPARN w/ exceptions if field has n
HAS_HOSTRESOURCEGROUPARN() Determine if HOSTRESOURCEGROUPARN has a value

GroupId

The ID of the placement group that the instance is in. If you specify GroupId, you can't specify GroupName.

Accessible with the following methods

Method Description
GET_GROUPID() Getter for GROUPID, with configurable default
ASK_GROUPID() Getter for GROUPID w/ exceptions if field has no value
HAS_GROUPID() Determine if GROUPID has a value