Package software.amazon.awscdk.services.ec2

Class CfnCapacityReservation.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.CfnCapacityReservation.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCapacityReservation>
Enclosing class:
CfnCapacityReservation
@Stability(Stable) public static final class CfnCapacityReservation.Builder extends Object implements software.amazon.jsii.Builder<CfnCapacityReservation>
A fluent builder for CfnCapacityReservation.

  • Method Details

    • create

      @Stability(Stable) public static CfnCapacityReservation.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnCapacityReservation.Builder.

    • availabilityZone

      @Stability(Stable) public CfnCapacityReservation.Builder availabilityZone(String availabilityZone)
      The Availability Zone in which to create the Capacity Reservation.

      Parameters:
      availabilityZone - The Availability Zone in which to create the Capacity Reservation. This parameter is required.
      Returns:
      this

    • instanceCount

      @Stability(Stable) public CfnCapacityReservation.Builder instanceCount(Number instanceCount)
      The number of instances for which to reserve capacity.

      Valid range: 1 - 1000

      Parameters:
      instanceCount - The number of instances for which to reserve capacity. This parameter is required.
      Returns:
      this

    • instancePlatform

      @Stability(Stable) public CfnCapacityReservation.Builder instancePlatform(String instancePlatform)
      The type of operating system for which to reserve capacity.

      Parameters:
      instancePlatform - The type of operating system for which to reserve capacity. This parameter is required.
      Returns:
      this

    • instanceType

      @Stability(Stable) public CfnCapacityReservation.Builder instanceType(String instanceType)
      The instance type for which to reserve capacity.

      For more information, see Instance types in the Amazon EC2 User Guide .

      Parameters:
      instanceType - The instance type for which to reserve capacity. This parameter is required.
      Returns:
      this

    • ebsOptimized

      @Stability(Stable) public CfnCapacityReservation.Builder ebsOptimized(Boolean ebsOptimized)
      Indicates whether the Capacity Reservation supports EBS-optimized instances.

      This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

      Parameters:
      ebsOptimized - Indicates whether the Capacity Reservation supports EBS-optimized instances. This parameter is required.
      Returns:
      this

    • ebsOptimized

      @Stability(Stable) public CfnCapacityReservation.Builder ebsOptimized(IResolvable ebsOptimized)
      Indicates whether the Capacity Reservation supports EBS-optimized instances.

      This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

      Parameters:
      ebsOptimized - Indicates whether the Capacity Reservation supports EBS-optimized instances. This parameter is required.
      Returns:
      this

    • endDate

      @Stability(Stable) public CfnCapacityReservation.Builder endDate(String endDate)
      The date and time at which the Capacity Reservation expires.

      When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

      You must provide an EndDate value if EndDateType is limited . Omit EndDate if EndDateType is unlimited .

      If the EndDateType is limited , the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

      Parameters:
      endDate - The date and time at which the Capacity Reservation expires. This parameter is required.
      Returns:
      this

    • endDateType

      @Stability(Stable) public CfnCapacityReservation.Builder endDateType(String endDateType)
      Indicates the way in which the Capacity Reservation ends.

      A Capacity Reservation can have one of the following end types:

      • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited .
      • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited .

      Parameters:
      endDateType - Indicates the way in which the Capacity Reservation ends. This parameter is required.
      Returns:
      this

    • ephemeralStorage

      @Stability(Stable) public CfnCapacityReservation.Builder ephemeralStorage(Boolean ephemeralStorage)
      Deprecated..

      Parameters:
      ephemeralStorage - Deprecated.. This parameter is required.
      Returns:
      this

    • ephemeralStorage

      @Stability(Stable) public CfnCapacityReservation.Builder ephemeralStorage(IResolvable ephemeralStorage)
      Deprecated..

      Parameters:
      ephemeralStorage - Deprecated.. This parameter is required.
      Returns:
      this

    • instanceMatchCriteria

      @Stability(Stable) public CfnCapacityReservation.Builder instanceMatchCriteria(String instanceMatchCriteria)
      Indicates the type of instance launches that the Capacity Reservation accepts. The options include:.

      • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
      • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

      Default: open

      Parameters:
      instanceMatchCriteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:. This parameter is required.
      Returns:
      this

    • outPostArn

      @Stability(Stable) public CfnCapacityReservation.Builder outPostArn(String outPostArn)
      The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

      Parameters:
      outPostArn - The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation. This parameter is required.
      Returns:
      this

    • placementGroupArn

      @Stability(Stable) public CfnCapacityReservation.Builder placementGroupArn(String placementGroupArn)
      The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.

      For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide .

      Parameters:
      placementGroupArn - The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. This parameter is required.
      Returns:
      this

    • tagSpecifications

      @Stability(Stable) public CfnCapacityReservation.Builder tagSpecifications(IResolvable tagSpecifications)
      The tags to apply to the Capacity Reservation during launch.

      Parameters:
      tagSpecifications - The tags to apply to the Capacity Reservation during launch. This parameter is required.
      Returns:
      this

    • tagSpecifications

      @Stability(Stable) public CfnCapacityReservation.Builder tagSpecifications(List<? extends Object> tagSpecifications)
      The tags to apply to the Capacity Reservation during launch.

      Parameters:
      tagSpecifications - The tags to apply to the Capacity Reservation during launch. This parameter is required.
      Returns:
      this

    • tenancy

      @Stability(Stable) public CfnCapacityReservation.Builder tenancy(String tenancy)
      Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:.

      • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts .
      • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .

      Parameters:
      tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnCapacityReservation build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnCapacityReservation>
      Returns:
      a newly built instance of CfnCapacityReservation.