Class: AWSCDK::EC2::CfnCapacityReservation

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSEC2::ICapacityReservationRef
Defined in:
ec2/cfn_capacity_reservation.rb

Overview

Creates a new Capacity Reservation with the specified attributes.

For more information, see Capacity Reservations in the Amazon EC2 User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCapacityReservation

Create a new AWS::EC2::CapacityReservation.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EC2::CfnCapacityReservationProps) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'ec2/cfn_capacity_reservation.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnCapacityReservationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkNhcGFjaXR5UmVzZXJ2YXRpb25Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_capacity_reservation(resource) ⇒ String

Parameters:

Returns:

  • (String) 


101
102
103
104
 
# File 'ec2/cfn_capacity_reservation.rb', line 101

def self.arn_for_capacity_reservation(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUNhcGFjaXR5UmVzZXJ2YXRpb25SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnCapacityReservation", "arnForCapacityReservation", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


234
235
236
 
# File 'ec2/cfn_capacity_reservation.rb', line 234

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.CfnCapacityReservation", "CFN_RESOURCE_TYPE_NAME")
end

.from_capacity_reservation_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEC2::ICapacityReservationRef

Creates a new ICapacityReservationRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



112
113
114
115
116
117
 
# File 'ec2/cfn_capacity_reservation.rb', line 112

def self.from_capacity_reservation_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnCapacityReservation", "fromCapacityReservationArn", [scope, id, arn])
end

.from_capacity_reservation_id(scope, id, capacity_reservation_id) ⇒ AWSCDK::Interfaces::AWSEC2::ICapacityReservationRef

Creates a new ICapacityReservationRef from a capacityReservationId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • capacity_reservation_id (String)

Returns:



125
126
127
128
129
130
 
# File 'ec2/cfn_capacity_reservation.rb', line 125

def self.from_capacity_reservation_id(scope, id, capacity_reservation_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(capacity_reservation_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capacityReservationId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnCapacityReservation", "fromCapacityReservationId", [scope, id, capacity_reservation_id])
end

.is_cfn_capacity_reservation(x) ⇒ Boolean

Checks whether the given object is a CfnCapacityReservation.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


136
137
138
139
 
# File 'ec2/cfn_capacity_reservation.rb', line 136

def self.is_cfn_capacity_reservation(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnCapacityReservation", "isCfnCapacityReservation", [x])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'ec2/cfn_capacity_reservation.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_availability_zone => { kind: :property, name: "attrAvailabilityZone", is_optional: false },
    :attr_available_instance_count => { kind: :property, name: "attrAvailableInstanceCount", is_optional: false },
    :attr_capacity_allocation_set => { kind: :property, name: "attrCapacityAllocationSet", is_optional: false },
    :attr_capacity_reservation_arn => { kind: :property, name: "attrCapacityReservationArn", is_optional: false },
    :attr_capacity_reservation_fleet_id => { kind: :property, name: "attrCapacityReservationFleetId", is_optional: false },
    :attr_commitment_info => { kind: :property, name: "attrCommitmentInfo", is_optional: false },
    :attr_create_date => { kind: :property, name: "attrCreateDate", is_optional: false },
    :attr_delivery_preference => { kind: :property, name: "attrDeliveryPreference", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_instance_type => { kind: :property, name: "attrInstanceType", is_optional: false },
    :attr_owner_id => { kind: :property, name: "attrOwnerId", is_optional: false },
    :attr_reservation_type => { kind: :property, name: "attrReservationType", is_optional: false },
    :attr_start_date => { kind: :property, name: "attrStartDate", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_tenancy => { kind: :property, name: "attrTenancy", is_optional: false },
    :attr_total_instance_count => { kind: :property, name: "attrTotalInstanceCount", is_optional: false },
    :capacity_reservation_ref => { kind: :property, name: "capacityReservationRef", is_optional: false },
    :instance_count => { kind: :property, name: "instanceCount", is_optional: false },
    :instance_platform => { kind: :property, name: "instancePlatform", is_optional: false },
    :instance_type => { kind: :property, name: "instanceType", is_optional: false },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :availability_zone_id => { kind: :property, name: "availabilityZoneId", is_optional: true },
    :ebs_optimized => { kind: :property, name: "ebsOptimized", is_optional: true },
    :end_date => { kind: :property, name: "endDate", is_optional: true },
    :end_date_type => { kind: :property, name: "endDateType", is_optional: true },
    :ephemeral_storage => { kind: :property, name: "ephemeralStorage", is_optional: true },
    :instance_match_criteria => { kind: :property, name: "instanceMatchCriteria", is_optional: true },
    :out_post_arn => { kind: :property, name: "outPostArn", is_optional: true },
    :placement_group_arn => { kind: :property, name: "placementGroupArn", is_optional: true },
    :tag_specifications => { kind: :property, name: "tagSpecifications", is_optional: true },
    :tenancy => { kind: :property, name: "tenancy", is_optional: true },
    :unused_reservation_billing_owner_id => { kind: :property, name: "unusedReservationBillingOwnerId", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



599
600
601
602
 
# File 'ec2/cfn_capacity_reservation.rb', line 599

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



611
612
613
614
 
# File 'ec2/cfn_capacity_reservation.rb', line 611

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



621
622
623
624
 
# File 'ec2/cfn_capacity_reservation.rb', line 621

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



632
633
634
635
636
 
# File 'ec2/cfn_capacity_reservation.rb', line 632

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


689
690
691
692
693
 
# File 'ec2/cfn_capacity_reservation.rb', line 689

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



699
700
701
702
 
# File 'ec2/cfn_capacity_reservation.rb', line 699

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



711
712
713
714
715
 
# File 'ec2/cfn_capacity_reservation.rb', line 711

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



724
725
726
727
 
# File 'ec2/cfn_capacity_reservation.rb', line 724

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



746
747
748
749
750
751
 
# File 'ec2/cfn_capacity_reservation.rb', line 746

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_availability_zone ⇒ String

Returns the Availability Zone in which the capacity is reserved.

For example: us-east-1a .

Returns:

  • (String) 


243
244
245
 
# File 'ec2/cfn_capacity_reservation.rb', line 243

def attr_availability_zone()
  jsii_get_property("attrAvailabilityZone")
end

#attr_available_instance_count ⇒ Numeric

Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation.

For example: 9 .

Returns:

  • (Numeric) 


252
253
254
 
# File 'ec2/cfn_capacity_reservation.rb', line 252

def attr_available_instance_count()
  jsii_get_property("attrAvailableInstanceCount")
end

#attr_capacity_allocation_set ⇒ AWSCDK::IResolvable

Returns:



257
258
259
 
# File 'ec2/cfn_capacity_reservation.rb', line 257

def attr_capacity_allocation_set()
  jsii_get_property("attrCapacityAllocationSet")
end

#attr_capacity_reservation_arn ⇒ String

The Amazon Resource Name (ARN) of the Capacity Reservation.

Returns:

  • (String) 


264
265
266
 
# File 'ec2/cfn_capacity_reservation.rb', line 264

def attr_capacity_reservation_arn()
  jsii_get_property("attrCapacityReservationArn")
end

#attr_capacity_reservation_fleet_id ⇒ String

The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs.

Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.

Returns:

  • (String) 


273
274
275
 
# File 'ec2/cfn_capacity_reservation.rb', line 273

def attr_capacity_reservation_fleet_id()
  jsii_get_property("attrCapacityReservationFleetId")
end

#attr_commitment_info ⇒ AWSCDK::IResolvable

Returns:



278
279
280
 
# File 'ec2/cfn_capacity_reservation.rb', line 278

def attr_commitment_info()
  jsii_get_property("attrCommitmentInfo")
end

#attr_create_date ⇒ String

The date and time the Capacity Reservation was created.

Returns:

  • (String) 


285
286
287
 
# File 'ec2/cfn_capacity_reservation.rb', line 285

def attr_create_date()
  jsii_get_property("attrCreateDate")
end

#attr_delivery_preference ⇒ String

The delivery method for a future-dated Capacity Reservation.

incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.

Returns:

  • (String) 


294
295
296
 
# File 'ec2/cfn_capacity_reservation.rb', line 294

def attr_delivery_preference()
  jsii_get_property("attrDeliveryPreference")
end

#attr_id ⇒ String

The ID of the Capacity Reservation.

Returns:

  • (String) 


301
302
303
 
# File 'ec2/cfn_capacity_reservation.rb', line 301

def attr_id()
  jsii_get_property("attrId")
end

#attr_instance_type ⇒ String

Returns the type of instance for which the capacity is reserved.

For example: m4.large .

Returns:

  • (String) 


310
311
312
 
# File 'ec2/cfn_capacity_reservation.rb', line 310

def attr_instance_type()
  jsii_get_property("attrInstanceType")
end

#attr_owner_id ⇒ String

The ID of the AWS account that owns the Capacity Reservation.

Returns:

  • (String) 


317
318
319
 
# File 'ec2/cfn_capacity_reservation.rb', line 317

def attr_owner_id()
  jsii_get_property("attrOwnerId")
end

#attr_reservation_type ⇒ String

The type of Capacity Reservation.

Returns:

  • (String) 


324
325
326
 
# File 'ec2/cfn_capacity_reservation.rb', line 324

def attr_reservation_type()
  jsii_get_property("attrReservationType")
end

#attr_start_date ⇒ String

The date and time the Capacity Reservation was started.

Returns:

  • (String) 


331
332
333
 
# File 'ec2/cfn_capacity_reservation.rb', line 331

def attr_start_date()
  jsii_get_property("attrStartDate")
end

#attr_state ⇒ String

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:.

  • active - The capacity is available for use.
  • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
  • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
  • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
  • scheduled - ( Future-dated Capacity Reservations ) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
  • payment-pending - ( Capacity Blocks ) The upfront payment has not been processed yet.
  • payment-failed - ( Capacity Blocks ) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
  • assessing - ( Future-dated Capacity Reservations ) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
  • delayed - ( Future-dated Capacity Reservations ) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
  • unsupported - ( Future-dated Capacity Reservations ) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

Returns:

  • (String) 


350
351
352
 
# File 'ec2/cfn_capacity_reservation.rb', line 350

def attr_state()
  jsii_get_property("attrState")
end

#attr_tenancy ⇒ String

Returns the tenancy of the Capacity Reservation.

For example: dedicated .

Returns:

  • (String) 


359
360
361
 
# File 'ec2/cfn_capacity_reservation.rb', line 359

def attr_tenancy()
  jsii_get_property("attrTenancy")
end

#attr_total_instance_count ⇒ Numeric

Returns the total number of instances for which the Capacity Reservation reserves capacity.

For example: 15 .

Returns:

  • (Numeric) 


368
369
370
 
# File 'ec2/cfn_capacity_reservation.rb', line 368

def attr_total_instance_count()
  jsii_get_property("attrTotalInstanceCount")
end

#availability_zone ⇒ String?

The Availability Zone in which to create the Capacity Reservation.

Returns:

  • (String, nil) 


418
419
420
 
# File 'ec2/cfn_capacity_reservation.rb', line 418

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



422
423
424
425
 
# File 'ec2/cfn_capacity_reservation.rb', line 422

def availability_zone=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZone") unless value.nil?
  jsii_set_property("availabilityZone", value)
end

#availability_zone_id ⇒ String?

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

Returns:

  • (String, nil) 


430
431
432
 
# File 'ec2/cfn_capacity_reservation.rb', line 430

def availability_zone_id()
  jsii_get_property("availabilityZoneId")
end

#availability_zone_id=(value) ⇒ Object 



434
435
436
437
 
# File 'ec2/cfn_capacity_reservation.rb', line 434

def availability_zone_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZoneId") unless value.nil?
  jsii_set_property("availabilityZoneId", value)
end

#capacity_reservation_ref ⇒ AWSCDK::Interfaces::AWSEC2::CapacityReservationReference

A reference to a CapacityReservation resource.

Returns:



375
376
377
 
# File 'ec2/cfn_capacity_reservation.rb', line 375

def capacity_reservation_ref()
  jsii_get_property("capacityReservationRef")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



187
188
189
 
# File 'ec2/cfn_capacity_reservation.rb', line 187

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


192
193
194
 
# File 'ec2/cfn_capacity_reservation.rb', line 192

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


755
756
757
758
 
# File 'ec2/cfn_capacity_reservation.rb', line 755

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


197
198
199
 
# File 'ec2/cfn_capacity_reservation.rb', line 197

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


204
205
206
 
# File 'ec2/cfn_capacity_reservation.rb', line 204

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


149
150
151
 
# File 'ec2/cfn_capacity_reservation.rb', line 149

def creation_stack()
  jsii_get_property("creationStack")
end

#ebs_optimized ⇒ Boolean, ...

Indicates whether the Capacity Reservation supports EBS-optimized instances.

Returns:



442
443
444
 
# File 'ec2/cfn_capacity_reservation.rb', line 442

def ebs_optimized()
  jsii_get_property("ebsOptimized")
end

#ebs_optimized=(value) ⇒ Object 



446
447
448
449
 
# File 'ec2/cfn_capacity_reservation.rb', line 446

def ebs_optimized=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "ebsOptimized") unless value.nil?
  jsii_set_property("ebsOptimized", value)
end

#end_date ⇒ String?

The date and time at which the Capacity Reservation expires.

Returns:

  • (String, nil) 


454
455
456
 
# File 'ec2/cfn_capacity_reservation.rb', line 454

def end_date()
  jsii_get_property("endDate")
end

#end_date=(value) ⇒ Object 



458
459
460
461
 
# File 'ec2/cfn_capacity_reservation.rb', line 458

def end_date=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endDate") unless value.nil?
  jsii_set_property("endDate", value)
end

#end_date_type ⇒ String?

Indicates the way in which the Capacity Reservation ends.

Returns:

  • (String, nil) 


466
467
468
 
# File 'ec2/cfn_capacity_reservation.rb', line 466

def end_date_type()
  jsii_get_property("endDateType")
end

#end_date_type=(value) ⇒ Object 



470
471
472
473
 
# File 'ec2/cfn_capacity_reservation.rb', line 470

def end_date_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endDateType") unless value.nil?
  jsii_set_property("endDateType", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



209
210
211
 
# File 'ec2/cfn_capacity_reservation.rb', line 209

def env()
  jsii_get_property("env")
end

#ephemeral_storage ⇒ Boolean, ...

Deprecated..

Returns:



478
479
480
 
# File 'ec2/cfn_capacity_reservation.rb', line 478

def ephemeral_storage()
  jsii_get_property("ephemeralStorage")
end

#ephemeral_storage=(value) ⇒ Object 



482
483
484
485
 
# File 'ec2/cfn_capacity_reservation.rb', line 482

def ephemeral_storage=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "ephemeralStorage") unless value.nil?
  jsii_set_property("ephemeralStorage", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



768
769
770
771
772
 
# File 'ec2/cfn_capacity_reservation.rb', line 768

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



779
780
781
782
 
# File 'ec2/cfn_capacity_reservation.rb', line 779

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



849
850
851
852
 
# File 'ec2/cfn_capacity_reservation.rb', line 849

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_count ⇒ Numeric

The number of instances for which to reserve capacity.

Returns:

  • (Numeric) 


382
383
384
 
# File 'ec2/cfn_capacity_reservation.rb', line 382

def instance_count()
  jsii_get_property("instanceCount")
end

#instance_count=(value) ⇒ Object 



386
387
388
389
 
# File 'ec2/cfn_capacity_reservation.rb', line 386

def instance_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "instanceCount")
  jsii_set_property("instanceCount", value)
end

#instance_match_criteria ⇒ String?

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

The options include:.

Returns:

  • (String, nil) 


492
493
494
 
# File 'ec2/cfn_capacity_reservation.rb', line 492

def instance_match_criteria()
  jsii_get_property("instanceMatchCriteria")
end

#instance_match_criteria=(value) ⇒ Object 



496
497
498
499
 
# File 'ec2/cfn_capacity_reservation.rb', line 496

def instance_match_criteria=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceMatchCriteria") unless value.nil?
  jsii_set_property("instanceMatchCriteria", value)
end

#instance_platform ⇒ String

The type of operating system for which to reserve capacity.

Returns:

  • (String) 


394
395
396
 
# File 'ec2/cfn_capacity_reservation.rb', line 394

def instance_platform()
  jsii_get_property("instancePlatform")
end

#instance_platform=(value) ⇒ Object 



398
399
400
401
 
# File 'ec2/cfn_capacity_reservation.rb', line 398

def instance_platform=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instancePlatform")
  jsii_set_property("instancePlatform", value)
end

#instance_type ⇒ String

The instance type for which to reserve capacity.

Returns:

  • (String) 


406
407
408
 
# File 'ec2/cfn_capacity_reservation.rb', line 406

def instance_type()
  jsii_get_property("instanceType")
end

#instance_type=(value) ⇒ Object 



410
411
412
413
 
# File 'ec2/cfn_capacity_reservation.rb', line 410

def instance_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType")
  jsii_set_property("instanceType", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


161
162
163
 
# File 'ec2/cfn_capacity_reservation.rb', line 161

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


144
145
146
 
# File 'ec2/cfn_capacity_reservation.rb', line 144

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



790
791
792
 
# File 'ec2/cfn_capacity_reservation.rb', line 790

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



797
798
799
 
# File 'ec2/cfn_capacity_reservation.rb', line 797

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#out_post_arn ⇒ String?

Not supported for future-dated Capacity Reservations.

Returns:

  • (String, nil) 


504
505
506
 
# File 'ec2/cfn_capacity_reservation.rb', line 504

def out_post_arn()
  jsii_get_property("outPostArn")
end

#out_post_arn=(value) ⇒ Object 



508
509
510
511
 
# File 'ec2/cfn_capacity_reservation.rb', line 508

def out_post_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outPostArn") unless value.nil?
  jsii_set_property("outPostArn", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



590
591
592
593
 
# File 'ec2/cfn_capacity_reservation.rb', line 590

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#placement_group_arn ⇒ String?

Not supported for future-dated Capacity Reservations.

Returns:

  • (String, nil) 


516
517
518
 
# File 'ec2/cfn_capacity_reservation.rb', line 516

def placement_group_arn()
  jsii_get_property("placementGroupArn")
end

#placement_group_arn=(value) ⇒ Object 



520
521
522
523
 
# File 'ec2/cfn_capacity_reservation.rb', line 520

def placement_group_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "placementGroupArn") unless value.nil?
  jsii_set_property("placementGroupArn", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


180
181
182
 
# File 'ec2/cfn_capacity_reservation.rb', line 180

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



808
809
810
811
 
# File 'ec2/cfn_capacity_reservation.rb', line 808

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


815
816
817
818
 
# File 'ec2/cfn_capacity_reservation.rb', line 815

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



825
826
827
828
829
 
# File 'ec2/cfn_capacity_reservation.rb', line 825

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



834
835
836
 
# File 'ec2/cfn_capacity_reservation.rb', line 834

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



170
171
172
 
# File 'ec2/cfn_capacity_reservation.rb', line 170

def stack()
  jsii_get_property("stack")
end

#tag_specifications ⇒ AWSCDK::IResolvable, ...

The tags to apply to the Capacity Reservation during launch.

Returns:



528
529
530
 
# File 'ec2/cfn_capacity_reservation.rb', line 528

def tag_specifications()
  jsii_get_property("tagSpecifications")
end

#tag_specifications=(value) ⇒ Object 



532
533
534
535
 
# File 'ec2/cfn_capacity_reservation.rb', line 532

def tag_specifications=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkNhcGFjaXR5UmVzZXJ2YXRpb24uVGFnU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "tagSpecifications") unless value.nil?
  jsii_set_property("tagSpecifications", value)
end

#tenancy ⇒ String?

Indicates the tenancy of the Capacity Reservation.

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

Returns:

  • (String, nil) 


542
543
544
 
# File 'ec2/cfn_capacity_reservation.rb', line 542

def tenancy()
  jsii_get_property("tenancy")
end

#tenancy=(value) ⇒ Object 



546
547
548
549
 
# File 'ec2/cfn_capacity_reservation.rb', line 546

def tenancy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tenancy") unless value.nil?
  jsii_set_property("tenancy", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



566
567
568
 
# File 'ec2/cfn_capacity_reservation.rb', line 566

def to_string()
  jsii_call_method("toString", [])
end

#unused_reservation_billing_owner_id ⇒ String?

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

Returns:

  • (String, nil) 


554
555
556
 
# File 'ec2/cfn_capacity_reservation.rb', line 554

def unused_reservation_billing_owner_id()
  jsii_get_property("unusedReservationBillingOwnerId")
end

#unused_reservation_billing_owner_id=(value) ⇒ Object 



558
559
560
561
 
# File 'ec2/cfn_capacity_reservation.rb', line 558

def unused_reservation_billing_owner_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unusedReservationBillingOwnerId") unless value.nil?
  jsii_set_property("unusedReservationBillingOwnerId", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


217
218
219
 
# File 'ec2/cfn_capacity_reservation.rb', line 217

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


227
228
229
 
# File 'ec2/cfn_capacity_reservation.rb', line 227

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


840
841
842
843
 
# File 'ec2/cfn_capacity_reservation.rb', line 840

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


579
580
581
582
583
584
 
# File 'ec2/cfn_capacity_reservation.rb', line 579

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end