Class CfnHost
A CloudFormation AWS::EC2::Host
.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnHost : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnHost
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::EC2::Host
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnHost = new CfnHost(this, "MyCfnHost", new CfnHostProps {
AvailabilityZone = "availabilityZone",
// the properties below are optional
AutoPlacement = "autoPlacement",
HostMaintenance = "hostMaintenance",
HostRecovery = "hostRecovery",
InstanceFamily = "instanceFamily",
InstanceType = "instanceType",
OutpostArn = "outpostArn"
});
Synopsis
Constructors
CfnHost(Construct, String, ICfnHostProps) | Create a new |
CfnHost(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnHost(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrHostId | The ID of the host. |
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. |
AvailabilityZone | The Availability Zone in which to allocate the Dedicated Host. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
HostMaintenance | Indicates whether host maintenance is enabled or disabled for the Dedicated Host. |
HostRecovery | Indicates whether to enable or disable host recovery for the Dedicated Host. |
InstanceFamily | The instance family supported by the Dedicated Host. |
InstanceType | Specifies the instance type to be supported by the Dedicated Hosts. |
OutpostArn | The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnHost(Construct, String, ICfnHostProps)
Create a new AWS::EC2::Host
.
public CfnHost(Construct scope, string id, ICfnHostProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnHostProps
- resource properties.
CfnHost(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnHost(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnHost(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnHost(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrHostId
The ID of the host.
public virtual string AttrHostId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: HostId
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.
public virtual string AutoPlacement { get; set; }
Property Value
System.String
Remarks
For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide .
Default: on
AvailabilityZone
The Availability Zone in which to allocate the Dedicated Host.
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
HostMaintenance
Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
public virtual string HostMaintenance { get; set; }
Property Value
System.String
Remarks
HostRecovery
Indicates whether to enable or disable host recovery for the Dedicated Host.
public virtual string HostRecovery { get; set; }
Property Value
System.String
Remarks
Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide .
Default: off
InstanceFamily
The instance family supported by the Dedicated Host.
public virtual string InstanceFamily { get; set; }
Property Value
System.String
Remarks
InstanceType
Specifies the instance type to be supported by the Dedicated Hosts.
public virtual string InstanceType { get; set; }
Property Value
System.String
Remarks
If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
OutpostArn
The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.
public virtual string OutpostArn { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>