Class: MintPress::Aws::ECS::TaskDefinition

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb

Properties (Read/Write)

  • #compatibilities ⇒ Array of ⇒ [String]
    'The launch type to use with your task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'compatibilities'
    

25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 25

property :compatibilities, disposition: :attribute, description: 'The launch type to use with your task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'compatibilities', type: [String], array: true
  • #container_definitions ⇒ Hash of ⇒ [MintPress::Aws::ECS::ContainerDefinition]
    'A list of container definitions in JSON format that describe the different containers that make up your task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'container_definitions'
    

26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 26

property :container_definitions, disposition: :attribute, description: 'A list of container definitions in JSON format that describe the different containers that make up your task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'container_definitions', type: [MintPress::Aws::ECS::ContainerDefinition], array: false, hash: true
  • #cpu ⇒ [String]
    'The number of cpu units used by the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'cpu'
    

27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 27

property :cpu, disposition: :attribute, description: 'The number of cpu units used by the task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'cpu', type: [String]
  • #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.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'execution_role_arn'
    

28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 28

property :execution_role_arn, disposition: :attribute, description: '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.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'execution_role_arn', type: [String]
  • #family ⇒ [String]
    'The name of a family that this task definition is registered to.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'family'
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 29

property :family, disposition: :attribute, description: 'The name of a family that this task definition is registered to.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'family', type: [String]
  • #inference_accelerators ⇒ Hash of ⇒ [MintPress::Aws::ECS::InferenceAccelerator]
    'The Elastic Inference accelerator associated with the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'inference_accelerators'
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 30

property :inference_accelerators, disposition: :attribute, description: 'The Elastic Inference accelerator associated with the task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'inference_accelerators', type: [MintPress::Aws::ECS::InferenceAccelerator], array: false, hash: true
  • #ipc_mode ⇒ [String]
    'The IPC resource namespace to use for the containers in the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'ipc_mode'
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 31

property :ipc_mode, disposition: :attribute, description: 'The IPC resource namespace to use for the containers in the task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'ipc_mode', type: [String]
  • #memory ⇒ [String]
    'The amount (in MiB) of memory used by the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'memory'
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 32

property :memory, disposition: :attribute, description: 'The amount (in MiB) of memory used by the task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'memory', type: [String]
  • #network_mode ⇒ [String]
    'The Docker networking mode to use for the containers in the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'network_mode'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 33

property :network_mode, disposition: :attribute, description: 'The Docker networking mode to use for the containers in the task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'network_mode', type: [String]
  • #pid_mode ⇒ [String]
    'The process namespace to use for the containers in the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'pid_mode'
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 34

property :pid_mode, disposition: :attribute, description: 'The process namespace to use for the containers in the task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'pid_mode', type: [String]
  • #placement_constraints ⇒ Array of ⇒ [MintPress::Aws::ECS::TaskDefinitionPlacementConstraint]
    'An array of placement constraint objects to use for tasks.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'placement_constraints'
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 35

property :placement_constraints, disposition: :attribute, description: 'An array of placement constraint objects to use for tasks.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'placement_constraints', type: [MintPress::Aws::ECS::TaskDefinitionPlacementConstraint], array: true
  • #proxy_configuration ⇒ [MintPress::Aws::ECS::ProxyConfiguration] (Default Value: MintPress::Aws::ECS::ProxyConfiguration.new)
    'The configuration details for the App Mesh proxy.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'proxy_configuration'
    • default ⇒ MintPress::Aws::ECS::ProxyConfiguration.new
    

36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 36

property :proxy_configuration, disposition: :attribute, description: 'The configuration details for the App Mesh proxy.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'proxy_configuration', type: [MintPress::Aws::ECS::ProxyConfiguration], default: MintPress::Aws::ECS::ProxyConfiguration.new
  • #requires_attributes ⇒ Hash of ⇒ [MintPress::Aws::ECS::Attribute]
    'The container instance attributes required by your task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'requires_attributes'
    

37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 37

property :requires_attributes, disposition: :attribute, description: 'The container instance attributes required by your task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'requires_attributes', type: [MintPress::Aws::ECS::Attribute], array: false, hash: true
  • #requires_compatibilities ⇒ Array of ⇒ [String]
    'The launch type the task requires.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'requires_compatibilities'
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 38

property :requires_compatibilities, disposition: :attribute, description: 'The launch type the task requires.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'requires_compatibilities', type: [String], array: true
  • #revision ⇒ [Integer]
    'The revision of the task in a particular family.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'revision'
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 39

property :revision, disposition: :attribute, description: 'The revision of the task in a particular family.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'revision', type: [Integer]
  • #status ⇒ [String]
    'The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.'
    Property Attributes
    • source ⇒ "list_task_definitions"
    • orig_name ⇒ 'status'
    • list_task_definitions_prop ⇒ 'status'
    • read_only ⇒ false
    

40
41
42
43
44
45
46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 40

property :status, description: 'The task definition status with which to filter the
ListTaskDefinitions results. By default, only ACTIVE task
definitions are listed. By setting this parameter to INACTIVE, you
can view task definitions that are INACTIVE as long as an active
task or service still references them. If you paginate the resulting
output, be sure to keep the status value constant in each subsequent
request.', source: "list_task_definitions", orig_name: 'status', type: [String], list_task_definitions_prop: 'status', read_only: false
  • #task_definition_arn ⇒ [String]
    'The full Amazon Resource Name (ARN) of the task definition.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'task_definition_arn'
    

47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 47

property :task_definition_arn, disposition: :attribute, description: 'The full Amazon Resource Name (ARN) of the task definition.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'task_definition_arn', type: [String]
  • #task_role_arn ⇒ [String]
    'The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'task_role_arn'
    

48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 48

property :task_role_arn, disposition: :attribute, description: 'The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'task_role_arn', type: [String]
  • #volumes ⇒ Hash of ⇒ [MintPress::Aws::ECS::Volume]
    'The list of volume definitions for the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::TaskDefinition"
    • orig_name ⇒ 'volumes'
    

49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 49

property :volumes, disposition: :attribute, description: 'The list of volume definitions for the task.', source: "MintPress::Aws::ECS::TaskDefinition", orig_name: 'volumes', type: [MintPress::Aws::ECS::Volume], array: false, hash: true
  • #task_definition ⇒ [String]
    'The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.'
    Property Attributes
    • describe_task_definition_prop ⇒ 'task_definition'
    • source ⇒ "describe_task_definition"
    

50
51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 50

property :task_definition, describe_task_definition_prop: 'task_definition', type: [String], source: "describe_task_definition", description: 'The family for the latest ACTIVE revision, family and revision
(family:revision) for a specific revision in the family, or full
Amazon Resource Name (ARN) of the task definition to describe.'
  • #include ⇒ Array of ⇒ [String]
    'Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.'
    Property Attributes
    • describe_task_definition_prop ⇒ 'include'
    • source ⇒ "describe_task_definition"
    

53
54
55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 53

property :include, describe_task_definition_prop: 'include', type: [String], array: true, source: "describe_task_definition", description: 'Specifies whether to see the resource tags for the task definition. If
TAGS is specified, the tags are included in the response. If this
field is omitted, tags are not included in the response.'
  • #family_prefix ⇒ [String]
    'The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.'
    Property Attributes
    • list_task_definitions_prop ⇒ 'family_prefix'
    • read_only ⇒ false
    • source ⇒ "list_task_definitions"
    

56
57
58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 56

property :family_prefix, list_task_definitions_prop: 'family_prefix', type: [String], read_only: false, source: "list_task_definitions", description: 'The full family name with which to filter the ListTaskDefinitions
results. Specifying a familyPrefix limits the listed task
definitions to task definition revisions that belong to that family.'
  • #sort ⇒ [String]
    'The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.'
    Property Attributes
    • list_task_definitions_prop ⇒ 'sort'
    • read_only ⇒ false
    • source ⇒ "list_task_definitions"
    

59
60
61
62
63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 59

property :sort, list_task_definitions_prop: 'sort', type: [String], read_only: false, source: "list_task_definitions", description: 'The order in which to sort the results. Valid values are ASC and
DESC. By default (ASC), task definitions are listed
lexicographically by family name and in ascending numerical order by
revision so that the newest task definitions in a family are listed
last. Setting this parameter to DESC reverses the sort order on
family name and revision so that the newest task definitions in a
family are listed first.'
  • #max_results ⇒ [Integer]
    'The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.'
    Property Attributes
    • list_task_definitions_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_task_definitions"
    

66
67
68
69
70
71
72
73
74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 66

property :max_results, list_task_definitions_prop: 'max_results', type: [Integer], read_only: false, source: "list_task_definitions", description: 'The maximum number of task definition results returned by
ListTaskDefinitions in paginated output. When this parameter is
used, ListTaskDefinitions only returns maxResults results in a
single page along with a nextToken response element. The remaining
results of the initial request can be seen by sending another
ListTaskDefinitions request with the returned nextToken value.
This value can be between 1 and 100. If this parameter is not used,
then ListTaskDefinitions returns up to 100 results and a nextToken
value if applicable.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

78
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 78

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

81
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task_definition.rb', line 81

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ TaskDefinition

Returns a new instance of TaskDefinition.

Instance Method Details

#describe ⇒ Object

#list ⇒ Object