Interface ICfnCapacityReservationProps

Properties for defining a CfnCapacityReservation.

Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnCapacityReservationProps
Syntax (vb)
Public Interface ICfnCapacityReservationProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.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 cfnCapacityReservationProps = new CfnCapacityReservationProps {
                 InstanceCount = 123,
                 InstancePlatform = "instancePlatform",
                 InstanceType = "instanceType",

                 // the properties below are optional
                 AvailabilityZone = "availabilityZone",
                 AvailabilityZoneId = "availabilityZoneId",
                 EbsOptimized = false,
                 EndDate = "endDate",
                 EndDateType = "endDateType",
                 EphemeralStorage = false,
                 InstanceMatchCriteria = "instanceMatchCriteria",
                 OutPostArn = "outPostArn",
                 PlacementGroupArn = "placementGroupArn",
                 TagSpecifications = new [] { new TagSpecificationProperty {
                     ResourceType = "resourceType",
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } }
                 } },
                 Tenancy = "tenancy",
                 UnusedReservationBillingOwnerId = "unusedReservationBillingOwnerId"
             };

Synopsis

Properties

AvailabilityZone

The Availability Zone in which to create the Capacity Reservation.
AvailabilityZoneId

The Availability Zone ID of the Capacity Reservation.
EbsOptimized

Indicates whether the Capacity Reservation supports EBS-optimized instances.
EndDate

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

Indicates the way in which the Capacity Reservation ends.
EphemeralStorage

Deprecated..
InstanceCount

The number of instances for which to reserve capacity.
InstanceMatchCriteria

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:.
InstancePlatform

The type of operating system for which to reserve capacity.
InstanceType

The instance type for which to reserve capacity.
OutPostArn

Not supported for future-dated Capacity Reservations.
PlacementGroupArn

Not supported for future-dated Capacity Reservations.
TagSpecifications

The tags to apply to the Capacity Reservation during launch.
Tenancy

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:.
UnusedReservationBillingOwnerId

The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation.

Properties

AvailabilityZone

The Availability Zone in which to create the Capacity Reservation.

string? AvailabilityZone { get; }
Property Value

string

Remarks

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

AvailabilityZoneId

The Availability Zone ID of the Capacity Reservation.

string? AvailabilityZoneId { get; }
Property Value

string

Remarks

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

EbsOptimized

Indicates whether the Capacity Reservation supports EBS-optimized instances.

object? EbsOptimized { get; }
Property Value

object

Remarks

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.

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

EndDate

The date and time at which the Capacity Reservation expires.

string? EndDate { get; }
Property Value

string

Remarks

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.

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

EndDateType

Indicates the way in which the Capacity Reservation ends.

string? EndDateType { get; }
Property Value

string

Remarks

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

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

    EphemeralStorage

    Deprecated..

    object? EphemeralStorage { get; }
    Property Value

    object

    Remarks

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

    InstanceCount

    The number of instances for which to reserve capacity.

    double InstanceCount { get; }
    Property Value

    double

    Remarks
    You can request future-dated Capacity Reservations for an instance count with a minimum of 64 vCPUs. For example, if you request a future-dated Capacity Reservation for <code>m5.xlarge</code> instances, you must request at least 25 instances ( <em>16 * m5.xlarge = 64 vCPUs</em> ).

    Valid range: 1 - 1000

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

    InstanceMatchCriteria

    Indicates the type of instance launches that the Capacity Reservation accepts. The options include:.

    string? InstanceMatchCriteria { get; }
    Property Value

    string

    Remarks
      If you are requesting a future-dated Capacity Reservation, you must specify <code>targeted</code> .

      Default: open

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

      InstancePlatform

      The type of operating system for which to reserve capacity.

      string InstancePlatform { get; }
      Property Value

      string

      Remarks

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

      InstanceType

      The instance type for which to reserve capacity.

      string InstanceType { get; }
      Property Value

      string

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

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

      OutPostArn

      Not supported for future-dated Capacity Reservations.

      string? OutPostArn { get; }
      Property Value

      string

      Remarks

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

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

      PlacementGroupArn

      Not supported for future-dated Capacity Reservations.

      string? PlacementGroupArn { get; }
      Property Value

      string

      Remarks

      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 .

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

      TagSpecifications

      The tags to apply to the Capacity Reservation during launch.

      CfnCapacityReservation.ITagSpecificationProperty[]? TagSpecifications { get; }
      Property Value

      ITagSpecificationProperty[]

      Remarks

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

      Tenancy

      Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:.

      string? Tenancy { get; }
      Property Value

      string

      Remarks

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

        UnusedReservationBillingOwnerId

        The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation.

        string? UnusedReservationBillingOwnerId { get; }
        Property Value

        string

        Remarks

        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 .

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