Class: AWSCDK::Batch::UnmanagedComputeEnvironment

Inherits:
Resource
  • Object
show all
Includes:
IComputeEnvironment, IUnmanagedComputeEnvironment
Defined in:
batch/unmanaged_compute_environment.rb

Overview

Unmanaged ComputeEnvironments do not provision or manage EC2 instances on your behalf.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ UnmanagedComputeEnvironment

Returns a new instance of UnmanagedComputeEnvironment.

Parameters:



13
14
15
16
17
18
19
 
# File 'batch/unmanaged_compute_environment.rb', line 13

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

Class Method Details

.from_unmanaged_compute_environment_arn(scope, id, unmanaged_compute_environment_arn) ⇒ AWSCDK::Batch::IUnmanagedComputeEnvironment

Import an UnmanagedComputeEnvironment by its arn.

Parameters:

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

Returns:



49
50
51
52
53
54
 
# File 'batch/unmanaged_compute_environment.rb', line 49

def self.from_unmanaged_compute_environment_arn(scope, id, unmanaged_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(unmanaged_compute_environment_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unmanagedComputeEnvironmentArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.UnmanagedComputeEnvironment", "fromUnmanagedComputeEnvironmentArn", [scope, id, unmanaged_compute_environment_arn])
end

.jsii_overridable_methods ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'batch/unmanaged_compute_environment.rb', line 21

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 },
    :enabled => { kind: :property, name: "enabled", is_optional: false },
    :service_role => { kind: :property, name: "serviceRole", is_optional: true },
    :unmanagedv_cp_us => { kind: :property, name: "unmanagedvCPUs", 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) 


102
103
104
 
# File 'batch/unmanaged_compute_environment.rb', line 102

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_batch.UnmanagedComputeEnvironment", "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:



195
196
197
198
 
# File 'batch/unmanaged_compute_environment.rb', line 195

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:



212
213
214
215
 
# File 'batch/unmanaged_compute_environment.rb', line 212

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) 


109
110
111
 
# File 'batch/unmanaged_compute_environment.rb', line 109

def compute_environment_arn()
  jsii_get_property("computeEnvironmentArn")
end

#compute_environment_name ⇒ String

The name of the ComputeEnvironment.

Returns:

  • (String) 


116
117
118
 
# File 'batch/unmanaged_compute_environment.rb', line 116

def compute_environment_name()
  jsii_get_property("computeEnvironmentName")
end

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

A reference to a ComputeEnvironment resource.

Returns:



123
124
125
 
# File 'batch/unmanaged_compute_environment.rb', line 123

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) 


141
142
143
 
# File 'batch/unmanaged_compute_environment.rb', line 141

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:



74
75
76
 
# File 'batch/unmanaged_compute_environment.rb', line 74

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


218
219
220
 
# File 'batch/unmanaged_compute_environment.rb', line 218

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) 


232
233
234
235
236
237
 
# File 'batch/unmanaged_compute_environment.rb', line 232

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) 


247
248
249
250
 
# File 'batch/unmanaged_compute_environment.rb', line 247

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


59
60
61
 
# File 'batch/unmanaged_compute_environment.rb', line 59

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) 


88
89
90
 
# File 'batch/unmanaged_compute_environment.rb', line 88

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



148
149
150
 
# File 'batch/unmanaged_compute_environment.rb', line 148

def service_role()
  jsii_get_property("serviceRole")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



95
96
97
 
# File 'batch/unmanaged_compute_environment.rb', line 95

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


165
166
167
 
# File 'batch/unmanaged_compute_environment.rb', line 165

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

#unmanagedv_cp_us ⇒ Numeric?

The vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in Queues that use FairshareSchedulingPolicys.

If this parameter is not provided on a fairshare queue, no capacity is reserved; that is, the FairshareSchedulingPolicy is ignored.

Returns:

  • (Numeric, nil) 


158
159
160
 
# File 'batch/unmanaged_compute_environment.rb', line 158

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


178
179
180
181
182
183
 
# File 'batch/unmanaged_compute_environment.rb', line 178

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