Interface CfnHostProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnHostProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.571Z") @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
         .autoPlacement("autoPlacement")
         .hostMaintenance("hostMaintenance")
         .hostRecovery("hostRecovery")
         .instanceFamily("instanceFamily")
         .instanceType("instanceType")
         .outpostArn("outpostArn")
         .build();
 
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder for CfnHostProps
    static final class 
    An implementation for CfnHostProps
  • Method Summary

    Modifier and Type
    Method
    Description
     
    default String
    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.
    The Availability Zone in which to allocate the Dedicated Host.
    default String
    Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
    default String
    Indicates whether to enable or disable host recovery for the Dedicated Host.
    default String
    The instance family supported by the Dedicated Host.
    default String
    Specifies the instance type to be supported by the Dedicated Hosts.
    default String
    The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.

    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.
    • 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: on

    • getHostMaintenance

      @Stability(Stable) @Nullable default String getHostMaintenance()
      Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
    • 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

    • getInstanceFamily

      @Stability(Stable) @Nullable default String getInstanceFamily()
      The instance family supported by the Dedicated Host.

      For example, m5 .

    • 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.

    • getOutpostArn

      @Stability(Stable) @Nullable default String getOutpostArn()
      The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.
    • builder

      @Stability(Stable) static CfnHostProps.Builder builder()
      Returns:
      a CfnHostProps.Builder of CfnHostProps