Package software.amazon.awscdk.services.ec2

Interface CfnHostProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnHostProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:36.800Z")
@Stability(Stable)
public interface CfnHostProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnHost.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnHostProps cfnHostProps = CfnHostProps.builder()
         .availabilityZone("availabilityZone")
         // the properties below are optional
         .assetId("assetId")
         .autoPlacement("autoPlacement")
         .hostMaintenance("hostMaintenance")
         .hostRecovery("hostRecovery")
         .instanceFamily("instanceFamily")
         .instanceType("instanceType")
         .outpostArn("outpostArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnHostProps.Builder	A builder for CfnHostProps
static final class	CfnHostProps.Jsii$Proxy	An implementation for CfnHostProps

Method Summary

Modifier and Type	Method	Description
static CfnHostProps.Builder	builder()
default String	getAssetId()	The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
default String	getAutoPlacement()	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.
String	getAvailabilityZone()	The Availability Zone in which to allocate the Dedicated Host.
default String	getHostMaintenance()	Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
default String	getHostRecovery()	Indicates whether to enable or disable host recovery for the Dedicated Host.
default String	getInstanceFamily()	The instance family supported by the Dedicated Host.
default String	getInstanceType()	Specifies the instance type to be supported by the Dedicated Hosts.
default String	getOutpostArn()	The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.
default List<CfnTag>	getTags()	Any tags assigned to the Dedicated Host.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZone

@Stability(Stable)
@NotNull
String getAvailabilityZone()

The Availability Zone in which to allocate the Dedicated Host.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-availabilityzone

getAssetId

@Stability(Stable)
@Nullable
default String getAssetId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-assetid

getAutoPlacement

@Stability(Stable)
@Nullable
default String getAutoPlacement()

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: off

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-autoplacement

getHostMaintenance

@Stability(Stable)
@Nullable
default String getHostMaintenance()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostmaintenance

getHostRecovery

@Stability(Stable)
@Nullable
default String getHostRecovery()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-hostrecovery

getInstanceFamily

@Stability(Stable)
@Nullable
default String getInstanceFamily()

The instance family supported by the Dedicated Host.

For example, m5 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancefamily

getInstanceType

@Stability(Stable)
@Nullable
default String getInstanceType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype

getOutpostArn

@Stability(Stable)
@Nullable
default String getOutpostArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-outpostarn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Any tags assigned to the Dedicated Host.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-tags

builder

@Stability(Stable)
static CfnHostProps.Builder builder()

Returns:

a CfnHostProps.Builder of CfnHostProps