Class: AWSCDK::ECS::CfnTaskDefinition::ContainerDefinitionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ecs/cfn_task_definition.rb

Overview

The ContainerDefinition property specifies a container definition.

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(image:, name:, command: nil, cpu: nil, credential_specs: nil, depends_on: nil, disable_networking: nil, dns_search_domains: nil, dns_servers: nil, docker_labels: nil, docker_security_options: nil, entry_point: nil, environment: nil, environment_files: nil, essential: nil, extra_hosts: nil, firelens_configuration: nil, health_check: nil, hostname: nil, interactive: nil, links: nil, linux_parameters: nil, log_configuration: nil, memory: nil, memory_reservation: nil, mount_points: nil, port_mappings: nil, privileged: nil, pseudo_terminal: nil, readonly_root_filesystem: nil, repository_credentials: nil, resource_requirements: nil, restart_policy: nil, secrets: nil, start_timeout: nil, stop_timeout: nil, system_controls: nil, ulimits: nil, user: nil, version_consistency: nil, volumes_from: nil, working_directory: nil) ⇒ ContainerDefinitionProperty

Returns a new instance of ContainerDefinitionProperty.

Parameters:



836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'ecs/cfn_task_definition.rb', line 836

def initialize(image:, name:, command: nil, cpu: nil, credential_specs: nil, depends_on: nil, disable_networking: nil, dns_search_domains: nil, dns_servers: nil, docker_labels: nil, docker_security_options: nil, entry_point: nil, environment: nil, environment_files: nil, essential: nil, extra_hosts: nil, firelens_configuration: nil, health_check: nil, hostname: nil, interactive: nil, links: nil, linux_parameters: nil, log_configuration: nil, memory: nil, memory_reservation: nil, mount_points: nil, port_mappings: nil, privileged: nil, pseudo_terminal: nil, readonly_root_filesystem: nil, repository_credentials: nil, resource_requirements: nil, restart_policy: nil, secrets: nil, start_timeout: nil, stop_timeout: nil, system_controls: nil, ulimits: nil, user: nil, version_consistency: nil, volumes_from: nil, working_directory: nil)
  @image = image
  Jsii::Type.check_type(@image, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "image")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @command = command
  Jsii::Type.check_type(@command, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "command") unless @command.nil?
  @cpu = cpu
  Jsii::Type.check_type(@cpu, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "cpu") unless @cpu.nil?
  @credential_specs = credential_specs
  Jsii::Type.check_type(@credential_specs, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "credentialSpecs") unless @credential_specs.nil?
  @depends_on = depends_on
  Jsii::Type.check_type(@depends_on, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLkNvbnRhaW5lckRlcGVuZGVuY3lQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "dependsOn") unless @depends_on.nil?
  @disable_networking = disable_networking
  Jsii::Type.check_type(@disable_networking, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableNetworking") unless @disable_networking.nil?
  @dns_search_domains = dns_search_domains
  Jsii::Type.check_type(@dns_search_domains, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dnsSearchDomains") unless @dns_search_domains.nil?
  @dns_servers = dns_servers
  Jsii::Type.check_type(@dns_servers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dnsServers") unless @dns_servers.nil?
  @docker_labels = docker_labels
  Jsii::Type.check_type(@docker_labels, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "dockerLabels") unless @docker_labels.nil?
  @docker_security_options = docker_security_options
  Jsii::Type.check_type(@docker_security_options, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dockerSecurityOptions") unless @docker_security_options.nil?
  @entry_point = entry_point
  Jsii::Type.check_type(@entry_point, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "entryPoint") unless @entry_point.nil?
  @environment = environment
  Jsii::Type.check_type(@environment, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLktleVZhbHVlUGFpclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "environment") unless @environment.nil?
  @environment_files = environment_files
  Jsii::Type.check_type(@environment_files, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLkVudmlyb25tZW50RmlsZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "environmentFiles") unless @environment_files.nil?
  @essential = essential
  Jsii::Type.check_type(@essential, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "essential") unless @essential.nil?
  @extra_hosts = extra_hosts
  Jsii::Type.check_type(@extra_hosts, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLkhvc3RFbnRyeVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "extraHosts") unless @extra_hosts.nil?
  @firelens_configuration = firelens_configuration.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::FirelensConfigurationProperty.new(**firelens_configuration.transform_keys(&:to_sym)) : firelens_configuration
  Jsii::Type.check_type(@firelens_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uRmlyZWxlbnNDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "firelensConfiguration") unless @firelens_configuration.nil?
  @health_check = health_check.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::HealthCheckProperty.new(**health_check.transform_keys(&:to_sym)) : health_check
  Jsii::Type.check_type(@health_check, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uSGVhbHRoQ2hlY2tQcm9wZXJ0eSJ9XX19")), "healthCheck") unless @health_check.nil?
  @hostname = hostname
  Jsii::Type.check_type(@hostname, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostname") unless @hostname.nil?
  @interactive = interactive
  Jsii::Type.check_type(@interactive, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "interactive") unless @interactive.nil?
  @links = links
  Jsii::Type.check_type(@links, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "links") unless @links.nil?
  @linux_parameters = linux_parameters.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::LinuxParametersProperty.new(**linux_parameters.transform_keys(&:to_sym)) : linux_parameters
  Jsii::Type.check_type(@linux_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uTGludXhQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "linuxParameters") unless @linux_parameters.nil?
  @log_configuration = log_configuration.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::LogConfigurationProperty.new(**log_configuration.transform_keys(&:to_sym)) : log_configuration
  Jsii::Type.check_type(@log_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uTG9nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "logConfiguration") unless @log_configuration.nil?
  @memory = memory
  Jsii::Type.check_type(@memory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "memory") unless @memory.nil?
  @memory_reservation = memory_reservation
  Jsii::Type.check_type(@memory_reservation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "memoryReservation") unless @memory_reservation.nil?
  @mount_points = mount_points
  Jsii::Type.check_type(@mount_points, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLk1vdW50UG9pbnRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "mountPoints") unless @mount_points.nil?
  @port_mappings = port_mappings
  Jsii::Type.check_type(@port_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLlBvcnRNYXBwaW5nUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "portMappings") unless @port_mappings.nil?
  @privileged = privileged
  Jsii::Type.check_type(@privileged, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "privileged") unless @privileged.nil?
  @pseudo_terminal = pseudo_terminal
  Jsii::Type.check_type(@pseudo_terminal, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "pseudoTerminal") unless @pseudo_terminal.nil?
  @readonly_root_filesystem = readonly_root_filesystem
  Jsii::Type.check_type(@readonly_root_filesystem, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "readonlyRootFilesystem") unless @readonly_root_filesystem.nil?
  @repository_credentials = repository_credentials.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::RepositoryCredentialsProperty.new(**repository_credentials.transform_keys(&:to_sym)) : repository_credentials
  Jsii::Type.check_type(@repository_credentials, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uUmVwb3NpdG9yeUNyZWRlbnRpYWxzUHJvcGVydHkifV19fQ==")), "repositoryCredentials") unless @repository_credentials.nil?
  @resource_requirements = resource_requirements
  Jsii::Type.check_type(@resource_requirements, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLlJlc291cmNlUmVxdWlyZW1lbnRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "resourceRequirements") unless @resource_requirements.nil?
  @restart_policy = restart_policy.is_a?(Hash) ? ::AWSCDK::ECS::CfnTaskDefinition::RestartPolicyProperty.new(**restart_policy.transform_keys(&:to_sym)) : restart_policy
  Jsii::Type.check_type(@restart_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuVGFza0RlZmluaXRpb24uUmVzdGFydFBvbGljeVByb3BlcnR5In1dfX0=")), "restartPolicy") unless @restart_policy.nil?
  @secrets = secrets
  Jsii::Type.check_type(@secrets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLlNlY3JldFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "secrets") unless @secrets.nil?
  @start_timeout = start_timeout
  Jsii::Type.check_type(@start_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "startTimeout") unless @start_timeout.nil?
  @stop_timeout = stop_timeout
  Jsii::Type.check_type(@stop_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "stopTimeout") unless @stop_timeout.nil?
  @system_controls = system_controls
  Jsii::Type.check_type(@system_controls, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLlN5c3RlbUNvbnRyb2xQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "systemControls") unless @system_controls.nil?
  @ulimits = ulimits
  Jsii::Type.check_type(@ulimits, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLlVsaW1pdFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "ulimits") unless @ulimits.nil?
  @user = user
  Jsii::Type.check_type(@user, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "user") unless @user.nil?
  @version_consistency = version_consistency
  Jsii::Type.check_type(@version_consistency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionConsistency") unless @version_consistency.nil?
  @volumes_from = volumes_from
  Jsii::Type.check_type(@volumes_from, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmblRhc2tEZWZpbml0aW9uLlZvbHVtZUZyb21Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "volumesFrom") unless @volumes_from.nil?
  @working_directory = working_directory
  Jsii::Type.check_type(@working_directory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workingDirectory") unless @working_directory.nil?
end

Instance Attribute Details

#command ⇒ Array<String>? (readonly)

The command that's passed to the container.

This parameter maps to Cmd in the docker container create command and the COMMAND parameter to docker run. If there are multiple arguments, each argument is a separated string in the array.

Returns:

  • (Array<String>, nil)

See Also:



949
950
951
 
# File 'ecs/cfn_task_definition.rb', line 949

def command
  @command
end

#cpu ⇒ Numeric? (readonly)

The number of cpu units reserved for the container.

This parameter maps to CpuShares in the docker container create command and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
  • Agent versions greater than or equal to 1.84.0: CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as 0 , which Windows interprets as 1% of one CPU.

Returns:

  • (Numeric, nil)

See Also:



970
971
972
 
# File 'ecs/cfn_task_definition.rb', line 970

def cpu
  @cpu
end

#credential_specs ⇒ Array<String>? (readonly)

A list of ARNs in SSM or Amazon S3 to a credential spec ( CredSpec ) file that configures the container for Active Directory authentication.

We recommend that you use this parameter instead of the docker_security_options . The maximum number of ARNs is 1.

There are two formats for each ARN.

  • credentialspecdomainless:MyARN - You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in AWS Secrets Manager . You provide the login credentials to the domain in the secret.

Each task that runs on any container instance can join different domains.

You can use this format without joining the container instance to a domain.

  • credentialspec:MyARN - You use credentialspec:MyARN to provide a CredSpec for a single domain.

You must join the container instance to the domain before you start any tasks that use this task definition.

In both formats, replace MyARN with the ARN in SSM or Amazon S3.

If you provide a credentialspecdomainless:MyARN , the credspec must provide a ARN in AWS Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers .

Returns:

  • (Array<String>, nil)

See Also:



993
994
995
 
# File 'ecs/cfn_task_definition.rb', line 993

def credential_specs
  @credential_specs
end

#depends_on ⇒ AWSCDK::IResolvable, ... (readonly)

The dependencies defined for container startup and shutdown.

A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide . If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.0 or later.

If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration , the depends_on parameter is not supported.

Returns:

See Also:



1009
1010
1011
 
# File 'ecs/cfn_task_definition.rb', line 1009

def depends_on
  @depends_on
end

#disable_networking ⇒ Boolean, ... (readonly)

When this parameter is true, networking is off within the container.

This parameter maps to NetworkDisabled in the docker container create command.

This parameter is not supported for Windows containers.

Returns:

See Also:



1018
1019
1020
 
# File 'ecs/cfn_task_definition.rb', line 1018

def disable_networking
  @disable_networking
end

#dns_search_domains ⇒ Array<String>? (readonly)

A list of DNS search domains that are presented to the container.

This parameter maps to DnsSearch in the docker container create command and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

Returns:

  • (Array<String>, nil)

See Also:



1027
1028
1029
 
# File 'ecs/cfn_task_definition.rb', line 1027

def dns_search_domains
  @dns_search_domains
end

#dns_servers ⇒ Array<String>? (readonly)

A list of DNS servers that are presented to the container.

This parameter maps to Dns in the docker container create command and the --dns option to docker run.

This parameter is not supported for Windows containers.

Returns:

  • (Array<String>, nil)

See Also:



1036
1037
1038
 
# File 'ecs/cfn_task_definition.rb', line 1036

def dns_servers
  @dns_servers
end

#docker_labels ⇒ AWSCDK::IResolvable, ... (readonly)

A key/value map of labels to add to the container.

This parameter maps to Labels in the docker container create command and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

Returns:

See Also:



1043
1044
1045
 
# File 'ecs/cfn_task_definition.rb', line 1043

def docker_labels
  @docker_labels
end

#docker_security_options ⇒ Array<String>? (readonly)

A list of strings to provide custom configuration for multiple security systems.

This field isn't valid for containers in tasks using the Fargate launch type.

For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.

For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide .

This parameter maps to SecurityOpt in the docker container create command and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .

Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Returns:

  • (Array<String>, nil)

See Also:



1060
1061
1062
 
# File 'ecs/cfn_task_definition.rb', line 1060

def docker_security_options
  @docker_security_options
end

#entry_point ⇒ Array<String>? (readonly)

Early versions of the Amazon ECS container agent don't properly handle entryPoint parameters.

If you have problems using entry_point , update your container agent or enter your commands and arguments as command array items instead.

The entry point that's passed to the container. This parameter maps to Entrypoint in the docker container create command and the --entrypoint option to docker run.

Returns:

  • (Array<String>, nil)

See Also:



1069
1070
1071
 
# File 'ecs/cfn_task_definition.rb', line 1069

def entry_point
  @entry_point
end

#environment ⇒ AWSCDK::IResolvable, ... (readonly)

The environment variables to pass to a container.

This parameter maps to Env in the docker container create command and the --env option to docker run.

We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.

Returns:

See Also:



1078
1079
1080
 
# File 'ecs/cfn_task_definition.rb', line 1078

def environment
  @environment
end

#environment_files ⇒ AWSCDK::IResolvable, ... (readonly)

A list of files containing the environment variables to pass to a container.

This parameter maps to the --env-file option to docker run.

You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file contains an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide .

Returns:

See Also:



1089
1090
1091
 
# File 'ecs/cfn_task_definition.rb', line 1089

def environment_files
  @environment_files
end

#essential ⇒ Boolean, ... (readonly)

If the essential parameter of a container is marked as true , and that container fails or stops for any reason, all other containers that are part of the task are stopped.

If the essential parameter of a container is marked as false , its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide .

Returns:

See Also:



1098
1099
1100
 
# File 'ecs/cfn_task_definition.rb', line 1098

def essential
  @essential
end

#extra_hosts ⇒ AWSCDK::IResolvable, ... (readonly)

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

This parameter maps to ExtraHosts in the docker container create command and the --add-host option to docker run.

This parameter isn't supported for Windows containers or tasks that use the awsvpc network mode.

Returns:

See Also:



1107
1108
1109
 
# File 'ecs/cfn_task_definition.rb', line 1107

def extra_hosts
  @extra_hosts
end

#firelens_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The FireLens configuration for the container.

This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide .

Returns:

See Also:



1114
1115
1116
 
# File 'ecs/cfn_task_definition.rb', line 1114

def firelens_configuration
  @firelens_configuration
end

#health_check ⇒ AWSCDK::IResolvable, ... (readonly)

The container health check command and associated configuration parameters for the container.

This parameter maps to HealthCheck in the docker container create command and the HEALTHCHECK parameter of docker run.

Returns:

See Also:



1121
1122
1123
 
# File 'ecs/cfn_task_definition.rb', line 1121

def health_check
  @health_check
end

#hostname ⇒ String? (readonly)

The hostname to use for your container.

This parameter maps to Hostname in the docker container create command and the --hostname option to docker run.

The hostname parameter is not supported if you're using the awsvpc network mode.

Returns:

  • (String, nil)

See Also:



1130
1131
1132
 
# File 'ecs/cfn_task_definition.rb', line 1130

def hostname
  @hostname
end

#image ⇒ String (readonly)

The image used to start a container.

This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either *repository-url* / *image* : *tag* or *repository-url* / *image* @ *digest* . For images using tags (repository-url/image:tag), up to 255 characters total are allowed, including letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs (#). For images using digests (repository-url/image@digest), the 255 character limit applies only to the repository URL and image name (everything before the @ sign). The only supported hash function is sha256, and the hash value after sha256: must be exactly 64 characters (only letters A-F, a-f, and numbers 0-9 are allowed). This parameter maps to Image in the docker container create command and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest . For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE .
  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo ).
  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent ).
  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu ).

Returns:

  • (String)

See Also:



935
936
937
 
# File 'ecs/cfn_task_definition.rb', line 935

def image
  @image
end

#interactive ⇒ Boolean, ... (readonly)

When this parameter is true , you can deploy containerized applications that require stdin or a tty to be allocated.

This parameter maps to OpenStdin in the docker container create command and the --interactive option to docker run.

Returns:

See Also:



1137
1138
1139
 
# File 'ecs/cfn_task_definition.rb', line 1137

def interactive
  @interactive
end

#links ⇒ Array<String>? (readonly)

The links parameter allows containers to communicate with each other without the need for port mappings.

This parameter is only supported if the network mode of a task definition is bridge . The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to Links in the docker container create command and the --link option to docker run.

This parameter is not supported for Windows containers. > Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

Returns:

  • (Array<String>, nil)

See Also:



1146
1147
1148
 
# File 'ecs/cfn_task_definition.rb', line 1146

def links
  @links
end

#linux_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities .

This parameter is not supported for Windows containers.

Returns:

See Also:



1153
1154
1155
 
# File 'ecs/cfn_task_definition.rb', line 1153

def linux_parameters
  @linux_parameters
end

#log_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The log configuration specification for the container.

This parameter maps to LogConfig in the docker Create a container command and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the ECSlong Developer Guide .

Returns:

See Also:



1166
1167
1168
 
# File 'ecs/cfn_task_definition.rb', line 1166

def log_configuration
  @log_configuration
end

#memory ⇒ Numeric? (readonly)

The amount (in MiB) of memory to present to the container.

If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run .

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memory_reservation value, memory must be greater than memory_reservation . If you specify memory_reservation , then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

Returns:

  • (Numeric, nil)

See Also:



1181
1182
1183
 
# File 'ecs/cfn_task_definition.rb', line 1181

def memory
  @memory
end

#memory_reservation ⇒ Numeric? (readonly)

The soft limit (in MiB) of memory to reserve for the container.

When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the docker container create command and the --memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memory_reservation in a container definition. If you specify both, memory must be greater than memory_reservation . If you specify memory_reservation , then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memory_reservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

Returns:

  • (Numeric, nil)

See Also:



1196
1197
1198
 
# File 'ecs/cfn_task_definition.rb', line 1196

def memory_reservation
  @memory_reservation
end

#mount_points ⇒ AWSCDK::IResolvable, ... (readonly)

The mount points for data volumes in your container.

This parameter maps to Volumes in the docker container create command and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData . Windows containers can't mount directories on a different drive, and mount point can't be across drives.

Returns:

See Also:



1205
1206
1207
 
# File 'ecs/cfn_task_definition.rb', line 1205

def mount_points
  @mount_points
end

#name ⇒ String (readonly)

The name of a container.

If you're linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the docker container create command and the --name option to docker run.

Returns:

  • (String)

See Also:



942
943
944
 
# File 'ecs/cfn_task_definition.rb', line 942

def name
  @name
end

#port_mappings ⇒ AWSCDK::IResolvable, ... (readonly)

The list of port mappings for the container.

Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the container_port . The host_port can be left blank or it must be the same value as the container_port .

Port mappings on Windows use the NetNAT gateway address rather than localhost . There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run . If the network mode of a task definition is set to none , then you can't specify port mappings. If the network mode of a task definition is set to host , then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the network_bindings section DescribeTasks responses.

Returns:

See Also:



1220
1221
1222
 
# File 'ecs/cfn_task_definition.rb', line 1220

def port_mappings
  @port_mappings
end

#privileged ⇒ Boolean, ... (readonly)

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

This parameter maps to Privileged in the docker container create command and the --privileged option to docker run

This parameter is not supported for Windows containers or tasks run on AWS Fargate .

Returns:

See Also:



1229
1230
1231
 
# File 'ecs/cfn_task_definition.rb', line 1229

def privileged
  @privileged
end

#pseudo_terminal ⇒ Boolean, ... (readonly)

When this parameter is true , a TTY is allocated.

This parameter maps to Tty in the docker container create command and the --tty option to docker run.

Returns:

See Also:



1236
1237
1238
 
# File 'ecs/cfn_task_definition.rb', line 1236

def pseudo_terminal
  @pseudo_terminal
end

#readonly_root_filesystem ⇒ Boolean, ... (readonly)

When this parameter is true, the container is given read-only access to its root file system.

This parameter maps to ReadonlyRootfs in the docker container create command and the --read-only option to docker run.

This parameter is not supported for Windows containers.

Returns:

See Also:



1245
1246
1247
 
# File 'ecs/cfn_task_definition.rb', line 1245

def readonly_root_filesystem
  @readonly_root_filesystem
end

#repository_credentials ⇒ AWSCDK::IResolvable, ... (readonly)

The private repository authentication credentials to use.

Returns:

See Also:



1250
1251
1252
 
# File 'ecs/cfn_task_definition.rb', line 1250

def repository_credentials
  @repository_credentials
end

#resource_requirements ⇒ AWSCDK::IResolvable, ... (readonly)

The type and amount of a resource to assign to a container.

The only supported resource is a GPU.

Returns:

See Also:



1257
1258
1259
 
# File 'ecs/cfn_task_definition.rb', line 1257

def resource_requirements
  @resource_requirements
end

#restart_policy ⇒ AWSCDK::IResolvable, ... (readonly)

The restart policy for a container.

When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide .

Returns:

See Also:



1264
1265
1266
 
# File 'ecs/cfn_task_definition.rb', line 1264

def restart_policy
  @restart_policy
end

#secrets ⇒ AWSCDK::IResolvable, ... (readonly)

The secrets to pass to the container.

For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide .

Returns:

See Also:



1271
1272
1273
 
# File 'ecs/cfn_task_definition.rb', line 1271

def secrets
  @secrets
end

#start_timeout ⇒ Numeric? (readonly)

Time duration (in seconds) to wait before giving up on resolving dependencies for a container.

For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE , SUCCESS , or HEALTHY status. If a start_timeout value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.

When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it's enforced independently from this start timeout value.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.0 or later.

For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide . If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .

The valid values for Fargate are 2-120 seconds.

Returns:

  • (Numeric, nil)

See Also:



1289
1290
1291
 
# File 'ecs/cfn_task_definition.rb', line 1289

def start_timeout
  @start_timeout
end

#stop_timeout ⇒ Numeric? (readonly)

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.
  • Windows platform version 1.0.0 or later.

For tasks that use the Fargate launch type, the max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks that use the EC2 launch type, if the stop_timeout parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stop_timeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide . If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .

The valid values for Fargate are 2-120 seconds.

Returns:

  • (Numeric, nil)

See Also:



1305
1306
1307
 
# File 'ecs/cfn_task_definition.rb', line 1305

def stop_timeout
  @stop_timeout
end

#system_controls ⇒ AWSCDK::IResolvable, ... (readonly)

A list of namespaced kernel parameters to set in the container.

This parameter maps to Sysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain longer lived connections.

Returns:

See Also:



1312
1313
1314
 
# File 'ecs/cfn_task_definition.rb', line 1312

def system_controls
  @system_controls
end

#ulimits ⇒ AWSCDK::IResolvable, ... (readonly)

A list of ulimits to set in the container.

This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run . Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

Returns:

See Also:



1321
1322
1323
 
# File 'ecs/cfn_task_definition.rb', line 1321

def ulimits
  @ulimits
end

#user ⇒ String? (readonly)

The user to use inside the container.

This parameter maps to User in the docker container create command and the --user option to docker run.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user
  • user:group
  • uid
  • uid:gid
  • user:gid
  • uid:group

This parameter is not supported for Windows containers.

Returns:

  • (String, nil)

See Also:



1341
1342
1343
 
# File 'ecs/cfn_task_definition.rb', line 1341

def user
  @user
end

#version_consistency ⇒ String? (readonly)

Note:

Default: - "enabled"

Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest.

By default, the value is enabled . If you set the value for a container as disabled , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see Container image resolution in the Amazon ECS Developer Guide .

Returns:

  • (String, nil)

See Also:



1349
1350
1351
 
# File 'ecs/cfn_task_definition.rb', line 1349

def version_consistency
  @version_consistency
end

#volumes_from ⇒ AWSCDK::IResolvable, ... (readonly)

Data volumes to mount from another container.

This parameter maps to VolumesFrom in the docker container create command and the --volumes-from option to docker run.

Returns:

See Also:



1356
1357
1358
 
# File 'ecs/cfn_task_definition.rb', line 1356

def volumes_from
  @volumes_from
end

#working_directory ⇒ String? (readonly)

The working directory to run commands inside the container in.

This parameter maps to WorkingDir in the docker container create command and the --workdir option to docker run.

Returns:

  • (String, nil)

See Also:



1363
1364
1365
 
# File 'ecs/cfn_task_definition.rb', line 1363

def working_directory
  @working_directory
end

Class Method Details

.jsii_properties ⇒ Object 



1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'ecs/cfn_task_definition.rb', line 1365

def self.jsii_properties
  {
    :image => "image",
    :name => "name",
    :command => "command",
    :cpu => "cpu",
    :credential_specs => "credentialSpecs",
    :depends_on => "dependsOn",
    :disable_networking => "disableNetworking",
    :dns_search_domains => "dnsSearchDomains",
    :dns_servers => "dnsServers",
    :docker_labels => "dockerLabels",
    :docker_security_options => "dockerSecurityOptions",
    :entry_point => "entryPoint",
    :environment => "environment",
    :environment_files => "environmentFiles",
    :essential => "essential",
    :extra_hosts => "extraHosts",
    :firelens_configuration => "firelensConfiguration",
    :health_check => "healthCheck",
    :hostname => "hostname",
    :interactive => "interactive",
    :links => "links",
    :linux_parameters => "linuxParameters",
    :log_configuration => "logConfiguration",
    :memory => "memory",
    :memory_reservation => "memoryReservation",
    :mount_points => "mountPoints",
    :port_mappings => "portMappings",
    :privileged => "privileged",
    :pseudo_terminal => "pseudoTerminal",
    :readonly_root_filesystem => "readonlyRootFilesystem",
    :repository_credentials => "repositoryCredentials",
    :resource_requirements => "resourceRequirements",
    :restart_policy => "restartPolicy",
    :secrets => "secrets",
    :start_timeout => "startTimeout",
    :stop_timeout => "stopTimeout",
    :system_controls => "systemControls",
    :ulimits => "ulimits",
    :user => "user",
    :version_consistency => "versionConsistency",
    :volumes_from => "volumesFrom",
    :working_directory => "workingDirectory",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
 
# File 'ecs/cfn_task_definition.rb', line 1412

def to_jsii
  result = {}
  result.merge!({
    "image" => @image,
    "name" => @name,
    "command" => @command,
    "cpu" => @cpu,
    "credentialSpecs" => @credential_specs,
    "dependsOn" => @depends_on,
    "disableNetworking" => @disable_networking,
    "dnsSearchDomains" => @dns_search_domains,
    "dnsServers" => @dns_servers,
    "dockerLabels" => @docker_labels,
    "dockerSecurityOptions" => @docker_security_options,
    "entryPoint" => @entry_point,
    "environment" => @environment,
    "environmentFiles" => @environment_files,
    "essential" => @essential,
    "extraHosts" => @extra_hosts,
    "firelensConfiguration" => @firelens_configuration,
    "healthCheck" => @health_check,
    "hostname" => @hostname,
    "interactive" => @interactive,
    "links" => @links,
    "linuxParameters" => @linux_parameters,
    "logConfiguration" => @log_configuration,
    "memory" => @memory,
    "memoryReservation" => @memory_reservation,
    "mountPoints" => @mount_points,
    "portMappings" => @port_mappings,
    "privileged" => @privileged,
    "pseudoTerminal" => @pseudo_terminal,
    "readonlyRootFilesystem" => @readonly_root_filesystem,
    "repositoryCredentials" => @repository_credentials,
    "resourceRequirements" => @resource_requirements,
    "restartPolicy" => @restart_policy,
    "secrets" => @secrets,
    "startTimeout" => @start_timeout,
    "stopTimeout" => @stop_timeout,
    "systemControls" => @system_controls,
    "ulimits" => @ulimits,
    "user" => @user,
    "versionConsistency" => @version_consistency,
    "volumesFrom" => @volumes_from,
    "workingDirectory" => @working_directory,
  })
  result.compact
end