software.amazon.awscdk.services.ec2

Class CfnHost

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ec2.CfnHost

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.413Z")
public class CfnHost
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::Host`.

Allocates a fully dedicated physical server for launching EC2 instances. Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see Dedicated Hosts in the Amazon EC2 User Guide for Linux Instances .

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.*;
 CfnHost cfnHost = CfnHost.Builder.create(this, "MyCfnHost")
         .availabilityZone("availabilityZone")
         // the properties below are optional
         .autoPlacement("autoPlacement")
         .hostRecovery("hostRecovery")
         .instanceFamily("instanceFamily")
         .instanceType("instanceType")
         .outpostArn("outpostArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnHost.Builder A fluent builder for CfnHost.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnHost(Construct scope, java.lang.String id, CfnHostProps props) Create a new `AWS::EC2::Host`.
protected	CfnHost(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnHost(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrHostId() The ID of the host.
java.lang.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.
java.lang.String	getAvailabilityZone() The Availability Zone in which to allocate the Dedicated Host.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getHostRecovery() Indicates whether to enable or disable host recovery for the Dedicated Host.
java.lang.String	getInstanceFamily() The instance family supported by the Dedicated Host.
java.lang.String	getInstanceType() Specifies the instance type to be supported by the Dedicated Hosts.
java.lang.String	getOutpostArn() The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAutoPlacement(java.lang.String value) 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.
void	setAvailabilityZone(java.lang.String value) The Availability Zone in which to allocate the Dedicated Host.
void	setHostRecovery(java.lang.String value) Indicates whether to enable or disable host recovery for the Dedicated Host.
void	setInstanceFamily(java.lang.String value) The instance family supported by the Dedicated Host.
void	setInstanceType(java.lang.String value) Specifies the instance type to be supported by the Dedicated Hosts.
void	setOutpostArn(java.lang.String value) The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnHost

protected CfnHost(software.amazon.jsii.JsiiObjectRef objRef)

CfnHost

protected CfnHost(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnHost

public CfnHost(Construct scope,
               java.lang.String id,
               CfnHostProps props)

Create a new `AWS::EC2::Host`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrHostId

public java.lang.String getAttrHostId()

The ID of the host.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAvailabilityZone

public java.lang.String getAvailabilityZone()

The Availability Zone in which to allocate the Dedicated Host.

setAvailabilityZone

public void setAvailabilityZone(java.lang.String value)

The Availability Zone in which to allocate the Dedicated Host.

getAutoPlacement

public java.lang.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: on

setAutoPlacement

public void setAutoPlacement(java.lang.String value)

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

getHostRecovery

public java.lang.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

setHostRecovery

public void setHostRecovery(java.lang.String value)

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

getInstanceFamily

public java.lang.String getInstanceFamily()

The instance family supported by the Dedicated Host.

For example, m5 .

setInstanceFamily

public void setInstanceFamily(java.lang.String value)

The instance family supported by the Dedicated Host.

For example, m5 .

getInstanceType

public java.lang.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.

setInstanceType

public void setInstanceType(java.lang.String value)

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.

getOutpostArn

public java.lang.String getOutpostArn()

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

setOutpostArn

public void setOutpostArn(java.lang.String value)

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