CfnCapacityReservationFleet
- class aws_cdk.aws_ec2.CfnCapacityReservationFleet(scope, id, *, allocation_strategy=None, end_date=None, instance_match_criteria=None, instance_type_specifications=None, no_remove_end_date=None, remove_end_date=None, tag_specifications=None, tenancy=None, total_target_capacity=None)
Bases:
CfnResource
Creates a new Capacity Reservation Fleet with the specified attributes.
For more information, see Capacity Reservation Fleets in the Amazon EC2 User Guide .
- See:
- CloudformationResource:
AWS::EC2::CapacityReservationFleet
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ec2 as ec2 cfn_capacity_reservation_fleet = ec2.CfnCapacityReservationFleet(self, "MyCfnCapacityReservationFleet", allocation_strategy="allocationStrategy", end_date="endDate", instance_match_criteria="instanceMatchCriteria", instance_type_specifications=[ec2.CfnCapacityReservationFleet.InstanceTypeSpecificationProperty( availability_zone="availabilityZone", availability_zone_id="availabilityZoneId", ebs_optimized=False, instance_platform="instancePlatform", instance_type="instanceType", priority=123, weight=123 )], no_remove_end_date=False, remove_end_date=False, tag_specifications=[ec2.CfnCapacityReservationFleet.TagSpecificationProperty( resource_type="resourceType", tags=[CfnTag( key="key", value="value" )] )], tenancy="tenancy", total_target_capacity=123 )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).allocation_strategy (
Optional
[str
]) – The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only theprioritized
allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide . Valid values:prioritized
end_date (
Optional
[str
]) – The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes toexpired
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 specify5/31/2019
,13:30:55
, the Capacity Reservation Fleet is guaranteed to expire between13:30:55
and14:30:55
on5/31/2019
.instance_match_criteria (
Optional
[str
]) – Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria. Currently, Capacity Reservation Fleets supportopen
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.instance_type_specifications (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,InstanceTypeSpecificationProperty
,Dict
[str
,Any
]]],None
]) – Information about the instance types for which to reserve the capacity.no_remove_end_date (
Union
[bool
,IResolvable
,None
]) – Used to add an end date to a Capacity Reservation Fleet that has no end date and time. To add an end date to a Capacity Reservation Fleet, specifytrue
for this paramater and specify the end date and time (in UTC time format) for the EndDate parameter.remove_end_date (
Union
[bool
,IResolvable
,None
]) – Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time. To remove the end date from a Capacity Reservation Fleet, specifytrue
for this paramater and omit the EndDate parameter.tag_specifications (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,TagSpecificationProperty
,Dict
[str
,Any
]]],None
]) – The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.tenancy (
Optional
[str
]) – Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings: -default
- The Capacity Reservation Fleet is created on hardware that is shared with other AWS accounts . -dedicated
- The Capacity Reservations are created on single-tenant hardware that is dedicated to a single AWS account .total_target_capacity (
Union
[int
,float
,None
]) – The total number of capacity units to be reserved by the Capacity Reservation Fleet. 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 .
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
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:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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 (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
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:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::EC2::CapacityReservationFleet'
- allocation_strategy
The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.
- attr_capacity_reservation_fleet_id
The ID of the Capacity Reservation Fleet.
- CloudformationAttribute:
CapacityReservationFleetId
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- end_date
The date and time at which the Capacity Reservation Fleet expires.
- instance_match_criteria
Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
- instance_type_specifications
Information about the instance types for which to reserve the capacity.
- logical_id
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
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- no_remove_end_date
Used to add an end date to a Capacity Reservation Fleet that has no end date and time.
- node
The tree node.
- ref
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 })
.
- remove_end_date
Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tag_specifications
The tags to assign to the Capacity Reservation Fleet.
- tenancy
Indicates the tenancy of the Capacity Reservation Fleet.
- total_target_capacity
The total number of capacity units to be reserved by the Capacity Reservation Fleet.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
InstanceTypeSpecificationProperty
- class CfnCapacityReservationFleet.InstanceTypeSpecificationProperty(*, availability_zone=None, availability_zone_id=None, ebs_optimized=None, instance_platform=None, instance_type=None, priority=None, weight=None)
Bases:
object
Specifies information about an instance type to use in a Capacity Reservation Fleet.
InstanceTypeSpecification
is a property of the AWS::EC2::CapacityReservationFleet resource.- Parameters:
availability_zone (
Optional
[str
]) – The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can’t span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.availability_zone_id (
Optional
[str
]) – The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can’t span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.ebs_optimized (
Union
[bool
,IResolvable
,None
]) – Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. 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 EBS-optimized instance types.instance_platform (
Optional
[str
]) – The type of operating system for which the Capacity Reservation Fleet reserves capacity.instance_type (
Optional
[str
]) – The instance type for which the Capacity Reservation Fleet reserves capacity.priority (
Union
[int
,float
,None
]) – The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see Instance type priority in the Amazon EC2 User Guide .weight (
Union
[int
,float
,None
]) –The number of capacity units provided by the specified instance type. This value, together with the total target capacity that you specify for 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. Valid Range: Minimum value of
0.001
. Maximum value of99.999
.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ec2 as ec2 instance_type_specification_property = ec2.CfnCapacityReservationFleet.InstanceTypeSpecificationProperty( availability_zone="availabilityZone", availability_zone_id="availabilityZoneId", ebs_optimized=False, instance_platform="instancePlatform", instance_type="instanceType", priority=123, weight=123 )
Attributes
- availability_zone
The Availability Zone in which the Capacity Reservation Fleet reserves the capacity.
A Capacity Reservation Fleet can’t span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
- availability_zone_id
The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity.
A Capacity Reservation Fleet can’t span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
- ebs_optimized
Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types.
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 EBS-optimized instance types.
- instance_platform
The type of operating system for which the Capacity Reservation Fleet reserves capacity.
- instance_type
The instance type for which the Capacity Reservation Fleet reserves capacity.
- priority
The priority to assign to the instance type.
This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see Instance type priority in the Amazon EC2 User Guide .
- weight
The number of capacity units provided by the specified instance type.
This value, together with the total target capacity that you specify for 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.
Valid Range: Minimum value of
0.001
. Maximum value of99.999
.