Class: MintPress::Aws::ECS::Task

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

Properties (Read/Write)

  • #attachments ⇒ Hash of ⇒ [MintPress::Aws::ECS::Attachment]
    'The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'attachments'
    

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

property :attachments, disposition: :attribute, description: 'The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.', source: "MintPress::Aws::ECS::Task", orig_name: 'attachments', type: [MintPress::Aws::ECS::Attachment], array: false, hash: true
  • #attributes ⇒ Hash of ⇒ [MintPress::Aws::ECS::Attribute]
    'The attributes of the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'attributes'
    

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

property :attributes, disposition: :attribute, description: 'The attributes of the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'attributes', type: [MintPress::Aws::ECS::Attribute], array: false, hash: true
  • #availability_zone ⇒ [String]
    'The availability zone of the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'availability_zone'
    

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

property :availability_zone, disposition: :attribute, description: 'The availability zone of the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'availability_zone', type: [String]
  • #capacity_provider_name ⇒ [String]
    'The capacity provider associated with the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'capacity_provider_name'
    

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

property :capacity_provider_name, disposition: :attribute, description: 'The capacity provider associated with the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'capacity_provider_name', type: [String]
  • #cluster_arn ⇒ [String]
    'The ARN of the cluster that hosts the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'cluster_arn'
    

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

property :cluster_arn, disposition: :attribute, description: 'The ARN of the cluster that hosts the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'cluster_arn', type: [String]
  • #connectivity ⇒ [String]
    'The connectivity status of a task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'connectivity'
    

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

property :connectivity, disposition: :attribute, description: 'The connectivity status of a task.', source: "MintPress::Aws::ECS::Task", orig_name: 'connectivity', type: [String]
  • #connectivity_at ⇒ [Time]
    'The Unix timestamp for when the task last went into CONNECTED status.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'connectivity_at'
    

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

property :connectivity_at, disposition: :attribute, description: 'The Unix timestamp for when the task last went into CONNECTED status.', source: "MintPress::Aws::ECS::Task", orig_name: 'connectivity_at', type: [Time]
  • #container_instance_arn ⇒ [String]
    'The ARN of the container instances that host the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'container_instance_arn'
    

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

property :container_instance_arn, disposition: :attribute, description: 'The ARN of the container instances that host the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'container_instance_arn', type: [String]
  • #containers ⇒ Hash of ⇒ [MintPress::Aws::ECS::Container]
    'The containers associated with the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'containers'
    

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

property :containers, disposition: :attribute, description: 'The containers associated with the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'containers', type: [MintPress::Aws::ECS::Container], array: false, hash: true
  • #cpu ⇒ [String]
    'The number of CPU units used by the task as expressed in a task definition.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'cpu'
    

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

property :cpu, disposition: :attribute, description: 'The number of CPU units used by the task as expressed in a task definition.', source: "MintPress::Aws::ECS::Task", orig_name: 'cpu', type: [String]
  • #created_at ⇒ [Time]
    'The Unix timestamp for when the task was created (the task entered the PENDING state).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The Unix timestamp for when the task was created (the task entered the PENDING state).', source: "MintPress::Aws::ECS::Task", orig_name: 'created_at', type: [Time]
  • #desired_status ⇒ [String]
    'The desired status of the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'desired_status'
    • list_tasks_prop ⇒ 'desired_status'
    • read_only ⇒ false
    

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

property :desired_status, disposition: :attribute, description: 'The desired status of the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'desired_status', type: [String], list_tasks_prop: 'desired_status', read_only: false
  • #execution_stopped_at ⇒ [Time]
    'The Unix timestamp for when the task execution stopped.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'execution_stopped_at'
    

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

property :execution_stopped_at, disposition: :attribute, description: 'The Unix timestamp for when the task execution stopped.', source: "MintPress::Aws::ECS::Task", orig_name: 'execution_stopped_at', type: [Time]
  • #group ⇒ [String]
    'The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).'
    Property Attributes
    • source ⇒ "start_task"
    • orig_name ⇒ 'group'
    • start_task_prop ⇒ 'group'
    • read_only ⇒ false
    

43
44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 43

property :group, description: 'The name of the task group to associate with the task. The default
value is the family name of the task definition (for example,
family:my-family-name).', source: "start_task", orig_name: 'group', type: [String], start_task_prop: 'group', read_only: false
  • #health_status ⇒ [String]
    'The health status for the task, which is determined by the health of the essential containers in the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'health_status'
    

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

property :health_status, disposition: :attribute, description: 'The health status for the task, which is determined by the health of the essential containers in the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'health_status', 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::Task"
    • orig_name ⇒ 'inference_accelerators'
    

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

property :inference_accelerators, disposition: :attribute, description: 'The Elastic Inference accelerator associated with the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'inference_accelerators', type: [MintPress::Aws::ECS::InferenceAccelerator], array: false, hash: true
  • #last_status ⇒ [String]
    'The last known status of the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'last_status'
    

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

property :last_status, disposition: :attribute, description: 'The last known status of the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'last_status', type: [String]
  • #launch_type ⇒ [String]
    'The launch type on which your task is running.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'launch_type'
    • list_tasks_prop ⇒ 'launch_type'
    • read_only ⇒ false
    

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

property :launch_type, disposition: :attribute, description: 'The launch type on which your task is running.', source: "MintPress::Aws::ECS::Task", orig_name: 'launch_type', type: [String], list_tasks_prop: 'launch_type', read_only: false
  • #memory ⇒ [String]
    'The amount of memory (in MiB) used by the task as expressed in a task definition.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'memory'
    

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

property :memory, disposition: :attribute, description: 'The amount of memory (in MiB) used by the task as expressed in a task definition.', source: "MintPress::Aws::ECS::Task", orig_name: 'memory', type: [String]
  • #overrides ⇒ [MintPress::Aws::ECS::TaskOverride] (Default Value: MintPress::Aws::ECS::TaskOverride.new)
    'A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.'
    Property Attributes
    • source ⇒ "start_task"
    • orig_name ⇒ 'overrides'
    • default ⇒ MintPress::Aws::ECS::TaskOverride.new
    • start_task_prop ⇒ 'overrides'
    • read_only ⇒ false
    

51
52
53
54
55
56
57
58
59
60
61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 51

property :overrides, description: 'A list of container overrides in JSON format that specify the name of
a container in the specified task definition and the overrides it
should receive. You can override the default command for a container
(that is specified in the task definition or Docker image) with a
command override. You can also override existing environment
variables (that are specified in the task definition or Docker image)
on a container or add new environment variables to it with an
environment override.

 A total of 8192 characters are allowed for overrides. This limit
includes the JSON formatting characters of the override structure.', source: "start_task", orig_name: 'overrides', type: [MintPress::Aws::ECS::TaskOverride], default: MintPress::Aws::ECS::TaskOverride.new, start_task_prop: 'overrides', read_only: false
  • #platform_version ⇒ [String]
    'The platform version on which your task is running.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'platform_version'
    

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

property :platform_version, disposition: :attribute, description: 'The platform version on which your task is running.', source: "MintPress::Aws::ECS::Task", orig_name: 'platform_version', type: [String]
  • #pull_started_at ⇒ [Time]
    'The Unix timestamp for when the container image pull began.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'pull_started_at'
    

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

property :pull_started_at, disposition: :attribute, description: 'The Unix timestamp for when the container image pull began.', source: "MintPress::Aws::ECS::Task", orig_name: 'pull_started_at', type: [Time]
  • #pull_stopped_at ⇒ [Time]
    'The Unix timestamp for when the container image pull completed.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'pull_stopped_at'
    

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

property :pull_stopped_at, disposition: :attribute, description: 'The Unix timestamp for when the container image pull completed.', source: "MintPress::Aws::ECS::Task", orig_name: 'pull_stopped_at', type: [Time]
  • #started_at ⇒ [Time]
    'The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'started_at'
    

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

property :started_at, disposition: :attribute, description: 'The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).', source: "MintPress::Aws::ECS::Task", orig_name: 'started_at', type: [Time]
  • #started_by ⇒ [String]
    'An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.'
    Property Attributes
    • source ⇒ "start_task"
    • orig_name ⇒ 'started_by'
    • list_tasks_prop ⇒ 'started_by'
    • read_only ⇒ false
    • start_task_prop ⇒ 'started_by'
    

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

property :started_by, description: 'An optional tag specified when a task is started. For example, if you
automatically trigger a task to run a batch process job, you could
apply a unique identifier for that job to your task with the
startedBy parameter. You can then identify which tasks belong to
that job by filtering the results of a ListTasks call with the
startedBy value. Up to 36 letters (uppercase and lowercase),
numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.', source: "start_task", orig_name: 'started_by', type: [String], list_tasks_prop: 'started_by', read_only: false, start_task_prop: 'started_by'
  • #stop_code ⇒ [String]
    'The stop code indicating why a task was stopped.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'stop_code'
    

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

property :stop_code, disposition: :attribute, description: 'The stop code indicating why a task was stopped.', source: "MintPress::Aws::ECS::Task", orig_name: 'stop_code', type: [String]
  • #stopped_at ⇒ [Time]
    'The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'stopped_at'
    

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

property :stopped_at, disposition: :attribute, description: 'The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).', source: "MintPress::Aws::ECS::Task", orig_name: 'stopped_at', type: [Time]
  • #stopped_reason ⇒ [String]
    'The reason that the task was stopped.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'stopped_reason'
    

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

property :stopped_reason, disposition: :attribute, description: 'The reason that the task was stopped.', source: "MintPress::Aws::ECS::Task", orig_name: 'stopped_reason', type: [String]
  • #stopping_at ⇒ [Time]
    'The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'stopping_at'
    

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

property :stopping_at, disposition: :attribute, description: 'The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).', source: "MintPress::Aws::ECS::Task", orig_name: 'stopping_at', type: [Time]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::ECS::Tag]
    'The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.'
    Property Attributes
    • source ⇒ "start_task"
    • orig_name ⇒ 'tags'
    • start_task_prop ⇒ 'tags'
    • read_only ⇒ false
    

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 80

property :tags, description: 'The metadata that you apply to the task to help you categorize and
organize them. Each tag consists of a key and an optional value, both
of which you define.

The following basic restrictions apply to tags:


Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can
have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on
allowed characters. Generally allowed characters are: letters,
numbers, and spaces representable in UTF-8, and the following
characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of
such as a prefix for either keys or values as it is reserved for AWS
use. You cannot edit or delete tag keys or values with this prefix.
Tags with this prefix do not count against your tags per resource
limit.', source: "start_task", orig_name: 'tags', type: [MintPress::Aws::ECS::Tag], array: false, start_task_prop: 'tags', read_only: false, hash: true
  • #task_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'task_arn'
    

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

property :task_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'task_arn', type: [String]
  • #task_definition_arn ⇒ [String]
    'The ARN of the task definition that creates the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'task_definition_arn'
    

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

property :task_definition_arn, disposition: :attribute, description: 'The ARN of the task definition that creates the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'task_definition_arn', type: [String]
  • #version ⇒ [Integer]
    'The version counter for the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::ECS::Task"
    • orig_name ⇒ 'version'
    

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

property :version, disposition: :attribute, description: 'The version counter for the task.', source: "MintPress::Aws::ECS::Task", orig_name: 'version', type: [Integer]
  • #cluster ⇒ [String]
    'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.'
    Property Attributes
    • describe_tasks_prop ⇒ 'cluster'
    • source ⇒ "stop_task"
    • list_tasks_prop ⇒ 'cluster'
    • read_only ⇒ false
    • start_task_prop ⇒ 'cluster'
    • stop_task_prop ⇒ 'cluster'
    

106
107
108
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 106

property :cluster, describe_tasks_prop: 'cluster', type: [String], source: "stop_task", description: 'The short name or full Amazon Resource Name (ARN) of the cluster that
hosts the task to stop. If you do not specify a cluster, the default
cluster is assumed.', list_tasks_prop: 'cluster', read_only: false, start_task_prop: 'cluster', stop_task_prop: 'cluster'
  • #tasks ⇒ Array of ⇒ [String]
    'A list of up to 100 task IDs or full ARN entries.'
    Property Attributes
    • describe_tasks_prop ⇒ 'tasks'
    • source ⇒ "describe_tasks"
    

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

property :tasks, describe_tasks_prop: 'tasks', type: [String], array: true, source: "describe_tasks", description: 'A list of up to 100 task IDs or full ARN entries.'
  • #include ⇒ Array of ⇒ [String]
    'Specifies whether you want to see the resource tags for the task. 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_tasks_prop ⇒ 'include'
    • source ⇒ "describe_tasks"
    

110
111
112
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 110

property :include, describe_tasks_prop: 'include', type: [String], array: true, source: "describe_tasks", description: 'Specifies whether you want to see the resource tags for the task. If
TAGS is specified, the tags are included in the response. If this
field is omitted, tags are not included in the response.'
  • #container_instance ⇒ [String]
    'The container instance ID or full ARN of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.'
    Property Attributes
    • list_tasks_prop ⇒ 'container_instance'
    • read_only ⇒ false
    • source ⇒ "list_tasks"
    

113
114
115
116
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 113

property :container_instance, list_tasks_prop: 'container_instance', type: [String], read_only: false, source: "list_tasks", description: 'The container instance ID or full ARN of the container instance with
which to filter the ListTasks results. Specifying a
containerInstance limits the results to tasks that belong to that
container instance.'
  • #family ⇒ [String]
    'The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.'
    Property Attributes
    • list_tasks_prop ⇒ 'family'
    • read_only ⇒ false
    • source ⇒ "list_tasks"
    

117
118
119
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 117

property :family, list_tasks_prop: 'family', type: [String], read_only: false, source: "list_tasks", description: 'The name of the family with which to filter the ListTasks results.
Specifying a family limits the results to tasks that belong to that
family.'
  • #max_results ⇒ [Integer]
    'The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.'
    Property Attributes
    • list_tasks_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_tasks"
    

120
121
122
123
124
125
126
127
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 120

property :max_results, list_tasks_prop: 'max_results', type: [Integer], read_only: false, source: "list_tasks", description: 'The maximum number of task results returned by ListTasks in
paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned
nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListTasks returns up to 100 results and
a nextToken value if applicable.'
  • #service_name ⇒ [String]
    'The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.'
    Property Attributes
    • list_tasks_prop ⇒ 'service_name'
    • read_only ⇒ false
    • source ⇒ "list_tasks"
    

128
129
130
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 128

property :service_name, list_tasks_prop: 'service_name', type: [String], read_only: false, source: "list_tasks", description: 'The name of the service with which to filter the ListTasks results.
Specifying a serviceName limits the results to tasks that belong to
that service.'
  • #container_instances ⇒ Array of ⇒ [String]
    'The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.'
    Property Attributes
    • start_task_prop ⇒ 'container_instances'
    • read_only ⇒ false
    • source ⇒ "start_task"
    

131
132
133
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 131

property :container_instances, start_task_prop: 'container_instances', type: [String], array: true, read_only: false, source: "start_task", description: 'The container instance IDs or full ARN entries for the container
instances on which you would like to place your task. You can specify
up to 10 container instances.'
  • #enable_ecs_managed_tags ⇒ [TrueClass,FalseClass]
    'Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.'
    Property Attributes
    • start_task_prop ⇒ 'enable_ecs_managed_tags'
    • read_only ⇒ false
    • source ⇒ "start_task"
    

134
135
136
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 134

property :enable_ecs_managed_tags, start_task_prop: 'enable_ecs_managed_tags', type: [TrueClass,FalseClass], read_only: false, source: "start_task", description: 'Specifies whether to enable Amazon ECS managed tags for the task. For
more information, see Tagging Your Amazon ECS Resources in the
Amazon Elastic Container Service Developer Guide.'
  • #network_configuration ⇒ [MintPress::Aws::ECS::AwsVpcConfiguration]
    'The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.'
    Property Attributes
    • start_task_prop ⇒ "network_configuration.awsvpc_configuration"
    • read_only ⇒ false
    • source ⇒ "start_task"
    

137
138
139
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 137

property :network_configuration, start_task_prop: "network_configuration.awsvpc_configuration", type: [MintPress::Aws::ECS::AwsVpcConfiguration], read_only: false, source: "start_task", description: 'The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.'
  • #propagate_tags ⇒ [String]
    'Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.'
    Property Attributes
    • start_task_prop ⇒ 'propagate_tags'
    • read_only ⇒ false
    • source ⇒ "start_task"
    

140
141
142
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 140

property :propagate_tags, start_task_prop: 'propagate_tags', type: [String], read_only: false, source: "start_task", description: 'Specifies whether to propagate the tags from the task definition or
the service to the task. If no value is specified, the tags are not
propagated.'
  • #task_definition ⇒ [String]
    'The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.'
    Property Attributes
    • start_task_prop ⇒ 'task_definition'
    • read_only ⇒ false
    • source ⇒ "start_task"
    

143
144
145
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 143

property :task_definition, start_task_prop: 'task_definition', type: [String], read_only: false, source: "start_task", description: 'The family and revision (family:revision) or full ARN of the
task definition to start. If a revision is not specified, the latest
ACTIVE revision is used.'
  • #task ⇒ [String]
    'The task ID or full Amazon Resource Name (ARN) of the task to stop.'
    Property Attributes
    • stop_task_prop ⇒ 'task'
    • read_only ⇒ false
    • source ⇒ "stop_task"
    

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

property :task, stop_task_prop: 'task', type: [String], read_only: false, source: "stop_task", description: 'The task ID or full Amazon Resource Name (ARN) of the task to stop.'
  • #reason ⇒ [String]
    'An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.'
    Property Attributes
    • stop_task_prop ⇒ 'reason'
    • read_only ⇒ false
    • source ⇒ "stop_task"
    

147
148
149
150
151
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ecs/task.rb', line 147

property :reason, stop_task_prop: 'reason', type: [String], read_only: false, source: "stop_task", description: 'An optional message specified when a task is stopped. For example, if
you are using a custom scheduler, you can use this parameter to
specify the reason for stopping the task here, and the message appears
in subsequent DescribeTasks API operations on this task. Up to 255
characters are allowed in this message.'
  • #reference ⇒ [String]
    'The reference ID to use for the task.'
    Property Attributes
    • start_task_prop ⇒ 'reference_id'
    • read_only ⇒ false
    • source ⇒ "start_task"
    

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

property :reference, start_task_prop: 'reference_id', type: [String], read_only: false, source: "start_task", description: 'The reference ID to use for the task.'
  • #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 
    

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

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
    

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

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 = {}) ⇒ Task

Returns a new instance of Task.

Instance Method Details

#describe ⇒ Object

#list ⇒ Object

#start ⇒ Object

#stop ⇒ Object