Class: AWSCDK::Batch::FargateComputeEnvironment

Inherits:
Resource
  • Object
show all
Includes:
IComputeEnvironment, IFargateComputeEnvironment, IManagedComputeEnvironment
Defined in:
batch/fargate_compute_environment.rb

Overview

A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ FargateComputeEnvironment

Returns a new instance of FargateComputeEnvironment.

Parameters:



14
15
16
17
18
19
20
 
# File 'batch/fargate_compute_environment.rb', line 14

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

Class Method Details

.from_fargate_compute_environment_arn(scope, id, fargate_compute_environment_arn) ⇒ AWSCDK::Batch::IFargateComputeEnvironment

Reference an existing FargateComputeEnvironment by its arn.

Parameters:

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

Returns:



58
59
60
61
62
63
 
# File 'batch/fargate_compute_environment.rb', line 58

def self.from_fargate_compute_environment_arn(scope, id, fargate_compute_environment_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(fargate_compute_environment_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fargateComputeEnvironmentArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.FargateComputeEnvironment", "fromFargateComputeEnvironmentArn", [scope, id, fargate_compute_environment_arn])
end

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'batch/fargate_compute_environment.rb', line 22

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :compute_environment_arn => { kind: :property, name: "computeEnvironmentArn", is_optional: false },
    :compute_environment_name => { kind: :property, name: "computeEnvironmentName", is_optional: false },
    :compute_environment_ref => { kind: :property, name: "computeEnvironmentRef", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :enabled => { kind: :property, name: "enabled", is_optional: false },
    :maxv_cpus => { kind: :property, name: "maxvCpus", is_optional: false },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :replace_compute_environment => { kind: :property, name: "replaceComputeEnvironment", is_optional: true },
    :service_role => { kind: :property, name: "serviceRole", is_optional: true },
    :spot => { kind: :property, name: "spot", is_optional: true },
    :terminate_on_update => { kind: :property, name: "terminateOnUpdate", is_optional: true },
    :update_timeout => { kind: :property, name: "updateTimeout", is_optional: true },
    :update_to_latest_image_version => { kind: :property, name: "updateToLatestImageVersion", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


111
112
113
 
# File 'batch/fargate_compute_environment.rb', line 111

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_batch.FargateComputeEnvironment", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



290
291
292
293
 
# File 'batch/fargate_compute_environment.rb', line 290

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) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



307
308
309
310
 
# File 'batch/fargate_compute_environment.rb', line 307

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#compute_environment_arn ⇒ String

The ARN of this compute environment.

Returns:

  • (String) 


118
119
120
 
# File 'batch/fargate_compute_environment.rb', line 118

def compute_environment_arn()
  jsii_get_property("computeEnvironmentArn")
end

#compute_environment_name ⇒ String

The name of the ComputeEnvironment.

Returns:

  • (String) 


125
126
127
 
# File 'batch/fargate_compute_environment.rb', line 125

def compute_environment_name()
  jsii_get_property("computeEnvironmentName")
end

#compute_environment_ref ⇒ AWSCDK::Interfaces::AWSBatch::ComputeEnvironmentReference

A reference to a ComputeEnvironment resource.

Returns:



132
133
134
 
# File 'batch/fargate_compute_environment.rb', line 132

def compute_environment_ref()
  jsii_get_property("computeEnvironmentRef")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



139
140
141
 
# File 'batch/fargate_compute_environment.rb', line 139

def connections()
  jsii_get_property("connections")
end

#enabled ⇒ Boolean

Whether or not this ComputeEnvironment can accept jobs from a Queue.

Enabled ComputeEnvironments can accept jobs from a Queue and can scale instances up or down. Disabled ComputeEnvironments cannot accept jobs from a Queue or scale instances up or down.

If you change a ComputeEnvironment from enabled to disabled while it is executing jobs, Jobs in the STARTED or RUNNING states will not be interrupted. As jobs complete, the ComputeEnvironment will scale instances down to minv_cpus.

To ensure you aren't billed for unused capacity, set minv_cpus to 0.

Returns:

  • (Boolean) 


157
158
159
 
# File 'batch/fargate_compute_environment.rb', line 157

def enabled()
  jsii_get_property("enabled")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



83
84
85
 
# File 'batch/fargate_compute_environment.rb', line 83

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


313
314
315
 
# File 'batch/fargate_compute_environment.rb', line 313

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


327
328
329
330
331
332
 
# File 'batch/fargate_compute_environment.rb', line 327

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


342
343
344
345
 
# File 'batch/fargate_compute_environment.rb', line 342

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#maxv_cpus ⇒ Numeric

The maximum vCpus this ManagedComputeEnvironment can scale up to.

Note: if this Compute Environment uses EC2 resources (not Fargate) with either AllocationStrategy.BEST_FIT_PROGRESSIVE or AllocationStrategy.SPOT_CAPACITY_OPTIMIZED, or AllocationStrategy.BEST_FIT with Spot instances, The scheduler may exceed this number by at most one of the instances specified in instance_types or instance_classes.

Returns:

  • (Numeric) 


169
170
171
 
# File 'batch/fargate_compute_environment.rb', line 169

def maxv_cpus()
  jsii_get_property("maxvCpus")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


68
69
70
 
# File 'batch/fargate_compute_environment.rb', line 68

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


97
98
99
 
# File 'batch/fargate_compute_environment.rb', line 97

def physical_name()
  jsii_get_property("physicalName")
end

#replace_compute_environment ⇒ Boolean?

Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.

To enable more properties to be updated, set this property to false. When changing the value of this property to false, do not change any other properties at the same time. If other properties are changed at the same time, and the change needs to be rolled back but it can't, it's possible for the stack to go into the UPDATE_ROLLBACK_FAILED state. You can't update a stack that is in the UPDATE_ROLLBACK_FAILED state. However, if you can continue to roll it back, you can return the stack to its original settings and then try to update it again.

The properties which require a replacement of the Compute Environment are:

Returns:

  • (Boolean, nil) 


202
203
204
 
# File 'batch/fargate_compute_environment.rb', line 202

def replace_compute_environment()
  jsii_get_property("replaceComputeEnvironment")
end

#security_groups ⇒ Array<AWSCDK::EC2::ISecurityGroup>

The security groups this Compute Environment will launch instances in.

Returns:



176
177
178
 
# File 'batch/fargate_compute_environment.rb', line 176

def security_groups()
  jsii_get_property("securityGroups")
end

#service_role ⇒ AWSCDK::IAM::IRole?

The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

Returns:



209
210
211
 
# File 'batch/fargate_compute_environment.rb', line 209

def service_role()
  jsii_get_property("serviceRole")
end

#spot ⇒ Boolean?

Whether or not to use spot instances.

Spot instances are less expensive EC2 instances that can be reclaimed by EC2 at any time; your job will be given two minutes of notice before reclamation.

Returns:

  • (Boolean, nil) 


220
221
222
 
# File 'batch/fargate_compute_environment.rb', line 220

def spot()
  jsii_get_property("spot")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



104
105
106
 
# File 'batch/fargate_compute_environment.rb', line 104

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

TagManager to set, remove and format tags.

Returns:



183
184
185
 
# File 'batch/fargate_compute_environment.rb', line 183

def tags()
  jsii_get_property("tags")
end

#terminate_on_update ⇒ Boolean?

Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.

If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.

Returns:

  • (Boolean, nil) 


230
231
232
 
# File 'batch/fargate_compute_environment.rb', line 230

def terminate_on_update()
  jsii_get_property("terminateOnUpdate")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


260
261
262
 
# File 'batch/fargate_compute_environment.rb', line 260

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

#update_timeout ⇒ AWSCDK::Duration?

Only meaningful if terminateOnUpdate is false.

If so, when an infrastructure update is triggered, any running jobs will be allowed to run until update_timeout has expired.

Returns:



241
242
243
 
# File 'batch/fargate_compute_environment.rb', line 241

def update_timeout()
  jsii_get_property("updateTimeout")
end

#update_to_latest_image_version ⇒ Boolean?

Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.

If you specify a specific AMI, this property will be ignored.

Note: the CDK will never set this value by default, false will set by CFN. This is to avoid a deployment failure that occurs when this value is set.

Returns:

  • (Boolean, nil) 


253
254
255
 
# File 'batch/fargate_compute_environment.rb', line 253

def update_to_latest_image_version()
  jsii_get_property("updateToLatestImageVersion")
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) 


273
274
275
276
277
278
 
# File 'batch/fargate_compute_environment.rb', line 273

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