Class: AWSCDK::ECS::CfnTaskDefinition

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSECS::ITaskDefinitionRef
Defined in:
ecs/cfn_task_definition.rb

Overview

Registers a new task definition from the supplied family and containerDefinitions .

Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .

You can specify a role for your task with the task_role_arn parameter. When you specify a role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .

You can specify a Docker networking mode for the containers in your task definition with the network_mode parameter. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::ECS::TaskDefinition.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::ECS::CfnTaskDefinitionProps, nil) (defaults to: nil) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'ecs/cfn_task_definition.rb', line 24

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

Class Method Details

.arn_for_task_definition(resource) ⇒ String

Parameters:

Returns:

  • (String) 


95
96
97
98
 
# File 'ecs/cfn_task_definition.rb', line 95

def self.arn_for_task_definition(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lY3MuSVRhc2tEZWZpbml0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ecs.CfnTaskDefinition", "arnForTaskDefinition", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


202
203
204
 
# File 'ecs/cfn_task_definition.rb', line 202

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

.is_cfn_task_definition(x) ⇒ Boolean

Checks whether the given object is a CfnTaskDefinition.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


104
105
106
107
 
# File 'ecs/cfn_task_definition.rb', line 104

def self.is_cfn_task_definition(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ecs.CfnTaskDefinition", "isCfnTaskDefinition", [x])
end

.jsii_overridable_methods ⇒ Object 



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
85
86
87
88
89
90
91
 
# File 'ecs/cfn_task_definition.rb', line 32

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_task_definition_arn => { kind: :property, name: "attrTaskDefinitionArn", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :task_definition_ref => { kind: :property, name: "taskDefinitionRef", is_optional: false },
    :container_definitions => { kind: :property, name: "containerDefinitions", is_optional: true },
    :cpu => { kind: :property, name: "cpu", is_optional: true },
    :enable_fault_injection => { kind: :property, name: "enableFaultInjection", is_optional: true },
    :ephemeral_storage => { kind: :property, name: "ephemeralStorage", is_optional: true },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: true },
    :family => { kind: :property, name: "family", is_optional: true },
    :inference_accelerators => { kind: :property, name: "inferenceAccelerators", is_optional: true },
    :ipc_mode => { kind: :property, name: "ipcMode", is_optional: true },
    :memory => { kind: :property, name: "memory", is_optional: true },
    :network_mode => { kind: :property, name: "networkMode", is_optional: true },
    :pid_mode => { kind: :property, name: "pidMode", is_optional: true },
    :placement_constraints => { kind: :property, name: "placementConstraints", is_optional: true },
    :proxy_configuration => { kind: :property, name: "proxyConfiguration", is_optional: true },
    :requires_compatibilities => { kind: :property, name: "requiresCompatibilities", is_optional: true },
    :runtime_platform => { kind: :property, name: "runtimePlatform", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :task_role_arn => { kind: :property, name: "taskRoleArn", is_optional: true },
    :volumes => { kind: :property, name: "volumes", 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.



482
483
484
485
 
# File 'ecs/cfn_task_definition.rb', line 482

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:



494
495
496
497
 
# File 'ecs/cfn_task_definition.rb', line 494

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:



504
505
506
507
 
# File 'ecs/cfn_task_definition.rb', line 504

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:



515
516
517
518
519
 
# File 'ecs/cfn_task_definition.rb', line 515

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.


572
573
574
575
576
 
# File 'ecs/cfn_task_definition.rb', line 572

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.



582
583
584
585
 
# File 'ecs/cfn_task_definition.rb', line 582

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.



594
595
596
597
598
 
# File 'ecs/cfn_task_definition.rb', line 594

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:



607
608
609
610
 
# File 'ecs/cfn_task_definition.rb', line 607

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:



629
630
631
632
633
634
 
# File 'ecs/cfn_task_definition.rb', line 629

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

The ARN of the task definition.

Returns:

  • (String) 


209
210
211
 
# File 'ecs/cfn_task_definition.rb', line 209

def attr_task_definition_arn()
  jsii_get_property("attrTaskDefinitionArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



155
156
157
 
# File 'ecs/cfn_task_definition.rb', line 155

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


160
161
162
 
# File 'ecs/cfn_task_definition.rb', line 160

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


638
639
640
641
 
# File 'ecs/cfn_task_definition.rb', line 638

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


165
166
167
 
# File 'ecs/cfn_task_definition.rb', line 165

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


172
173
174
 
# File 'ecs/cfn_task_definition.rb', line 172

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#container_definitions ⇒ AWSCDK::IResolvable, ...

A list of container definitions in JSON format that describe the different containers that make up your task.

Returns:



230
231
232
 
# File 'ecs/cfn_task_definition.rb', line 230

def container_definitions()
  jsii_get_property("containerDefinitions")
end

#container_definitions=(value) ⇒ Object 



234
235
236
237
 
# File 'ecs/cfn_task_definition.rb', line 234

def container_definitions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLkNvbnRhaW5lckRlZmluaXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "containerDefinitions") unless value.nil?
  jsii_set_property("containerDefinitions", value)
end

#cpu ⇒ String?

The number of cpu units used by the task.

Returns:

  • (String, nil) 


242
243
244
 
# File 'ecs/cfn_task_definition.rb', line 242

def cpu()
  jsii_get_property("cpu")
end

#cpu=(value) ⇒ Object 



246
247
248
249
 
# File 'ecs/cfn_task_definition.rb', line 246

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


117
118
119
 
# File 'ecs/cfn_task_definition.rb', line 117

def creation_stack()
  jsii_get_property("creationStack")
end

#enable_fault_injection ⇒ Boolean, ...

Enables fault injection and allows for fault injection requests to be accepted from the task's containers.

Returns:



254
255
256
 
# File 'ecs/cfn_task_definition.rb', line 254

def enable_fault_injection()
  jsii_get_property("enableFaultInjection")
end

#enable_fault_injection=(value) ⇒ Object 



258
259
260
261
 
# File 'ecs/cfn_task_definition.rb', line 258

def enable_fault_injection=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableFaultInjection") unless value.nil?
  jsii_set_property("enableFaultInjection", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



177
178
179
 
# File 'ecs/cfn_task_definition.rb', line 177

def env()
  jsii_get_property("env")
end

#ephemeral_storage ⇒ AWSCDK::IResolvable, ...

The ephemeral storage settings to use for tasks run with the task definition.

Returns:



266
267
268
 
# File 'ecs/cfn_task_definition.rb', line 266

def ephemeral_storage()
  jsii_get_property("ephemeralStorage")
end

#ephemeral_storage=(value) ⇒ Object 



270
271
272
273
274
 
# File 'ecs/cfn_task_definition.rb', line 270

def ephemeral_storage=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::EphemeralStorageProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uRXBoZW1lcmFsU3RvcmFnZVByb3BlcnR5In1dfX0=")), "ephemeralStorage") unless value.nil?
  jsii_set_property("ephemeralStorage", value)
end

#execution_role_arn ⇒ String?

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.

Returns:

  • (String, nil) 


279
280
281
 
# File 'ecs/cfn_task_definition.rb', line 279

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object 



283
284
285
286
 
# File 'ecs/cfn_task_definition.rb', line 283

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

#family ⇒ String?

The name of a family that this task definition is registered to.

Returns:

  • (String, nil) 


291
292
293
 
# File 'ecs/cfn_task_definition.rb', line 291

def family()
  jsii_get_property("family")
end

#family=(value) ⇒ Object 



295
296
297
298
 
# File 'ecs/cfn_task_definition.rb', line 295

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



651
652
653
654
655
 
# File 'ecs/cfn_task_definition.rb', line 651

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:



662
663
664
665
 
# File 'ecs/cfn_task_definition.rb', line 662

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inference_accelerators ⇒ AWSCDK::IResolvable, ...

Deprecated.

this property has been deprecated

Returns:



302
303
304
 
# File 'ecs/cfn_task_definition.rb', line 302

def inference_accelerators()
  jsii_get_property("inferenceAccelerators")
end

#inference_accelerators=(value) ⇒ Object 



306
307
308
309
 
# File 'ecs/cfn_task_definition.rb', line 306

def inference_accelerators=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLkluZmVyZW5jZUFjY2VsZXJhdG9yUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "inferenceAccelerators") unless value.nil?
  jsii_set_property("inferenceAccelerators", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



732
733
734
735
 
# File 'ecs/cfn_task_definition.rb', line 732

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

#ipc_mode ⇒ String?

The IPC resource namespace to use for the containers in the task.

Returns:

  • (String, nil) 


314
315
316
 
# File 'ecs/cfn_task_definition.rb', line 314

def ipc_mode()
  jsii_get_property("ipcMode")
end

#ipc_mode=(value) ⇒ Object 



318
319
320
321
 
# File 'ecs/cfn_task_definition.rb', line 318

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


129
130
131
 
# File 'ecs/cfn_task_definition.rb', line 129

def logical_id()
  jsii_get_property("logicalId")
end

#memory ⇒ String?

The amount (in MiB) of memory used by the task.

Returns:

  • (String, nil) 


326
327
328
 
# File 'ecs/cfn_task_definition.rb', line 326

def memory()
  jsii_get_property("memory")
end

#memory=(value) ⇒ Object 



330
331
332
333
 
# File 'ecs/cfn_task_definition.rb', line 330

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

#network_mode ⇒ String?

The Docker networking mode to use for the containers in the task.

Returns:

  • (String, nil) 


338
339
340
 
# File 'ecs/cfn_task_definition.rb', line 338

def network_mode()
  jsii_get_property("networkMode")
end

#network_mode=(value) ⇒ Object 



342
343
344
345
 
# File 'ecs/cfn_task_definition.rb', line 342

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


112
113
114
 
# File 'ecs/cfn_task_definition.rb', line 112

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



673
674
675
 
# File 'ecs/cfn_task_definition.rb', line 673

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:



680
681
682
 
# File 'ecs/cfn_task_definition.rb', line 680

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.



473
474
475
476
 
# File 'ecs/cfn_task_definition.rb', line 473

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

#pid_mode ⇒ String?

The process namespace to use for the containers in the task.

Returns:

  • (String, nil) 


350
351
352
 
# File 'ecs/cfn_task_definition.rb', line 350

def pid_mode()
  jsii_get_property("pidMode")
end

#pid_mode=(value) ⇒ Object 



354
355
356
357
 
# File 'ecs/cfn_task_definition.rb', line 354

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

#placement_constraints ⇒ AWSCDK::IResolvable, ...

An array of placement constraint objects to use for tasks.

Returns:



362
363
364
 
# File 'ecs/cfn_task_definition.rb', line 362

def placement_constraints()
  jsii_get_property("placementConstraints")
end

#placement_constraints=(value) ⇒ Object 



366
367
368
369
 
# File 'ecs/cfn_task_definition.rb', line 366

def placement_constraints=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLlRhc2tEZWZpbml0aW9uUGxhY2VtZW50Q29uc3RyYWludFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "placementConstraints") unless value.nil?
  jsii_set_property("placementConstraints", value)
end

#proxy_configuration ⇒ AWSCDK::IResolvable, ...

The configuration details for the App Mesh proxy.

Returns:



374
375
376
 
# File 'ecs/cfn_task_definition.rb', line 374

def proxy_configuration()
  jsii_get_property("proxyConfiguration")
end

#proxy_configuration=(value) ⇒ Object 



378
379
380
381
382
 
# File 'ecs/cfn_task_definition.rb', line 378

def proxy_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::ProxyConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uUHJveHlDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "proxyConfiguration") unless value.nil?
  jsii_set_property("proxyConfiguration", 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) 


148
149
150
 
# File 'ecs/cfn_task_definition.rb', line 148

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:



691
692
693
694
 
# File 'ecs/cfn_task_definition.rb', line 691

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


698
699
700
701
 
# File 'ecs/cfn_task_definition.rb', line 698

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:



708
709
710
711
712
 
# File 'ecs/cfn_task_definition.rb', line 708

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

#requires_compatibilities ⇒ Array<String>?

The task launch types the task definition was validated against.

Returns:

  • (Array<String>, nil) 


387
388
389
 
# File 'ecs/cfn_task_definition.rb', line 387

def requires_compatibilities()
  jsii_get_property("requiresCompatibilities")
end

#requires_compatibilities=(value) ⇒ Object 



391
392
393
394
 
# File 'ecs/cfn_task_definition.rb', line 391

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

#runtime_platform ⇒ AWSCDK::IResolvable, ...

The operating system that your tasks definitions run on.

Returns:



399
400
401
 
# File 'ecs/cfn_task_definition.rb', line 399

def runtime_platform()
  jsii_get_property("runtimePlatform")
end

#runtime_platform=(value) ⇒ Object 



403
404
405
406
407
 
# File 'ecs/cfn_task_definition.rb', line 403

def runtime_platform=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::RuntimePlatformProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uUnVudGltZVBsYXRmb3JtUHJvcGVydHkifV19fQ==")), "runtimePlatform") unless value.nil?
  jsii_set_property("runtimePlatform", 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.



717
718
719
 
# File 'ecs/cfn_task_definition.rb', line 717

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:



138
139
140
 
# File 'ecs/cfn_task_definition.rb', line 138

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



216
217
218
 
# File 'ecs/cfn_task_definition.rb', line 216

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The metadata that you apply to the task definition to help you categorize and organize them.

Returns:



412
413
414
 
# File 'ecs/cfn_task_definition.rb', line 412

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



416
417
418
419
420
 
# File 'ecs/cfn_task_definition.rb', line 416

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#task_definition_ref ⇒ AWSCDK::Interfaces::AWSECS::TaskDefinitionReference

A reference to a TaskDefinition resource.

Returns:



223
224
225
 
# File 'ecs/cfn_task_definition.rb', line 223

def task_definition_ref()
  jsii_get_property("taskDefinitionRef")
end

#task_role_arn ⇒ String?

The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.

Returns:

  • (String, nil) 


425
426
427
 
# File 'ecs/cfn_task_definition.rb', line 425

def task_role_arn()
  jsii_get_property("taskRoleArn")
end

#task_role_arn=(value) ⇒ Object 



429
430
431
432
 
# File 'ecs/cfn_task_definition.rb', line 429

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



449
450
451
 
# File 'ecs/cfn_task_definition.rb', line 449

def to_string()
  jsii_call_method("toString", [])
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}) 


185
186
187
 
# File 'ecs/cfn_task_definition.rb', line 185

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


195
196
197
 
# File 'ecs/cfn_task_definition.rb', line 195

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


723
724
725
726
 
# File 'ecs/cfn_task_definition.rb', line 723

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#volumes ⇒ AWSCDK::IResolvable, ...

The list of data volume definitions for the task.

Returns:



437
438
439
 
# File 'ecs/cfn_task_definition.rb', line 437

def volumes()
  jsii_get_property("volumes")
end

#volumes=(value) ⇒ Object 



441
442
443
444
 
# File 'ecs/cfn_task_definition.rb', line 441

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


462
463
464
465
466
467
 
# File 'ecs/cfn_task_definition.rb', line 462

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