Module: AWSCDK::Batch::IComputeEnvironment

Includes:
IResource, Interfaces::AWSBatch::IComputeEnvironmentRef
Included in:
FargateComputeEnvironment, IManagedComputeEnvironment, IUnmanagedComputeEnvironment, ManagedEC2ECSComputeEnvironment, ManagedEC2EKSComputeEnvironment, UnmanagedComputeEnvironment
Defined in:
batch/i_compute_environment.rb

Overview

Represents a ComputeEnvironment.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'batch/i_compute_environment.rb', line 116

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 },
    :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:



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

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) 


48
49
50
 
# File 'batch/i_compute_environment.rb', line 48

def compute_environment_arn()
  jsii_get_property("computeEnvironmentArn")
end

#compute_environment_name ⇒ String

The name of the ComputeEnvironment.

Returns:

  • (String) 


55
56
57
 
# File 'batch/i_compute_environment.rb', line 55

def compute_environment_name()
  jsii_get_property("computeEnvironmentName")
end

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

A reference to a ComputeEnvironment resource.

Returns:



41
42
43
 
# File 'batch/i_compute_environment.rb', line 41

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


73
74
75
 
# File 'batch/i_compute_environment.rb', line 73

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:



27
28
29
 
# File 'batch/i_compute_environment.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'batch/i_compute_environment.rb', line 12

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



81
82
83
 
# File 'batch/i_compute_environment.rb', line 81

def service_role()
  jsii_get_property("serviceRole")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'batch/i_compute_environment.rb', line 34

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



92
93
94
95
96
97
 
# File 'batch/i_compute_environment.rb', line 92

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