Class: AWSCDK::Batch::CfnJobDefinition

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSBatch::IJobDefinitionRef
Defined in:
batch/cfn_job_definition.rb

Overview

The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.

For more information, see Job Definitions in the ** .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnJobDefinition

Create a new AWS::Batch::JobDefinition.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Batch::CfnJobDefinitionProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'batch/cfn_job_definition.rb', line 20

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

Class Method Details

.arn_for_job_definition(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_job_definition(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iYXRjaC5JSm9iRGVmaW5pdGlvblJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.CfnJobDefinition", "arnForJobDefinition", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_job_definition(x) ⇒ Boolean

Checks whether the given object is a CfnJobDefinition.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_job_definition(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_batch.CfnJobDefinition", "isCfnJobDefinition", [x])
end

.jsii_overridable_methods ⇒ Object 



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
81
82
83
84
 
# File 'batch/cfn_job_definition.rb', line 28

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_job_definition_arn => { kind: :property, name: "attrJobDefinitionArn", is_optional: false },
    :job_definition_ref => { kind: :property, name: "jobDefinitionRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :parameters => { kind: :property, name: "parameters", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :consumable_resource_properties => { kind: :property, name: "consumableResourceProperties", is_optional: true },
    :container_properties => { kind: :property, name: "containerProperties", is_optional: true },
    :ecs_properties => { kind: :property, name: "ecsProperties", is_optional: true },
    :eks_properties => { kind: :property, name: "eksProperties", is_optional: true },
    :job_definition_name => { kind: :property, name: "jobDefinitionName", is_optional: true },
    :node_properties => { kind: :property, name: "nodeProperties", is_optional: true },
    :platform_capabilities => { kind: :property, name: "platformCapabilities", is_optional: true },
    :propagate_tags => { kind: :property, name: "propagateTags", is_optional: true },
    :resource_retention_policy => { kind: :property, name: "resourceRetentionPolicy", is_optional: true },
    :retry_strategy => { kind: :property, name: "retryStrategy", is_optional: true },
    :scheduling_priority => { kind: :property, name: "schedulingPriority", is_optional: true },
    :timeout => { kind: :property, name: "timeout", 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.



444
445
446
447
 
# File 'batch/cfn_job_definition.rb', line 444

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:



456
457
458
459
 
# File 'batch/cfn_job_definition.rb', line 456

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:



466
467
468
469
 
# File 'batch/cfn_job_definition.rb', line 466

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:



477
478
479
480
481
 
# File 'batch/cfn_job_definition.rb', line 477

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.


534
535
536
537
538
 
# File 'batch/cfn_job_definition.rb', line 534

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.



544
545
546
547
 
# File 'batch/cfn_job_definition.rb', line 544

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.



556
557
558
559
560
 
# File 'batch/cfn_job_definition.rb', line 556

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:



569
570
571
572
 
# File 'batch/cfn_job_definition.rb', line 569

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:



591
592
593
594
595
596
 
# File 'batch/cfn_job_definition.rb', line 591

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

The job definition ARN, such as batch: *us-east-1* : *111122223333* :job-definition/ *test-gpu* : *2* .

Returns:

  • (String) 


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

def attr_job_definition_arn()
  jsii_get_property("attrJobDefinitionArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'batch/cfn_job_definition.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


600
601
602
603
 
# File 'batch/cfn_job_definition.rb', line 600

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#consumable_resource_properties ⇒ AWSCDK::IResolvable, ...

Contains a list of consumable resources required by the job.

Returns:



259
260
261
 
# File 'batch/cfn_job_definition.rb', line 259

def consumable_resource_properties()
  jsii_get_property("consumableResourceProperties")
end

#consumable_resource_properties=(value) ⇒ Object 



263
264
265
266
267
 
# File 'batch/cfn_job_definition.rb', line 263

def consumable_resource_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Batch::CfnJobDefinition::ConsumableResourcePropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Kb2JEZWZpbml0aW9uLkNvbnN1bWFibGVSZXNvdXJjZVByb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "consumableResourceProperties") unless value.nil?
  jsii_set_property("consumableResourceProperties", value)
end

#container_properties ⇒ AWSCDK::IResolvable, ...

An object with properties specific to Amazon ECS-based jobs.

Returns:



272
273
274
 
# File 'batch/cfn_job_definition.rb', line 272

def container_properties()
  jsii_get_property("containerProperties")
end

#container_properties=(value) ⇒ Object 



276
277
278
279
280
 
# File 'batch/cfn_job_definition.rb', line 276

def container_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Batch::CfnJobDefinition::ContainerPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Kb2JEZWZpbml0aW9uLkNvbnRhaW5lclByb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "containerProperties") unless value.nil?
  jsii_set_property("containerProperties", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'batch/cfn_job_definition.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#ecs_properties ⇒ AWSCDK::IResolvable, ...

An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties , eksProperties , or nodeProperties .

Returns:



285
286
287
 
# File 'batch/cfn_job_definition.rb', line 285

def ecs_properties()
  jsii_get_property("ecsProperties")
end

#ecs_properties=(value) ⇒ Object 



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

def ecs_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Batch::CfnJobDefinition::ECSPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Kb2JEZWZpbml0aW9uLkVjc1Byb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "ecsProperties") unless value.nil?
  jsii_set_property("ecsProperties", value)
end

#eks_properties ⇒ AWSCDK::IResolvable, ...

An object with properties that are specific to Amazon EKS-based jobs.

Returns:



298
299
300
 
# File 'batch/cfn_job_definition.rb', line 298

def eks_properties()
  jsii_get_property("eksProperties")
end

#eks_properties=(value) ⇒ Object 



302
303
304
305
306
 
# File 'batch/cfn_job_definition.rb', line 302

def eks_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Batch::CfnJobDefinition::EKSPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Kb2JEZWZpbml0aW9uLkVrc1Byb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "eksProperties") unless value.nil?
  jsii_set_property("eksProperties", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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



613
614
615
616
617
 
# File 'batch/cfn_job_definition.rb', line 613

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:



624
625
626
627
 
# File 'batch/cfn_job_definition.rb', line 624

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:



694
695
696
697
 
# File 'batch/cfn_job_definition.rb', line 694

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

#job_definition_name ⇒ String?

The name of the job definition.

Returns:

  • (String, nil) 


311
312
313
 
# File 'batch/cfn_job_definition.rb', line 311

def job_definition_name()
  jsii_get_property("jobDefinitionName")
end

#job_definition_name=(value) ⇒ Object 



315
316
317
318
 
# File 'batch/cfn_job_definition.rb', line 315

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

#job_definition_ref ⇒ AWSCDK::Interfaces::AWSBatch::JobDefinitionReference

A reference to a JobDefinition resource.

Returns:



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

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


122
123
124
 
# File 'batch/cfn_job_definition.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'batch/cfn_job_definition.rb', line 105

def node()
  jsii_get_property("node")
end

#node_properties ⇒ AWSCDK::IResolvable, ...

An object with properties that are specific to multi-node parallel jobs.

Returns:



323
324
325
 
# File 'batch/cfn_job_definition.rb', line 323

def node_properties()
  jsii_get_property("nodeProperties")
end

#node_properties=(value) ⇒ Object 



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

def node_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Batch::CfnJobDefinition::NodePropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Kb2JEZWZpbml0aW9uLk5vZGVQcm9wZXJ0aWVzUHJvcGVydHkifV19fQ==")), "nodeProperties") unless value.nil?
  jsii_set_property("nodeProperties", value)
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:



635
636
637
 
# File 'batch/cfn_job_definition.rb', line 635

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:



642
643
644
 
# File 'batch/cfn_job_definition.rb', line 642

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
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.



435
436
437
438
 
# File 'batch/cfn_job_definition.rb', line 435

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

#parameters ⇒ Object

Default parameters or parameter substitution placeholders that are set in the job definition.

Returns:

  • (Object) 


223
224
225
 
# File 'batch/cfn_job_definition.rb', line 223

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



227
228
229
230
 
# File 'batch/cfn_job_definition.rb', line 227

def parameters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "parameters")
  jsii_set_property("parameters", value)
end

#platform_capabilities ⇒ Array<String>?

The platform capabilities required by the job definition.

Returns:

  • (Array<String>, nil) 


336
337
338
 
# File 'batch/cfn_job_definition.rb', line 336

def platform_capabilities()
  jsii_get_property("platformCapabilities")
end

#platform_capabilities=(value) ⇒ Object 



340
341
342
343
 
# File 'batch/cfn_job_definition.rb', line 340

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

#propagate_tags ⇒ Boolean, ...

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.

Returns:



348
349
350
 
# File 'batch/cfn_job_definition.rb', line 348

def propagate_tags()
  jsii_get_property("propagateTags")
end

#propagate_tags=(value) ⇒ Object 



352
353
354
355
 
# File 'batch/cfn_job_definition.rb', line 352

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


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

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:



653
654
655
656
 
# File 'batch/cfn_job_definition.rb', line 653

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


660
661
662
663
 
# File 'batch/cfn_job_definition.rb', line 660

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:



670
671
672
673
674
 
# File 'batch/cfn_job_definition.rb', line 670

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

#resource_retention_policy ⇒ AWSCDK::IResolvable, ...

Specifies the resource retention policy settings for the job definition.

Returns:



360
361
362
 
# File 'batch/cfn_job_definition.rb', line 360

def resource_retention_policy()
  jsii_get_property("resourceRetentionPolicy")
end

#resource_retention_policy=(value) ⇒ Object 



364
365
366
367
368
 
# File 'batch/cfn_job_definition.rb', line 364

def resource_retention_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Batch::CfnJobDefinition::ResourceRetentionPolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Kb2JEZWZpbml0aW9uLlJlc291cmNlUmV0ZW50aW9uUG9saWN5UHJvcGVydHkifV19fQ==")), "resourceRetentionPolicy") unless value.nil?
  jsii_set_property("resourceRetentionPolicy", value)
end

#retry_strategy ⇒ AWSCDK::IResolvable, ...

The retry strategy to use for failed jobs that are submitted with this job definition.

Returns:



373
374
375
 
# File 'batch/cfn_job_definition.rb', line 373

def retry_strategy()
  jsii_get_property("retryStrategy")
end

#retry_strategy=(value) ⇒ Object 



377
378
379
380
381
 
# File 'batch/cfn_job_definition.rb', line 377

def retry_strategy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Batch::CfnJobDefinition::RetryStrategyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Kb2JEZWZpbml0aW9uLlJldHJ5U3RyYXRlZ3lQcm9wZXJ0eSJ9XX19")), "retryStrategy") unless value.nil?
  jsii_set_property("retryStrategy", value)
end

#scheduling_priority ⇒ Numeric?

The scheduling priority of the job definition.

Returns:

  • (Numeric, nil) 


386
387
388
 
# File 'batch/cfn_job_definition.rb', line 386

def scheduling_priority()
  jsii_get_property("schedulingPriority")
end

#scheduling_priority=(value) ⇒ Object 



390
391
392
393
 
# File 'batch/cfn_job_definition.rb', line 390

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



679
680
681
 
# File 'batch/cfn_job_definition.rb', line 679

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



131
132
133
 
# File 'batch/cfn_job_definition.rb', line 131

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



216
217
218
 
# File 'batch/cfn_job_definition.rb', line 216

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Object

The tags that are applied to the job definition.

Returns:

  • (Object) 


235
236
237
 
# File 'batch/cfn_job_definition.rb', line 235

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



239
240
241
242
 
# File 'batch/cfn_job_definition.rb', line 239

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagsRaw")
  jsii_set_property("tagsRaw", value)
end

#timeout ⇒ AWSCDK::IResolvable, ...

The timeout time for jobs that are submitted with this job definition.

Returns:



398
399
400
 
# File 'batch/cfn_job_definition.rb', line 398

def timeout()
  jsii_get_property("timeout")
end

#timeout=(value) ⇒ Object 



402
403
404
405
406
 
# File 'batch/cfn_job_definition.rb', line 402

def timeout=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Batch::CfnJobDefinition::TimeoutProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Kb2JEZWZpbml0aW9uLlRpbWVvdXRQcm9wZXJ0eSJ9XX19")), "timeout") unless value.nil?
  jsii_set_property("timeout", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



411
412
413
 
# File 'batch/cfn_job_definition.rb', line 411

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

#type ⇒ String

The type of job definition.

Returns:

  • (String) 


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

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



251
252
253
254
 
# File 'batch/cfn_job_definition.rb', line 251

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


178
179
180
 
# File 'batch/cfn_job_definition.rb', line 178

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


188
189
190
 
# File 'batch/cfn_job_definition.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


685
686
687
688
 
# File 'batch/cfn_job_definition.rb', line 685

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) 


424
425
426
427
428
429
 
# File 'batch/cfn_job_definition.rb', line 424

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