Struct aws_sdk_ec2::operation::allocate_hosts::AllocateHostsInput

#[non_exhaustive]
pub struct AllocateHostsInput {
    pub auto_placement: Option<AutoPlacement>,
    pub availability_zone: Option<String>,
    pub client_token: Option<String>,
    pub instance_type: Option<String>,
    pub instance_family: Option<String>,
    pub quantity: Option<i32>,
    pub tag_specifications: Option<Vec<TagSpecification>>,
    pub host_recovery: Option<HostRecovery>,
    pub outpost_arn: Option<String>,
    pub host_maintenance: Option<HostMaintenance>,
    pub asset_ids: Option<Vec<String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

auto_placement: Option<AutoPlacement>

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. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

availability_zone: Option<String>

The Availability Zone in which to allocate the Dedicated Host.

client_token: Option<String>

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

instance_type: Option<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.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

instance_family: Option<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.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

quantity: Option<i32>

The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.

tag_specifications: Option<Vec<TagSpecification>>

The tags to apply to the Dedicated Host during creation.

host_recovery: Option<HostRecovery>

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

outpost_arn: Option<String>

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.

If you are allocating the Dedicated Host in a Region, omit this parameter.

host_maintenance: Option<HostMaintenance>

Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

asset_ids: Option<Vec<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 OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

• If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

• If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

Implementations

impl AllocateHostsInput

pub fn auto_placement(&self) -> Option<&AutoPlacement>

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. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

pub fn availability_zone(&self) -> Option<&str>

The Availability Zone in which to allocate the Dedicated Host.

pub fn client_token(&self) -> Option<&str>

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

pub fn instance_type(&self) -> Option<&str>

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.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

pub fn instance_family(&self) -> Option<&str>

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.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

pub fn quantity(&self) -> Option<i32>

The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.

pub fn tag_specifications(&self) -> &[TagSpecification]

The tags to apply to the Dedicated Host during creation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_specifications.is_none().

pub fn host_recovery(&self) -> Option<&HostRecovery>

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

pub fn outpost_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.

If you are allocating the Dedicated Host in a Region, omit this parameter.

pub fn host_maintenance(&self) -> Option<&HostMaintenance>

Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

pub fn asset_ids(&self) -> &[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 OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

• If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

• If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .asset_ids.is_none().

impl AllocateHostsInput

pub fn builder() -> AllocateHostsInputBuilder

Creates a new builder-style object to manufacture AllocateHostsInput.

Trait Implementations

impl Clone for AllocateHostsInput

fn clone(&self) -> AllocateHostsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AllocateHostsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AllocateHostsInput

fn eq(&self, other: &AllocateHostsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AllocateHostsInput