Class: AWSCDK::EC2::CfnEC2Fleet

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

Overview

Specifies the configuration information to launch a fleet--or group--of instances.

An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEC2Fleet

Create a new AWS::EC2::EC2Fleet.

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::CfnEC2FleetProps) —

    Resource properties.



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnEC2FleetProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkVDMkZsZWV0UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_ec2_fleet(resource) ⇒ String

Parameters:

Returns:

  • (String) 


84
85
86
87
 
# File 'ec2/cfn_ec2_fleet.rb', line 84

def self.arn_for_ec2_fleet(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUVDMkZsZWV0UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnEC2Fleet", "arnForEC2Fleet", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.from_fleet_id(scope, id, fleet_id) ⇒ AWSCDK::Interfaces::AWSEC2::IEC2FleetRef

Creates a new IEC2FleetRef from a fleetId.

Parameters:

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

Returns:



95
96
97
98
99
100
 
# File 'ec2/cfn_ec2_fleet.rb', line 95

def self.from_fleet_id(scope, id, fleet_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(fleet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fleetId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnEC2Fleet", "fromFleetId", [scope, id, fleet_id])
end

.is_cfn_ec2_fleet(x) ⇒ Boolean

Checks whether the given object is a CfnEC2Fleet.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


106
107
108
109
 
# File 'ec2/cfn_ec2_fleet.rb', line 106

def self.is_cfn_ec2_fleet(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnEC2Fleet", "isCfnEC2Fleet", [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
 
# File 'ec2/cfn_ec2_fleet.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_fleet_id => { kind: :property, name: "attrFleetId", is_optional: false },
    :ec2_fleet_ref => { kind: :property, name: "ec2FleetRef", is_optional: false },
    :launch_template_configs => { kind: :property, name: "launchTemplateConfigs", is_optional: false },
    :target_capacity_specification => { kind: :property, name: "targetCapacitySpecification", is_optional: false },
    :context => { kind: :property, name: "context", is_optional: true },
    :excess_capacity_termination_policy => { kind: :property, name: "excessCapacityTerminationPolicy", is_optional: true },
    :on_demand_options => { kind: :property, name: "onDemandOptions", is_optional: true },
    :replace_unhealthy_instances => { kind: :property, name: "replaceUnhealthyInstances", is_optional: true },
    :reserved_capacity_options => { kind: :property, name: "reservedCapacityOptions", is_optional: true },
    :spot_options => { kind: :property, name: "spotOptions", is_optional: true },
    :tag_specifications => { kind: :property, name: "tagSpecifications", is_optional: true },
    :terminate_instances_with_expiration => { kind: :property, name: "terminateInstancesWithExpiration", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :valid_from => { kind: :property, name: "validFrom", is_optional: true },
    :valid_until => { kind: :property, name: "validUntil", 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.



420
421
422
423
 
# File 'ec2/cfn_ec2_fleet.rb', line 420

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:



432
433
434
435
 
# File 'ec2/cfn_ec2_fleet.rb', line 432

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:



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

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:



453
454
455
456
457
 
# File 'ec2/cfn_ec2_fleet.rb', line 453

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.


510
511
512
513
514
 
# File 'ec2/cfn_ec2_fleet.rb', line 510

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.



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

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.



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

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:



545
546
547
548
 
# File 'ec2/cfn_ec2_fleet.rb', line 545

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:



567
568
569
570
571
572
 
# File 'ec2/cfn_ec2_fleet.rb', line 567

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_fleet_id ⇒ String

The ID of the EC2 Fleet.

Returns:

  • (String) 


211
212
213
 
# File 'ec2/cfn_ec2_fleet.rb', line 211

def attr_fleet_id()
  jsii_get_property("attrFleetId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



157
158
159
 
# File 'ec2/cfn_ec2_fleet.rb', line 157

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


162
163
164
 
# File 'ec2/cfn_ec2_fleet.rb', line 162

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


576
577
578
579
 
# File 'ec2/cfn_ec2_fleet.rb', line 576

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}) 


167
168
169
 
# File 'ec2/cfn_ec2_fleet.rb', line 167

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


174
175
176
 
# File 'ec2/cfn_ec2_fleet.rb', line 174

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#context ⇒ String?

Reserved.

Returns:

  • (String, nil) 


250
251
252
 
# File 'ec2/cfn_ec2_fleet.rb', line 250

def context()
  jsii_get_property("context")
end

#context=(value) ⇒ Object 



254
255
256
257
 
# File 'ec2/cfn_ec2_fleet.rb', line 254

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


119
120
121
 
# File 'ec2/cfn_ec2_fleet.rb', line 119

def creation_stack()
  jsii_get_property("creationStack")
end

#ec2_fleet_ref ⇒ AWSCDK::Interfaces::AWSEC2::EC2FleetReference

A reference to a EC2Fleet resource.

Returns:



218
219
220
 
# File 'ec2/cfn_ec2_fleet.rb', line 218

def ec2_fleet_ref()
  jsii_get_property("ec2FleetRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



179
180
181
 
# File 'ec2/cfn_ec2_fleet.rb', line 179

def env()
  jsii_get_property("env")
end

#excess_capacity_termination_policy ⇒ String?

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

Returns:

  • (String, nil) 


262
263
264
 
# File 'ec2/cfn_ec2_fleet.rb', line 262

def excess_capacity_termination_policy()
  jsii_get_property("excessCapacityTerminationPolicy")
end

#excess_capacity_termination_policy=(value) ⇒ Object 



266
267
268
269
 
# File 'ec2/cfn_ec2_fleet.rb', line 266

def excess_capacity_termination_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "excessCapacityTerminationPolicy") unless value.nil?
  jsii_set_property("excessCapacityTerminationPolicy", 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:



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

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:



600
601
602
603
 
# File 'ec2/cfn_ec2_fleet.rb', line 600

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:



670
671
672
673
 
# File 'ec2/cfn_ec2_fleet.rb', line 670

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

#launch_template_configs ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::EC2::CfnEC2Fleet::FleetLaunchTemplateConfigRequestProperty>

The configuration for the EC2 Fleet.

Returns:



225
226
227
 
# File 'ec2/cfn_ec2_fleet.rb', line 225

def launch_template_configs()
  jsii_get_property("launchTemplateConfigs")
end

#launch_template_configs=(value) ⇒ Object 



229
230
231
232
 
# File 'ec2/cfn_ec2_fleet.rb', line 229

def launch_template_configs=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkVDMkZsZWV0LkZsZWV0TGF1bmNoVGVtcGxhdGVDb25maWdSZXF1ZXN0UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "launchTemplateConfigs")
  jsii_set_property("launchTemplateConfigs", 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) 


131
132
133
 
# File 'ec2/cfn_ec2_fleet.rb', line 131

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


114
115
116
 
# File 'ec2/cfn_ec2_fleet.rb', line 114

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:



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

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:



618
619
620
 
# File 'ec2/cfn_ec2_fleet.rb', line 618

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

#on_demand_options ⇒ AWSCDK::IResolvable, ...

Describes the configuration of On-Demand Instances in an EC2 Fleet.

Returns:



274
275
276
 
# File 'ec2/cfn_ec2_fleet.rb', line 274

def on_demand_options()
  jsii_get_property("onDemandOptions")
end

#on_demand_options=(value) ⇒ Object 



278
279
280
281
282
 
# File 'ec2/cfn_ec2_fleet.rb', line 278

def on_demand_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnEC2Fleet::OnDemandOptionsRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuRUMyRmxlZXQuT25EZW1hbmRPcHRpb25zUmVxdWVzdFByb3BlcnR5In1dfX0=")), "onDemandOptions") unless value.nil?
  jsii_set_property("onDemandOptions", 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.



411
412
413
414
 
# File 'ec2/cfn_ec2_fleet.rb', line 411

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

#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) 


150
151
152
 
# File 'ec2/cfn_ec2_fleet.rb', line 150

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:



629
630
631
632
 
# File 'ec2/cfn_ec2_fleet.rb', line 629

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}) 


636
637
638
639
 
# File 'ec2/cfn_ec2_fleet.rb', line 636

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:



646
647
648
649
650
 
# File 'ec2/cfn_ec2_fleet.rb', line 646

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

#replace_unhealthy_instances ⇒ Boolean, ...

Indicates whether EC2 Fleet should replace unhealthy Spot Instances.

Returns:



287
288
289
 
# File 'ec2/cfn_ec2_fleet.rb', line 287

def replace_unhealthy_instances()
  jsii_get_property("replaceUnhealthyInstances")
end

#replace_unhealthy_instances=(value) ⇒ Object 



291
292
293
294
 
# File 'ec2/cfn_ec2_fleet.rb', line 291

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

#reserved_capacity_options ⇒ AWSCDK::IResolvable, ...

Returns:



297
298
299
 
# File 'ec2/cfn_ec2_fleet.rb', line 297

def reserved_capacity_options()
  jsii_get_property("reservedCapacityOptions")
end

#reserved_capacity_options=(value) ⇒ Object 



301
302
303
304
305
 
# File 'ec2/cfn_ec2_fleet.rb', line 301

def reserved_capacity_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnEC2Fleet::ReservedCapacityOptionsRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuRUMyRmxlZXQuUmVzZXJ2ZWRDYXBhY2l0eU9wdGlvbnNSZXF1ZXN0UHJvcGVydHkifV19fQ==")), "reservedCapacityOptions") unless value.nil?
  jsii_set_property("reservedCapacityOptions", value)
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.



655
656
657
 
# File 'ec2/cfn_ec2_fleet.rb', line 655

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

#spot_options ⇒ AWSCDK::IResolvable, ...

Describes the configuration of Spot Instances in an EC2 Fleet.

Returns:



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

def spot_options()
  jsii_get_property("spotOptions")
end

#spot_options=(value) ⇒ Object 



314
315
316
317
318
 
# File 'ec2/cfn_ec2_fleet.rb', line 314

def spot_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnEC2Fleet::SpotOptionsRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuRUMyRmxlZXQuU3BvdE9wdGlvbnNSZXF1ZXN0UHJvcGVydHkifV19fQ==")), "spotOptions") unless value.nil?
  jsii_set_property("spotOptions", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



140
141
142
 
# File 'ec2/cfn_ec2_fleet.rb', line 140

def stack()
  jsii_get_property("stack")
end

#tag_specifications ⇒ AWSCDK::IResolvable, ...

The key-value pair for tagging the EC2 Fleet request on creation.

For more information, see Tag your resources .

Returns:



325
326
327
 
# File 'ec2/cfn_ec2_fleet.rb', line 325

def tag_specifications()
  jsii_get_property("tagSpecifications")
end

#tag_specifications=(value) ⇒ Object 



329
330
331
332
 
# File 'ec2/cfn_ec2_fleet.rb', line 329

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

#target_capacity_specification ⇒ AWSCDK::IResolvable, AWSCDK::EC2::CfnEC2Fleet::TargetCapacitySpecificationRequestProperty

The number of units to request.

Returns:



237
238
239
 
# File 'ec2/cfn_ec2_fleet.rb', line 237

def target_capacity_specification()
  jsii_get_property("targetCapacitySpecification")
end

#target_capacity_specification=(value) ⇒ Object 



241
242
243
244
245
 
# File 'ec2/cfn_ec2_fleet.rb', line 241

def target_capacity_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnEC2Fleet::TargetCapacitySpecificationRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuRUMyRmxlZXQuVGFyZ2V0Q2FwYWNpdHlTcGVjaWZpY2F0aW9uUmVxdWVzdFByb3BlcnR5In1dfX0=")), "targetCapacitySpecification")
  jsii_set_property("targetCapacitySpecification", value)
end

#terminate_instances_with_expiration ⇒ Boolean, ...

Indicates whether running instances should be terminated when the EC2 Fleet expires.

Returns:



337
338
339
 
# File 'ec2/cfn_ec2_fleet.rb', line 337

def terminate_instances_with_expiration()
  jsii_get_property("terminateInstancesWithExpiration")
end

#terminate_instances_with_expiration=(value) ⇒ Object 



341
342
343
344
 
# File 'ec2/cfn_ec2_fleet.rb', line 341

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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

#type ⇒ String?

The fleet type.

The default value is maintain .

Returns:

  • (String, nil) 


351
352
353
 
# File 'ec2/cfn_ec2_fleet.rb', line 351

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



355
356
357
358
 
# File 'ec2/cfn_ec2_fleet.rb', line 355

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless value.nil?
  jsii_set_property("type", 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}) 


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

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}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#valid_from ⇒ String?

The start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).

Returns:

  • (String, nil) 


363
364
365
 
# File 'ec2/cfn_ec2_fleet.rb', line 363

def valid_from()
  jsii_get_property("validFrom")
end

#valid_from=(value) ⇒ Object 



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

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

#valid_until ⇒ String?

The end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).

Returns:

  • (String, nil) 


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

def valid_until()
  jsii_get_property("validUntil")
end

#valid_until=(value) ⇒ Object 



379
380
381
382
 
# File 'ec2/cfn_ec2_fleet.rb', line 379

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


661
662
663
664
 
# File 'ec2/cfn_ec2_fleet.rb', line 661

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) 


400
401
402
403
404
405
 
# File 'ec2/cfn_ec2_fleet.rb', line 400

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