Module: AWSCDK::Batch::IFargateComputeEnvironment

Includes:
IManagedComputeEnvironment
Included in:
FargateComputeEnvironment
Defined in:
batch/i_fargate_compute_environment.rb

Overview

A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'batch/i_fargate_compute_environment.rb', line 226

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :compute_environment_ref => { kind: :property, name: "computeEnvironmentRef", is_optional: false },
    :compute_environment_arn => { kind: :property, name: "computeEnvironmentArn", is_optional: false },
    :compute_environment_name => { kind: :property, name: "computeEnvironmentName", is_optional: false },
    :enabled => { kind: :property, name: "enabled", is_optional: false },
    :service_role => { kind: :property, name: "serviceRole", is_optional: true },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :maxv_cpus => { kind: :property, name: "maxvCpus", is_optional: false },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: false },
    :replace_compute_environment => { kind: :property, name: "replaceComputeEnvironment", 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 },
    :vpc_subnets => { kind: :property, name: "vpcSubnets", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

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



221
222
223
224
 
# File 'batch/i_fargate_compute_environment.rb', line 221

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) 


47
48
49
 
# File 'batch/i_fargate_compute_environment.rb', line 47

def compute_environment_arn()
  jsii_get_property("computeEnvironmentArn")
end

#compute_environment_name ⇒ String

The name of the ComputeEnvironment.

Returns:

  • (String) 


54
55
56
 
# File 'batch/i_fargate_compute_environment.rb', line 54

def compute_environment_name()
  jsii_get_property("computeEnvironmentName")
end

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

A reference to a ComputeEnvironment resource.

Returns:



40
41
42
 
# File 'batch/i_fargate_compute_environment.rb', line 40

def compute_environment_ref()
  jsii_get_property("computeEnvironmentRef")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



87
88
89
 
# File 'batch/i_fargate_compute_environment.rb', line 87

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) 


72
73
74
 
# File 'batch/i_fargate_compute_environment.rb', line 72

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:



26
27
28
 
# File 'batch/i_fargate_compute_environment.rb', line 26

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


106
107
108
 
# File 'batch/i_fargate_compute_environment.rb', line 106

def maxv_cpus()
  jsii_get_property("maxvCpus")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


11
12
13
 
# File 'batch/i_fargate_compute_environment.rb', line 11

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

See Also:



133
134
135
 
# File 'batch/i_fargate_compute_environment.rb', line 133

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:



113
114
115
 
# File 'batch/i_fargate_compute_environment.rb', line 113

def security_groups()
  jsii_get_property("securityGroups")
end

#service_role ⇒ AWSCDK::IAM::IRole?

Note:

Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs

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

Returns:



80
81
82
 
# File 'batch/i_fargate_compute_environment.rb', line 80

def service_role()
  jsii_get_property("serviceRole")
end

#spot ⇒ Boolean?

Note:

Default: false

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) 


145
146
147
 
# File 'batch/i_fargate_compute_environment.rb', line 145

def spot()
  jsii_get_property("spot")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



33
34
35
 
# File 'batch/i_fargate_compute_environment.rb', line 33

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

TagManager to set, remove and format tags.

Returns:



94
95
96
 
# File 'batch/i_fargate_compute_environment.rb', line 94

def tags()
  jsii_get_property("tags")
end

#terminate_on_update ⇒ Boolean?

Note:

Default: false

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)

See Also:



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

def terminate_on_update()
  jsii_get_property("terminateOnUpdate")
end

#update_timeout ⇒ AWSCDK::Duration?

Note:

Default: 30 minutes

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:

See Also:



170
171
172
 
# File 'batch/i_fargate_compute_environment.rb', line 170

def update_timeout()
  jsii_get_property("updateTimeout")
end

#update_to_latest_image_version ⇒ Boolean?

Note:

Default: false

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)

See Also:



184
185
186
 
# File 'batch/i_fargate_compute_environment.rb', line 184

def update_to_latest_image_version()
  jsii_get_property("updateToLatestImageVersion")
end

#vpc_subnets ⇒ AWSCDK::EC2::SubnetSelection?

The VPC Subnets this Compute Environment will launch instances in.

Returns:



191
192
193
 
# File 'batch/i_fargate_compute_environment.rb', line 191

def vpc_subnets()
  jsii_get_property("vpcSubnets")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



202
203
204
205
206
207
 
# File 'batch/i_fargate_compute_environment.rb', line 202

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