AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::EC2::Model::Placement Class Reference

#include <Placement.h>

Public Member Functions

 Placement ()
 
 Placement (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Placementoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
PlacementWithAvailabilityZone (const Aws::String &value)
 
PlacementWithAvailabilityZone (Aws::String &&value)
 
PlacementWithAvailabilityZone (const char *value)
 
const Aws::StringGetAffinity () const
 
bool AffinityHasBeenSet () const
 
void SetAffinity (const Aws::String &value)
 
void SetAffinity (Aws::String &&value)
 
void SetAffinity (const char *value)
 
PlacementWithAffinity (const Aws::String &value)
 
PlacementWithAffinity (Aws::String &&value)
 
PlacementWithAffinity (const char *value)
 
const Aws::StringGetGroupName () const
 
bool GroupNameHasBeenSet () const
 
void SetGroupName (const Aws::String &value)
 
void SetGroupName (Aws::String &&value)
 
void SetGroupName (const char *value)
 
PlacementWithGroupName (const Aws::String &value)
 
PlacementWithGroupName (Aws::String &&value)
 
PlacementWithGroupName (const char *value)
 
int GetPartitionNumber () const
 
bool PartitionNumberHasBeenSet () const
 
void SetPartitionNumber (int value)
 
PlacementWithPartitionNumber (int value)
 
const Aws::StringGetHostId () const
 
bool HostIdHasBeenSet () const
 
void SetHostId (const Aws::String &value)
 
void SetHostId (Aws::String &&value)
 
void SetHostId (const char *value)
 
PlacementWithHostId (const Aws::String &value)
 
PlacementWithHostId (Aws::String &&value)
 
PlacementWithHostId (const char *value)
 
const TenancyGetTenancy () const
 
bool TenancyHasBeenSet () const
 
void SetTenancy (const Tenancy &value)
 
void SetTenancy (Tenancy &&value)
 
PlacementWithTenancy (const Tenancy &value)
 
PlacementWithTenancy (Tenancy &&value)
 
const Aws::StringGetSpreadDomain () const
 
bool SpreadDomainHasBeenSet () const
 
void SetSpreadDomain (const Aws::String &value)
 
void SetSpreadDomain (Aws::String &&value)
 
void SetSpreadDomain (const char *value)
 
PlacementWithSpreadDomain (const Aws::String &value)
 
PlacementWithSpreadDomain (Aws::String &&value)
 
PlacementWithSpreadDomain (const char *value)
 
const Aws::StringGetHostResourceGroupArn () const
 
bool HostResourceGroupArnHasBeenSet () const
 
void SetHostResourceGroupArn (const Aws::String &value)
 
void SetHostResourceGroupArn (Aws::String &&value)
 
void SetHostResourceGroupArn (const char *value)
 
PlacementWithHostResourceGroupArn (const Aws::String &value)
 
PlacementWithHostResourceGroupArn (Aws::String &&value)
 
PlacementWithHostResourceGroupArn (const char *value)
 

Detailed Description

Describes the placement of an instance.

See Also:

AWS API Reference

Definition at line 32 of file Placement.h.

Constructor & Destructor Documentation

◆ Placement() [1/2]

Aws::EC2::Model::Placement::Placement ( )

◆ Placement() [2/2]

Aws::EC2::Model::Placement::Placement ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AffinityHasBeenSet()

bool Aws::EC2::Model::Placement::AffinityHasBeenSet ( ) const
inline

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 124 of file Placement.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::EC2::Model::Placement::AvailabilityZoneHasBeenSet ( ) const
inline

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 by CreateFleet.

Definition at line 57 of file Placement.h.

◆ GetAffinity()

const Aws::String& Aws::EC2::Model::Placement::GetAffinity ( ) const
inline

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 115 of file Placement.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::EC2::Model::Placement::GetAvailabilityZone ( ) const
inline

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 by CreateFleet.

Definition at line 49 of file Placement.h.

◆ GetGroupName()

const Aws::String& Aws::EC2::Model::Placement::GetGroupName ( ) const
inline

The name of the placement group the instance is in.

Definition at line 184 of file Placement.h.

◆ GetHostId()

const Aws::String& Aws::EC2::Model::Placement::GetHostId ( ) const
inline

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 262 of file Placement.h.

◆ GetHostResourceGroupArn()

const Aws::String& Aws::EC2::Model::Placement::GetHostResourceGroupArn ( ) const
inline

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

Definition at line 444 of file Placement.h.

◆ GetPartitionNumber()

int Aws::EC2::Model::Placement::GetPartitionNumber ( ) const
inline

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

This parameter is not supported by CreateFleet.

Definition at line 228 of file Placement.h.

◆ GetSpreadDomain()

const Aws::String& Aws::EC2::Model::Placement::GetSpreadDomain ( ) const
inline

Reserved for future use.

This parameter is not supported by CreateFleet.

Definition at line 393 of file Placement.h.

◆ GetTenancy()

const Tenancy& Aws::EC2::Model::Placement::GetTenancy ( ) const
inline

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. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 336 of file Placement.h.

◆ GroupNameHasBeenSet()

bool Aws::EC2::Model::Placement::GroupNameHasBeenSet ( ) const
inline

The name of the placement group the instance is in.

Definition at line 189 of file Placement.h.

◆ HostIdHasBeenSet()

bool Aws::EC2::Model::Placement::HostIdHasBeenSet ( ) const
inline

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 271 of file Placement.h.

◆ HostResourceGroupArnHasBeenSet()

bool Aws::EC2::Model::Placement::HostResourceGroupArnHasBeenSet ( ) const
inline

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

Definition at line 452 of file Placement.h.

◆ operator=()

Placement& Aws::EC2::Model::Placement::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::EC2::Model::Placement::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::EC2::Model::Placement::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ PartitionNumberHasBeenSet()

bool Aws::EC2::Model::Placement::PartitionNumberHasBeenSet ( ) const
inline

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

This parameter is not supported by CreateFleet.

Definition at line 236 of file Placement.h.

◆ SetAffinity() [1/3]

void Aws::EC2::Model::Placement::SetAffinity ( Aws::String &&  value)
inline

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 142 of file Placement.h.

◆ SetAffinity() [2/3]

void Aws::EC2::Model::Placement::SetAffinity ( const Aws::String value)
inline

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 133 of file Placement.h.

◆ SetAffinity() [3/3]

void Aws::EC2::Model::Placement::SetAffinity ( const char *  value)
inline

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 151 of file Placement.h.

◆ SetAvailabilityZone() [1/3]

void Aws::EC2::Model::Placement::SetAvailabilityZone ( Aws::String &&  value)
inline

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 by CreateFleet.

Definition at line 73 of file Placement.h.

◆ SetAvailabilityZone() [2/3]

void Aws::EC2::Model::Placement::SetAvailabilityZone ( const Aws::String value)
inline

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 by CreateFleet.

Definition at line 65 of file Placement.h.

◆ SetAvailabilityZone() [3/3]

void Aws::EC2::Model::Placement::SetAvailabilityZone ( const char *  value)
inline

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 by CreateFleet.

Definition at line 81 of file Placement.h.

◆ SetGroupName() [1/3]

void Aws::EC2::Model::Placement::SetGroupName ( Aws::String &&  value)
inline

The name of the placement group the instance is in.

Definition at line 199 of file Placement.h.

◆ SetGroupName() [2/3]

void Aws::EC2::Model::Placement::SetGroupName ( const Aws::String value)
inline

The name of the placement group the instance is in.

Definition at line 194 of file Placement.h.

◆ SetGroupName() [3/3]

void Aws::EC2::Model::Placement::SetGroupName ( const char *  value)
inline

The name of the placement group the instance is in.

Definition at line 204 of file Placement.h.

◆ SetHostId() [1/3]

void Aws::EC2::Model::Placement::SetHostId ( Aws::String &&  value)
inline

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 289 of file Placement.h.

◆ SetHostId() [2/3]

void Aws::EC2::Model::Placement::SetHostId ( const Aws::String value)
inline

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 280 of file Placement.h.

◆ SetHostId() [3/3]

void Aws::EC2::Model::Placement::SetHostId ( const char *  value)
inline

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 298 of file Placement.h.

◆ SetHostResourceGroupArn() [1/3]

void Aws::EC2::Model::Placement::SetHostResourceGroupArn ( Aws::String &&  value)
inline

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

Definition at line 468 of file Placement.h.

◆ SetHostResourceGroupArn() [2/3]

void Aws::EC2::Model::Placement::SetHostResourceGroupArn ( const Aws::String value)
inline

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

Definition at line 460 of file Placement.h.

◆ SetHostResourceGroupArn() [3/3]

void Aws::EC2::Model::Placement::SetHostResourceGroupArn ( const char *  value)
inline

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

Definition at line 476 of file Placement.h.

◆ SetPartitionNumber()

void Aws::EC2::Model::Placement::SetPartitionNumber ( int  value)
inline

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

This parameter is not supported by CreateFleet.

Definition at line 244 of file Placement.h.

◆ SetSpreadDomain() [1/3]

void Aws::EC2::Model::Placement::SetSpreadDomain ( Aws::String &&  value)
inline

Reserved for future use.

This parameter is not supported by CreateFleet.

Definition at line 411 of file Placement.h.

◆ SetSpreadDomain() [2/3]

void Aws::EC2::Model::Placement::SetSpreadDomain ( const Aws::String value)
inline

Reserved for future use.

This parameter is not supported by CreateFleet.

Definition at line 405 of file Placement.h.

◆ SetSpreadDomain() [3/3]

void Aws::EC2::Model::Placement::SetSpreadDomain ( const char *  value)
inline

Reserved for future use.

This parameter is not supported by CreateFleet.

Definition at line 417 of file Placement.h.

◆ SetTenancy() [1/2]

void Aws::EC2::Model::Placement::SetTenancy ( const Tenancy value)
inline

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. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 356 of file Placement.h.

◆ SetTenancy() [2/2]

void Aws::EC2::Model::Placement::SetTenancy ( Tenancy &&  value)
inline

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. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 366 of file Placement.h.

◆ SpreadDomainHasBeenSet()

bool Aws::EC2::Model::Placement::SpreadDomainHasBeenSet ( ) const
inline

Reserved for future use.

This parameter is not supported by CreateFleet.

Definition at line 399 of file Placement.h.

◆ TenancyHasBeenSet()

bool Aws::EC2::Model::Placement::TenancyHasBeenSet ( ) const
inline

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. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 346 of file Placement.h.

◆ WithAffinity() [1/3]

Placement& Aws::EC2::Model::Placement::WithAffinity ( Aws::String &&  value)
inline

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 169 of file Placement.h.

◆ WithAffinity() [2/3]

Placement& Aws::EC2::Model::Placement::WithAffinity ( const Aws::String value)
inline

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 160 of file Placement.h.

◆ WithAffinity() [3/3]

Placement& Aws::EC2::Model::Placement::WithAffinity ( const char *  value)
inline

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 178 of file Placement.h.

◆ WithAvailabilityZone() [1/3]

Placement& Aws::EC2::Model::Placement::WithAvailabilityZone ( Aws::String &&  value)
inline

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 by CreateFleet.

Definition at line 97 of file Placement.h.

◆ WithAvailabilityZone() [2/3]

Placement& Aws::EC2::Model::Placement::WithAvailabilityZone ( const Aws::String value)
inline

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 by CreateFleet.

Definition at line 89 of file Placement.h.

◆ WithAvailabilityZone() [3/3]

Placement& Aws::EC2::Model::Placement::WithAvailabilityZone ( const char *  value)
inline

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 by CreateFleet.

Definition at line 105 of file Placement.h.

◆ WithGroupName() [1/3]

Placement& Aws::EC2::Model::Placement::WithGroupName ( Aws::String &&  value)
inline

The name of the placement group the instance is in.

Definition at line 214 of file Placement.h.

◆ WithGroupName() [2/3]

Placement& Aws::EC2::Model::Placement::WithGroupName ( const Aws::String value)
inline

The name of the placement group the instance is in.

Definition at line 209 of file Placement.h.

◆ WithGroupName() [3/3]

Placement& Aws::EC2::Model::Placement::WithGroupName ( const char *  value)
inline

The name of the placement group the instance is in.

Definition at line 219 of file Placement.h.

◆ WithHostId() [1/3]

Placement& Aws::EC2::Model::Placement::WithHostId ( Aws::String &&  value)
inline

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 316 of file Placement.h.

◆ WithHostId() [2/3]

Placement& Aws::EC2::Model::Placement::WithHostId ( const Aws::String value)
inline

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 307 of file Placement.h.

◆ WithHostId() [3/3]

Placement& Aws::EC2::Model::Placement::WithHostId ( const char *  value)
inline

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 325 of file Placement.h.

◆ WithHostResourceGroupArn() [1/3]

Placement& Aws::EC2::Model::Placement::WithHostResourceGroupArn ( Aws::String &&  value)
inline

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

Definition at line 492 of file Placement.h.

◆ WithHostResourceGroupArn() [2/3]

Placement& Aws::EC2::Model::Placement::WithHostResourceGroupArn ( const Aws::String value)
inline

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

Definition at line 484 of file Placement.h.

◆ WithHostResourceGroupArn() [3/3]

Placement& Aws::EC2::Model::Placement::WithHostResourceGroupArn ( const char *  value)
inline

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

Definition at line 500 of file Placement.h.

◆ WithPartitionNumber()

Placement& Aws::EC2::Model::Placement::WithPartitionNumber ( int  value)
inline

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

This parameter is not supported by CreateFleet.

Definition at line 252 of file Placement.h.

◆ WithSpreadDomain() [1/3]

Placement& Aws::EC2::Model::Placement::WithSpreadDomain ( Aws::String &&  value)
inline

Reserved for future use.

This parameter is not supported by CreateFleet.

Definition at line 429 of file Placement.h.

◆ WithSpreadDomain() [2/3]

Placement& Aws::EC2::Model::Placement::WithSpreadDomain ( const Aws::String value)
inline

Reserved for future use.

This parameter is not supported by CreateFleet.

Definition at line 423 of file Placement.h.

◆ WithSpreadDomain() [3/3]

Placement& Aws::EC2::Model::Placement::WithSpreadDomain ( const char *  value)
inline

Reserved for future use.

This parameter is not supported by CreateFleet.

Definition at line 435 of file Placement.h.

◆ WithTenancy() [1/2]

Placement& Aws::EC2::Model::Placement::WithTenancy ( const Tenancy value)
inline

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. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 376 of file Placement.h.

◆ WithTenancy() [2/2]

Placement& Aws::EC2::Model::Placement::WithTenancy ( Tenancy &&  value)
inline

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. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

Definition at line 386 of file Placement.h.


The documentation for this class was generated from the following file: