Package software.amazon.awscdk.services.ec2

Class CfnCapacityReservationProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • availabilityZone

      @Stability(Stable) public CfnCapacityReservationProps.Builder availabilityZone(String availabilityZone)
      Sets the value of CfnCapacityReservationProps.getAvailabilityZone()
      Parameters:
      availabilityZone - The Availability Zone in which to create the Capacity Reservation. This parameter is required.
      Returns:
      this

    • instanceCount

      @Stability(Stable) public CfnCapacityReservationProps.Builder instanceCount(Number instanceCount)
      Sets the value of CfnCapacityReservationProps.getInstanceCount()
      Parameters:
      instanceCount - The number of instances for which to reserve capacity. This parameter is required.

      You can request future-dated Capacity Reservations for an instance count with a minimum of 100 VPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances ( 25 * m5.xlarge = 100 vCPUs ).

      Valid range: 1 - 1000

      Returns:
      this

    • instancePlatform

      @Stability(Stable) public CfnCapacityReservationProps.Builder instancePlatform(String instancePlatform)
      Sets the value of CfnCapacityReservationProps.getInstancePlatform()
      Parameters:
      instancePlatform - The type of operating system for which to reserve capacity. This parameter is required.
      Returns:
      this

    • instanceType

      @Stability(Stable) public CfnCapacityReservationProps.Builder instanceType(String instanceType)
      Sets the value of CfnCapacityReservationProps.getInstanceType()
      Parameters:
      instanceType - The instance type for which to reserve capacity. This parameter is required.

      You can request future-dated Capacity Reservations for instance types in the C, M, R, I, and T instance families only.

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

      Returns:
      this

    • ebsOptimized

      @Stability(Stable) public CfnCapacityReservationProps.Builder ebsOptimized(Boolean ebsOptimized)
      Sets the value of CfnCapacityReservationProps.getEbsOptimized()
      Parameters:
      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.
      Returns:
      this

    • ebsOptimized

      @Stability(Stable) public CfnCapacityReservationProps.Builder ebsOptimized(IResolvable ebsOptimized)
      Sets the value of CfnCapacityReservationProps.getEbsOptimized()
      Parameters:
      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.
      Returns:
      this

    • endDate

      @Stability(Stable) public CfnCapacityReservationProps.Builder endDate(String endDate)
      Sets the value of CfnCapacityReservationProps.getEndDate()
      Parameters:
      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.

      If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

      Returns:
      this

    • endDateType

      @Stability(Stable) public CfnCapacityReservationProps.Builder endDateType(String endDateType)
      Sets the value of CfnCapacityReservationProps.getEndDateType()
      Parameters:
      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 .
      Returns:
      this

    • ephemeralStorage

      @Stability(Stable) public CfnCapacityReservationProps.Builder ephemeralStorage(Boolean ephemeralStorage)
      Sets the value of CfnCapacityReservationProps.getEphemeralStorage()
      Parameters:
      ephemeralStorage - Deprecated..
      Returns:
      this

    • ephemeralStorage

      @Stability(Stable) public CfnCapacityReservationProps.Builder ephemeralStorage(IResolvable ephemeralStorage)
      Sets the value of CfnCapacityReservationProps.getEphemeralStorage()
      Parameters:
      ephemeralStorage - Deprecated..
      Returns:
      this

    • instanceMatchCriteria

      @Stability(Stable) public CfnCapacityReservationProps.Builder instanceMatchCriteria(String instanceMatchCriteria)
      Sets the value of CfnCapacityReservationProps.getInstanceMatchCriteria()
      Parameters:
      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.

      If you are requesting a future-dated Capacity Reservation, you must specify targeted .

      Default: open

      Returns:
      this

    • outPostArn

      @Stability(Stable) public CfnCapacityReservationProps.Builder outPostArn(String outPostArn)
      Sets the value of CfnCapacityReservationProps.getOutPostArn()
      Parameters:
      outPostArn -

      Not supported for future-dated Capacity Reservations.

      The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
      Returns:
      this

    • placementGroupArn

      @Stability(Stable) public CfnCapacityReservationProps.Builder placementGroupArn(String placementGroupArn)
      Sets the value of CfnCapacityReservationProps.getPlacementGroupArn()
      Parameters:
      placementGroupArn -

      Not supported for future-dated Capacity Reservations.

      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 .
      Returns:
      this

    • tagSpecifications

      @Stability(Stable) public CfnCapacityReservationProps.Builder tagSpecifications(IResolvable tagSpecifications)
      Sets the value of CfnCapacityReservationProps.getTagSpecifications()
      Parameters:
      tagSpecifications - The tags to apply to the Capacity Reservation during launch.
      Returns:
      this

    • tagSpecifications

      @Stability(Stable) public CfnCapacityReservationProps.Builder tagSpecifications(List<? extends Object> tagSpecifications)
      Sets the value of CfnCapacityReservationProps.getTagSpecifications()
      Parameters:
      tagSpecifications - The tags to apply to the Capacity Reservation during launch.
      Returns:
      this

    • tenancy

      @Stability(Stable) public CfnCapacityReservationProps.Builder tenancy(String tenancy)
      Sets the value of CfnCapacityReservationProps.getTenancy()
      Parameters:
      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 .
      Returns:
      this

    • unusedReservationBillingOwnerId

      @Stability(Stable) public CfnCapacityReservationProps.Builder unusedReservationBillingOwnerId(String unusedReservationBillingOwnerId)
      Sets the value of CfnCapacityReservationProps.getUnusedReservationBillingOwnerId()
      Parameters:
      unusedReservationBillingOwnerId - The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation. A request will be sent to the specified account. That account must accept the request for the billing to be assigned to their account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations .

      You can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it to a resource share. For more information, see AWS::RAM::ResourceShare .

      Returns:
      this

    • build

      @Stability(Stable) public CfnCapacityReservationProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnCapacityReservationProps>
      Returns:
      a new instance of CfnCapacityReservationProps
      Throws:
      NullPointerException - if any required attribute was not provided