Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnCapacityReservationMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnCapacityReservationMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCapacityReservationMixinProps>

Enclosing interface:

CfnCapacityReservationMixinProps

@Stability(Stable)
public static final class CfnCapacityReservationMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCapacityReservationMixinProps>

A builder for CfnCapacityReservationMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCapacityReservationMixinProps.Builder	availabilityZone(String availabilityZone)	Sets the value of CfnCapacityReservationMixinProps.getAvailabilityZone()
CfnCapacityReservationMixinProps.Builder	availabilityZoneId(String availabilityZoneId)	Sets the value of CfnCapacityReservationMixinProps.getAvailabilityZoneId()
CfnCapacityReservationMixinProps	build()	Builds the configured instance.
CfnCapacityReservationMixinProps.Builder	ebsOptimized(Boolean ebsOptimized)	Sets the value of CfnCapacityReservationMixinProps.getEbsOptimized()
CfnCapacityReservationMixinProps.Builder	ebsOptimized(IResolvable ebsOptimized)	Sets the value of CfnCapacityReservationMixinProps.getEbsOptimized()
CfnCapacityReservationMixinProps.Builder	endDate(String endDate)	Sets the value of CfnCapacityReservationMixinProps.getEndDate()
CfnCapacityReservationMixinProps.Builder	endDateType(String endDateType)	Sets the value of CfnCapacityReservationMixinProps.getEndDateType()
CfnCapacityReservationMixinProps.Builder	ephemeralStorage(Boolean ephemeralStorage)	Sets the value of CfnCapacityReservationMixinProps.getEphemeralStorage()
CfnCapacityReservationMixinProps.Builder	ephemeralStorage(IResolvable ephemeralStorage)	Sets the value of CfnCapacityReservationMixinProps.getEphemeralStorage()
CfnCapacityReservationMixinProps.Builder	instanceCount(Number instanceCount)	Sets the value of CfnCapacityReservationMixinProps.getInstanceCount()
CfnCapacityReservationMixinProps.Builder	instanceMatchCriteria(String instanceMatchCriteria)	Sets the value of CfnCapacityReservationMixinProps.getInstanceMatchCriteria()
CfnCapacityReservationMixinProps.Builder	instancePlatform(String instancePlatform)	Sets the value of CfnCapacityReservationMixinProps.getInstancePlatform()
CfnCapacityReservationMixinProps.Builder	instanceType(String instanceType)	Sets the value of CfnCapacityReservationMixinProps.getInstanceType()
CfnCapacityReservationMixinProps.Builder	outPostArn(String outPostArn)	Sets the value of CfnCapacityReservationMixinProps.getOutPostArn()
CfnCapacityReservationMixinProps.Builder	placementGroupArn(String placementGroupArn)	Sets the value of CfnCapacityReservationMixinProps.getPlacementGroupArn()
CfnCapacityReservationMixinProps.Builder	tagSpecifications(List<? extends Object> tagSpecifications)	Sets the value of CfnCapacityReservationMixinProps.getTagSpecifications()
CfnCapacityReservationMixinProps.Builder	tagSpecifications(IResolvable tagSpecifications)	Sets the value of CfnCapacityReservationMixinProps.getTagSpecifications()
CfnCapacityReservationMixinProps.Builder	tenancy(String tenancy)	Sets the value of CfnCapacityReservationMixinProps.getTenancy()
CfnCapacityReservationMixinProps.Builder	unusedReservationBillingOwnerId(String unusedReservationBillingOwnerId)	Sets the value of CfnCapacityReservationMixinProps.getUnusedReservationBillingOwnerId()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

availabilityZone

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder availabilityZone(String availabilityZone)

Sets the value of CfnCapacityReservationMixinProps.getAvailabilityZone()

Parameters:

availabilityZone - The Availability Zone in which to create the Capacity Reservation.

Returns:

this

availabilityZoneId

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder availabilityZoneId(String availabilityZoneId)

Sets the value of CfnCapacityReservationMixinProps.getAvailabilityZoneId()

Parameters:

availabilityZoneId - The ID of the Availability Zone in which the capacity is reserved.

Returns:

this

ebsOptimized

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder ebsOptimized(Boolean ebsOptimized)

Sets the value of CfnCapacityReservationMixinProps.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 CfnCapacityReservationMixinProps.Builder ebsOptimized(IResolvable ebsOptimized)

Sets the value of CfnCapacityReservationMixinProps.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 CfnCapacityReservationMixinProps.Builder endDate(String endDate)

Sets the value of CfnCapacityReservationMixinProps.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 CfnCapacityReservationMixinProps.Builder endDateType(String endDateType)

Sets the value of CfnCapacityReservationMixinProps.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 CfnCapacityReservationMixinProps.Builder ephemeralStorage(Boolean ephemeralStorage)

Sets the value of CfnCapacityReservationMixinProps.getEphemeralStorage()

Parameters:

ephemeralStorage - Deprecated..

Returns:

this

ephemeralStorage

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder ephemeralStorage(IResolvable ephemeralStorage)

Sets the value of CfnCapacityReservationMixinProps.getEphemeralStorage()

Parameters:

ephemeralStorage - Deprecated..

Returns:

this

instanceCount

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder instanceCount(Number instanceCount)

Sets the value of CfnCapacityReservationMixinProps.getInstanceCount()

Parameters:

instanceCount - The number of instances for which to reserve capacity.

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

Valid range: 1 - 1000

Returns:

this

instanceMatchCriteria

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder instanceMatchCriteria(String instanceMatchCriteria)

Sets the value of CfnCapacityReservationMixinProps.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

instancePlatform

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder instancePlatform(String instancePlatform)

Sets the value of CfnCapacityReservationMixinProps.getInstancePlatform()

Parameters:

instancePlatform - The type of operating system for which to reserve capacity.

Returns:

this

instanceType

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder instanceType(String instanceType)

Sets the value of CfnCapacityReservationMixinProps.getInstanceType()

Parameters:

instanceType - The instance type for which to reserve capacity.

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

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

Returns:

this

outPostArn

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder outPostArn(String outPostArn)

Sets the value of CfnCapacityReservationMixinProps.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 CfnCapacityReservationMixinProps.Builder placementGroupArn(String placementGroupArn)

Sets the value of CfnCapacityReservationMixinProps.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 CfnCapacityReservationMixinProps.Builder tagSpecifications(IResolvable tagSpecifications)

Sets the value of CfnCapacityReservationMixinProps.getTagSpecifications()

Parameters:

tagSpecifications - The tags to apply to the Capacity Reservation during launch.

Returns:

this

tagSpecifications

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder tagSpecifications(List<? extends Object> tagSpecifications)

Sets the value of CfnCapacityReservationMixinProps.getTagSpecifications()

Parameters:

tagSpecifications - The tags to apply to the Capacity Reservation during launch.

Returns:

this

tenancy

@Stability(Stable)
public CfnCapacityReservationMixinProps.Builder tenancy(String tenancy)

Sets the value of CfnCapacityReservationMixinProps.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 CfnCapacityReservationMixinProps.Builder unusedReservationBillingOwnerId(String unusedReservationBillingOwnerId)

Sets the value of CfnCapacityReservationMixinProps.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 CfnCapacityReservationMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCapacityReservationMixinProps>

Returns:

a new instance of CfnCapacityReservationMixinProps

Throws:

NullPointerException - if any required attribute was not provided