Class CfnCapacityReservationFleetProps

Properties for defining a CfnCapacityReservationFleet.

Inheritance

object

CfnCapacityReservationFleetProps

Implements

ICfnCapacityReservationFleetProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCapacityReservationFleetProps : ICfnCapacityReservationFleetProps

Syntax (vb)

Public Class CfnCapacityReservationFleetProps Implements ICfnCapacityReservationFleetProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.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 cfnCapacityReservationFleetProps = new CfnCapacityReservationFleetProps {
                 AllocationStrategy = "allocationStrategy",
                 EndDate = "endDate",
                 InstanceMatchCriteria = "instanceMatchCriteria",
                 InstanceTypeSpecifications = new [] { new InstanceTypeSpecificationProperty {
                     AvailabilityZone = "availabilityZone",
                     AvailabilityZoneId = "availabilityZoneId",
                     EbsOptimized = false,
                     InstancePlatform = "instancePlatform",
                     InstanceType = "instanceType",
                     Priority = 123,
                     Weight = 123
                 } },
                 NoRemoveEndDate = false,
                 RemoveEndDate = false,
                 TagSpecifications = new [] { new TagSpecificationProperty {
                     ResourceType = "resourceType",
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } }
                 } },
                 Tenancy = "tenancy",
                 TotalTargetCapacity = 123
             };

Synopsis

Constructors

CfnCapacityReservationFleetProps()

Properties for defining a CfnCapacityReservationFleet.

Properties

AllocationStrategy	The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.
EndDate	The date and time at which the Capacity Reservation Fleet expires.
InstanceMatchCriteria	Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
InstanceTypeSpecifications	Information about the instance types for which to reserve the capacity.
NoRemoveEndDate	Used to add an end date to a Capacity Reservation Fleet that has no end date and time.
RemoveEndDate	Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time.
TagSpecifications	The tags to assign to the Capacity Reservation Fleet.
Tenancy	Indicates the tenancy of the Capacity Reservation Fleet.
TotalTargetCapacity	The total number of capacity units to be reserved by the Capacity Reservation Fleet.

Constructors

CfnCapacityReservationFleetProps()

Properties for defining a CfnCapacityReservationFleet.

public CfnCapacityReservationFleetProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.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 cfnCapacityReservationFleetProps = new CfnCapacityReservationFleetProps {
                 AllocationStrategy = "allocationStrategy",
                 EndDate = "endDate",
                 InstanceMatchCriteria = "instanceMatchCriteria",
                 InstanceTypeSpecifications = new [] { new InstanceTypeSpecificationProperty {
                     AvailabilityZone = "availabilityZone",
                     AvailabilityZoneId = "availabilityZoneId",
                     EbsOptimized = false,
                     InstancePlatform = "instancePlatform",
                     InstanceType = "instanceType",
                     Priority = 123,
                     Weight = 123
                 } },
                 NoRemoveEndDate = false,
                 RemoveEndDate = false,
                 TagSpecifications = new [] { new TagSpecificationProperty {
                     ResourceType = "resourceType",
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } }
                 } },
                 Tenancy = "tenancy",
                 TotalTargetCapacity = 123
             };

Properties

AllocationStrategy

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.

public string? AllocationStrategy { get; set; }

Property Value

string

Remarks

Currently, only the prioritized allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide .

Valid values: prioritized

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-allocationstrategy

EndDate

The date and time at which the Capacity Reservation Fleet expires.

public string? EndDate { get; set; }

Property Value

string

Remarks

When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019 , 13:30:55 , the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-enddate

InstanceMatchCriteria

Indicates the type of instance launches that the Capacity Reservation Fleet accepts.

public string? InstanceMatchCriteria { get; set; }

Property Value

string

Remarks

All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancematchcriteria

InstanceTypeSpecifications

Information about the instance types for which to reserve the capacity.

public object? InstanceTypeSpecifications { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-instancetypespecifications

Type union: either IResolvable or (either IResolvable or CfnCapacityReservationFleet.IInstanceTypeSpecificationProperty)[]

NoRemoveEndDate

Used to add an end date to a Capacity Reservation Fleet that has no end date and time.

public object? NoRemoveEndDate { get; set; }

Property Value

object

Remarks

To add an end date to a Capacity Reservation Fleet, specify true for this paramater and specify the end date and time (in UTC time format) for the EndDate parameter.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-noremoveenddate

Type union: either bool or IResolvable

RemoveEndDate

Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time.

public object? RemoveEndDate { get; set; }

Property Value

object

Remarks

To remove the end date from a Capacity Reservation Fleet, specify true for this paramater and omit the EndDate parameter.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-removeenddate

Type union: either bool or IResolvable

TagSpecifications

The tags to assign to the Capacity Reservation Fleet.

public CfnCapacityReservationFleet.ITagSpecificationProperty[]? TagSpecifications { get; set; }

Property Value

ITagSpecificationProperty[]

Remarks

The tags are automatically assigned to the Capacity Reservations in the Fleet.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tagspecifications

Tenancy

Indicates the tenancy of the Capacity Reservation Fleet.

public string? Tenancy { get; set; }

Property Value

string

Remarks

All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tenancy

TotalTargetCapacity

The total number of capacity units to be reserved by the Capacity Reservation Fleet.

public double? TotalTargetCapacity { get; set; }

Property Value

double?

Remarks

This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-totaltargetcapacity

Implements

ICfnCapacityReservationFleetProps