Module: AWSCDK::Batch::IECSFargateContainerDefinition

Includes:
IECSContainerDefinition
Included in:
ECSFargateContainerDefinition
Defined in:
batch/iecs_fargate_container_definition.rb

Overview

A container orchestrated by ECS that uses Fargate resources and is orchestrated by ECS.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'batch/iecs_fargate_container_definition.rb', line 206

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :cpu => { kind: :property, name: "cpu", is_optional: false },
    :execution_role => { kind: :property, name: "executionRole", is_optional: false },
    :image => { kind: :property, name: "image", is_optional: false },
    :memory => { kind: :property, name: "memory", is_optional: false },
    :volumes => { kind: :property, name: "volumes", is_optional: false },
    :command => { kind: :property, name: "command", is_optional: true },
    :enable_execute_command => { kind: :property, name: "enableExecuteCommand", is_optional: true },
    :environment => { kind: :property, name: "environment", is_optional: true },
    :job_role => { kind: :property, name: "jobRole", is_optional: true },
    :linux_parameters => { kind: :property, name: "linuxParameters", is_optional: true },
    :log_driver_config => { kind: :property, name: "logDriverConfig", is_optional: true },
    :readonly_root_filesystem => { kind: :property, name: "readonlyRootFilesystem", is_optional: true },
    :secrets => { kind: :property, name: "secrets", is_optional: true },
    :user => { kind: :property, name: "user", is_optional: true },
    :assign_public_ip => { kind: :property, name: "assignPublicIp", is_optional: true },
    :ephemeral_storage_size => { kind: :property, name: "ephemeralStorageSize", is_optional: true },
    :fargate_cpu_architecture => { kind: :property, name: "fargateCpuArchitecture", is_optional: true },
    :fargate_operating_system_family => { kind: :property, name: "fargateOperatingSystemFamily", is_optional: true },
    :fargate_platform_version => { kind: :property, name: "fargatePlatformVersion", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :add_volume => { kind: :method, name: "addVolume", is_optional: false },
  }
end

Instance Method Details

#add_volume(volume) ⇒ void

This method returns an undefined value.

Add a Volume to this container.

Parameters:



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

def add_volume(volume)
  Jsii::Type.check_type(volume, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmF0Y2guRWNzVm9sdW1lIn0=")), "volume")
  jsii_call_method("addVolume", [volume])
end

#assign_public_ip ⇒ Boolean?

Note:

Default: false

Indicates whether the job has a public IP address.

For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet.

Returns:

  • (Boolean, nil)

See Also:



147
148
149
 
# File 'batch/iecs_fargate_container_definition.rb', line 147

def assign_public_ip()
  jsii_get_property("assignPublicIp")
end

#command ⇒ Array<String>?

The command that's passed to the container.

Returns:

  • (Array<String>, nil)

See Also:



64
65
66
 
# File 'batch/iecs_fargate_container_definition.rb', line 64

def command()
  jsii_get_property("command")
end

#cpu ⇒ Numeric

The number of vCPUs reserved for the container.

Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.

Returns:

  • (Numeric) 


21
22
23
 
# File 'batch/iecs_fargate_container_definition.rb', line 21

def cpu()
  jsii_get_property("cpu")
end

#enable_execute_command ⇒ Boolean?

Note:

Default: undefined - AWS Batch default is false

Whether to enable ecs exec for this container.

Returns:

  • (Boolean, nil) 


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

def enable_execute_command()
  jsii_get_property("enableExecuteCommand")
end

#environment ⇒ Hash{String => String}?

Note:

Default: - no environment variables

The environment variables to pass to a container.

Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Returns:

  • (Hash{String => String}, nil) 


83
84
85
 
# File 'batch/iecs_fargate_container_definition.rb', line 83

def environment()
  jsii_get_property("environment")
end

#ephemeral_storage_size ⇒ AWSCDK::Size?

Note:

Default: - 20 GiB

The size for ephemeral storage.

Returns:



155
156
157
 
# File 'batch/iecs_fargate_container_definition.rb', line 155

def ephemeral_storage_size()
  jsii_get_property("ephemeralStorageSize")
end

#execution_role ⇒ AWSCDK::IAM::IRole

The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.

Returns:

See Also:



29
30
31
 
# File 'batch/iecs_fargate_container_definition.rb', line 29

def execution_role()
  jsii_get_property("executionRole")
end

#fargate_cpu_architecture ⇒ AWSCDK::ECS::CpuArchitecture?

Note:

Default: - X86_64

The vCPU architecture of Fargate Runtime.

Returns:



163
164
165
 
# File 'batch/iecs_fargate_container_definition.rb', line 163

def fargate_cpu_architecture()
  jsii_get_property("fargateCpuArchitecture")
end

#fargate_operating_system_family ⇒ AWSCDK::ECS::OperatingSystemFamily?

Note:

Default: - LINUX

The operating system for the compute environment.

Returns:



171
172
173
 
# File 'batch/iecs_fargate_container_definition.rb', line 171

def fargate_operating_system_family()
  jsii_get_property("fargateOperatingSystemFamily")
end

#fargate_platform_version ⇒ AWSCDK::ECS::FargatePlatformVersion?

Note:

Default: LATEST

Which version of Fargate to use when running this container.

Returns:



179
180
181
 
# File 'batch/iecs_fargate_container_definition.rb', line 179

def fargate_platform_version()
  jsii_get_property("fargatePlatformVersion")
end

#image ⇒ AWSCDK::ECS::ContainerImage

The image that this container will run.

Returns:



36
37
38
 
# File 'batch/iecs_fargate_container_definition.rb', line 36

def image()
  jsii_get_property("image")
end

#job_role ⇒ AWSCDK::IAM::IRole?

Note:

Default: - no jobRole

The role that the container can assume.

Returns:

See Also:



92
93
94
 
# File 'batch/iecs_fargate_container_definition.rb', line 92

def job_role()
  jsii_get_property("jobRole")
end

#linux_parameters ⇒ AWSCDK::Batch::LinuxParameters?

Note:

Default: none

Linux-specific modifications that are applied to the container, such as details for device mappings.

Returns:



100
101
102
 
# File 'batch/iecs_fargate_container_definition.rb', line 100

def linux_parameters()
  jsii_get_property("linuxParameters")
end

#log_driver_config ⇒ AWSCDK::ECS::LogDriverConfig?

The configuration of the log driver.

Returns:



107
108
109
 
# File 'batch/iecs_fargate_container_definition.rb', line 107

def log_driver_config()
  jsii_get_property("logDriverConfig")
end

#memory ⇒ AWSCDK::Size

The memory hard limit present to the container.

If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job.

Returns:



46
47
48
 
# File 'batch/iecs_fargate_container_definition.rb', line 46

def memory()
  jsii_get_property("memory")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#readonly_root_filesystem ⇒ Boolean?

Note:

Default: false

Gives the container readonly access to its root filesystem.

Returns:

  • (Boolean, nil) 


115
116
117
 
# File 'batch/iecs_fargate_container_definition.rb', line 115

def readonly_root_filesystem()
  jsii_get_property("readonlyRootFilesystem")
end

#secrets ⇒ Hash{String => AWSCDK::Batch::Secret}?

Note:

Default: - no secrets

A map from environment variable names to the secrets for the container.

Allows your job definitions to reference the secret by the environment variable name defined in this property.

Returns:

See Also:



127
128
129
 
# File 'batch/iecs_fargate_container_definition.rb', line 127

def secrets()
  jsii_get_property("secrets")
end

#user ⇒ String?

Note:

Default: - no user

The user name to use inside the container.

Returns:

  • (String, nil) 


135
136
137
 
# File 'batch/iecs_fargate_container_definition.rb', line 135

def user()
  jsii_get_property("user")
end

#volumes ⇒ Array<AWSCDK::Batch::ECSVolume>

Note:

Default: - no volumes

The volumes to mount to this container.

Automatically added to the job definition.

Returns:



56
57
58
 
# File 'batch/iecs_fargate_container_definition.rb', line 56

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



190
191
192
193
194
195
 
# File 'batch/iecs_fargate_container_definition.rb', line 190

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