Class: Aws::ECS::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb

Overview

An API client for ECS. To construct a client, you need to configure a :region and :credentials.

client = Aws::ECS::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP)

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
    'https://example.com'
    'http://example.com:123'
    
  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean)

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String)

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ECS::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ECS::EndpointParameters

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc)

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc)

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String)

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float)

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.



420
421
422
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 420

def initialize(*args)
  super
end

Instance Method Details

#create_capacity_provider(params = {}) ⇒ Types::CreateCapacityProviderResponse

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

Examples:

Request syntax with placeholder values


resp = client.create_capacity_provider({
  name: "String", # required
  auto_scaling_group_provider: { # required
    auto_scaling_group_arn: "String", # required
    managed_scaling: {
      status: "ENABLED", # accepts ENABLED, DISABLED
      target_capacity: 1,
      minimum_scaling_step_size: 1,
      maximum_scaling_step_size: 1,
      instance_warmup_period: 1,
    },
    managed_termination_protection: "ENABLED", # accepts ENABLED, DISABLED
    managed_draining: "ENABLED", # accepts ENABLED, DISABLED
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.name #=> String
resp.capacity_provider.status #=> String, one of "ACTIVE", "INACTIVE"
resp.capacity_provider.auto_scaling_group_provider.auto_scaling_group_arn #=> String
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.instance_warmup_period #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_draining #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.capacity_provider.update_status_reason #=> String
resp.capacity_provider.tags #=> Array
resp.capacity_provider.tags[0].key #=> String
resp.capacity_provider.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate".

  • :auto_scaling_group_provider (required, Types::AutoScalingGroupProvider)

    The details of the Auto Scaling group for the capacity provider.

  • :tags (Array<Types::Tag>)

    The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.

    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 Amazon Web Services 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.

Returns:

See Also:



525
526
527
528
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 525

def create_capacity_provider(params = {}, options = {})
  req = build_request(:create_capacity_provider, params)
  req.send_request(options)
end

#create_cluster(params = {}) ⇒ Types::CreateClusterResponse

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Examples:

Example: To create a new cluster


# This example creates a cluster in your default region.

resp = client.create_cluster({
  cluster_name: "my_cluster", 
})

resp.to_h outputs the following:
{
  cluster: {
    active_services_count: 0, 
    cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", 
    cluster_name: "my_cluster", 
    pending_tasks_count: 0, 
    registered_container_instances_count: 0, 
    running_tasks_count: 0, 
    status: "ACTIVE", 
  }, 
}

Request syntax with placeholder values


resp = client.create_cluster({
  cluster_name: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  settings: [
    {
      name: "containerInsights", # accepts containerInsights
      value: "String",
    },
  ],
  configuration: {
    execute_command_configuration: {
      kms_key_id: "String",
      logging: "NONE", # accepts NONE, DEFAULT, OVERRIDE
      log_configuration: {
        cloud_watch_log_group_name: "String",
        cloud_watch_encryption_enabled: false,
        s3_bucket_name: "String",
        s3_encryption_enabled: false,
        s3_key_prefix: "String",
      },
    },
    managed_storage_configuration: {
      kms_key_id: "String",
      fargate_ephemeral_storage_kms_key_id: "String",
    },
  },
  capacity_providers: ["String"],
  default_capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  service_connect_defaults: {
    namespace: "String", # required
  },
})

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_name #=> String
resp.cluster.configuration.execute_command_configuration.kms_key_id #=> String
resp.cluster.configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.cluster.status #=> String
resp.cluster.registered_container_instances_count #=> Integer
resp.cluster.running_tasks_count #=> Integer
resp.cluster.pending_tasks_count #=> Integer
resp.cluster.active_services_count #=> Integer
resp.cluster.statistics #=> Array
resp.cluster.statistics[0].name #=> String
resp.cluster.statistics[0].value #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.settings #=> Array
resp.cluster.settings[0].name #=> String, one of "containerInsights"
resp.cluster.settings[0].value #=> String
resp.cluster.capacity_providers #=> Array
resp.cluster.capacity_providers[0] #=> String
resp.cluster.default_capacity_provider_strategy #=> Array
resp.cluster.default_capacity_provider_strategy[0].capacity_provider #=> String
resp.cluster.default_capacity_provider_strategy[0].weight #=> Integer
resp.cluster.default_capacity_provider_strategy[0].base #=> Integer
resp.cluster.attachments #=> Array
resp.cluster.attachments[0].id #=> String
resp.cluster.attachments[0].type #=> String
resp.cluster.attachments[0].status #=> String
resp.cluster.attachments[0].details #=> Array
resp.cluster.attachments[0].details[0].name #=> String
resp.cluster.attachments[0].details[0].value #=> String
resp.cluster.attachments_status #=> String
resp.cluster.service_connect_defaults.namespace #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster_name (String)

    The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

  • :tags (Array<Types::Tag>)

    The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    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 Amazon Web Services 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.

  • :settings (Array<Types::ClusterSetting>)

    The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

  • :configuration (Types::ClusterConfiguration)

    The execute command configuration for the cluster.

  • :capacity_providers (Array<String>)

    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

    The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

  • :default_capacity_provider_strategy (Array<Types::CapacityProviderStrategyItem>)

    The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

    If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.

  • :service_connect_defaults (Types::ClusterServiceConnectDefaultsRequest)

    Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Returns:

See Also:



780
781
782
783
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 780

def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

#create_service(params = {}) ⇒ Types::CreateServiceResponse

Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

  • REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

  • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

Examples:

Example: To create a new service


# This example creates a service in your default region called ``ecs-simple-service``. The service uses the
# ``hello_world`` task definition and it maintains 10 copies of that task.

resp = client.create_service({
  desired_count: 10, 
  service_name: "ecs-simple-service", 
  task_definition: "hello_world", 
})

resp.to_h outputs the following:
{
  service: {
    cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", 
    created_at: Time.parse("2016-08-29T16:13:47.298Z"), 
    deployment_configuration: {
      maximum_percent: 200, 
      minimum_healthy_percent: 100, 
    }, 
    deployments: [
      {
        created_at: Time.parse("2016-08-29T16:13:47.298Z"), 
        desired_count: 10, 
        id: "ecs-svc/9223370564342348388", 
        pending_count: 0, 
        running_count: 0, 
        status: "PRIMARY", 
        task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", 
        updated_at: Time.parse("2016-08-29T16:13:47.298Z"), 
      }, 
      {
        created_at: Time.parse("2016-08-29T15:52:44.481Z"), 
        desired_count: 0, 
        id: "ecs-svc/9223370564343611322", 
        pending_count: 0, 
        running_count: 0, 
        status: "ACTIVE", 
        task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", 
        updated_at: Time.parse("2016-08-29T16:11:38.941Z"), 
      }, 
    ], 
    desired_count: 10, 
    events: [
    ], 
    load_balancers: [
    ], 
    pending_count: 0, 
    running_count: 0, 
    service_arn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", 
    service_name: "ecs-simple-service", 
    status: "ACTIVE", 
    task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6", 
  }, 
}

Example: To create a new service behind a load balancer


# This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the
# ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in
# the same region by its name.

resp = client.create_service({
  desired_count: 10, 
  load_balancers: [
    {
      container_name: "simple-app", 
      container_port: 80, 
      load_balancer_name: "EC2Contai-EcsElast-15DCDAURT3ZO2", 
    }, 
  ], 
  role: "ecsServiceRole", 
  service_name: "ecs-simple-service-elb", 
  task_definition: "console-sample-app-static", 
})

resp.to_h outputs the following:
{
  service: {
    cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", 
    created_at: Time.parse("2016-08-29T16:02:54.884Z"), 
    deployment_configuration: {
      maximum_percent: 200, 
      minimum_healthy_percent: 100, 
    }, 
    deployments: [
      {
        created_at: Time.parse("2016-08-29T16:02:54.884Z"), 
        desired_count: 10, 
        id: "ecs-svc/9223370564343000923", 
        pending_count: 0, 
        running_count: 0, 
        status: "PRIMARY", 
        task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6", 
        updated_at: Time.parse("2016-08-29T16:02:54.884Z"), 
      }, 
    ], 
    desired_count: 10, 
    events: [
    ], 
    load_balancers: [
      {
        container_name: "simple-app", 
        container_port: 80, 
        load_balancer_name: "EC2Contai-EcsElast-15DCDAURT3ZO2", 
      }, 
    ], 
    pending_count: 0, 
    role_arn: "arn:aws:iam::012345678910:role/ecsServiceRole", 
    running_count: 0, 
    service_arn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service-elb", 
    service_name: "ecs-simple-service-elb", 
    status: "ACTIVE", 
    task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/console-sample-app-static:6", 
  }, 
}

Request syntax with placeholder values


resp = client.create_service({
  cluster: "String",
  service_name: "String", # required
  task_definition: "String",
  load_balancers: [
    {
      target_group_arn: "String",
      load_balancer_name: "String",
      container_name: "String",
      container_port: 1,
    },
  ],
  service_registries: [
    {
      registry_arn: "String",
      port: 1,
      container_name: "String",
      container_port: 1,
    },
  ],
  desired_count: 1,
  client_token: "String",
  launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
  capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  platform_version: "String",
  role: "String",
  deployment_configuration: {
    deployment_circuit_breaker: {
      enable: false, # required
      rollback: false, # required
    },
    maximum_percent: 1,
    minimum_healthy_percent: 1,
    alarms: {
      alarm_names: ["String"], # required
      enable: false, # required
      rollback: false, # required
    },
  },
  placement_constraints: [
    {
      type: "distinctInstance", # accepts distinctInstance, memberOf
      expression: "String",
    },
  ],
  placement_strategy: [
    {
      type: "random", # accepts random, spread, binpack
      field: "String",
    },
  ],
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  health_check_grace_period_seconds: 1,
  scheduling_strategy: "REPLICA", # accepts REPLICA, DAEMON
  deployment_controller: {
    type: "ECS", # required, accepts ECS, CODE_DEPLOY, EXTERNAL
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  enable_ecs_managed_tags: false,
  propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
  enable_execute_command: false,
  service_connect_configuration: {
    enabled: false, # required
    namespace: "String",
    services: [
      {
        port_name: "String", # required
        discovery_name: "String",
        client_aliases: [
          {
            port: 1, # required
            dns_name: "String",
          },
        ],
        ingress_port_override: 1,
        timeout: {
          idle_timeout_seconds: 1,
          per_request_timeout_seconds: 1,
        },
        tls: {
          issuer_certificate_authority: { # required
            aws_pca_authority_arn: "String",
          },
          kms_key: "String",
          role_arn: "String",
        },
      },
    ],
    log_configuration: {
      log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens
      options: {
        "String" => "String",
      },
      secret_options: [
        {
          name: "String", # required
          value_from: "String", # required
        },
      ],
    },
  },
  volume_configurations: [
    {
      name: "ECSVolumeName", # required
      managed_ebs_volume: {
        encrypted: false,
        kms_key_id: "EBSKMSKeyId",
        volume_type: "EBSVolumeType",
        size_in_gi_b: 1,
        snapshot_id: "EBSSnapshotId",
        iops: 1,
        throughput: 1,
        tag_specifications: [
          {
            resource_type: "volume", # required, accepts volume
            tags: [
              {
                key: "TagKey",
                value: "TagValue",
              },
            ],
            propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
          },
        ],
        role_arn: "IAMRoleArn", # required
        filesystem_type: "ext3", # accepts ext3, ext4, xfs
      },
    },
  ],
})

Response structure


resp.service.service_arn #=> String
resp.service.service_name #=> String
resp.service.cluster_arn #=> String
resp.service.load_balancers #=> Array
resp.service.load_balancers[0].target_group_arn #=> String
resp.service.load_balancers[0].load_balancer_name #=> String
resp.service.load_balancers[0].container_name #=> String
resp.service.load_balancers[0].container_port #=> Integer
resp.service.service_registries #=> Array
resp.service.service_registries[0].registry_arn #=> String
resp.service.service_registries[0].port #=> Integer
resp.service.service_registries[0].container_name #=> String
resp.service.service_registries[0].container_port #=> Integer
resp.service.status #=> String
resp.service.desired_count #=> Integer
resp.service.running_count #=> Integer
resp.service.pending_count #=> Integer
resp.service.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.capacity_provider_strategy #=> Array
resp.service.capacity_provider_strategy[0].capacity_provider #=> String
resp.service.capacity_provider_strategy[0].weight #=> Integer
resp.service.capacity_provider_strategy[0].base #=> Integer
resp.service.platform_version #=> String
resp.service.platform_family #=> String
resp.service.task_definition #=> String
resp.service.deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
resp.service.deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
resp.service.deployment_configuration.maximum_percent #=> Integer
resp.service.deployment_configuration.minimum_healthy_percent #=> Integer
resp.service.deployment_configuration.alarms.alarm_names #=> Array
resp.service.deployment_configuration.alarms.alarm_names[0] #=> String
resp.service.deployment_configuration.alarms.enable #=> Boolean
resp.service.deployment_configuration.alarms.rollback #=> Boolean
resp.service.task_sets #=> Array
resp.service.task_sets[0].id #=> String
resp.service.task_sets[0].task_set_arn #=> String
resp.service.task_sets[0].service_arn #=> String
resp.service.task_sets[0].cluster_arn #=> String
resp.service.task_sets[0].started_by #=> String
resp.service.task_sets[0].external_id #=> String
resp.service.task_sets[0].status #=> String
resp.service.task_sets[0].task_definition #=> String
resp.service.task_sets[0].computed_desired_count #=> Integer
resp.service.task_sets[0].pending_count #=> Integer
resp.service.task_sets[0].running_count #=> Integer
resp.service.task_sets[0].created_at #=> Time
resp.service.task_sets[0].updated_at #=> Time
resp.service.task_sets[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.task_sets[0].capacity_provider_strategy #=> Array
resp.service.task_sets[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.task_sets[0].capacity_provider_strategy[0].base #=> Integer
resp.service.task_sets[0].platform_version #=> String
resp.service.task_sets[0].platform_family #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.task_sets[0].load_balancers #=> Array
resp.service.task_sets[0].load_balancers[0].target_group_arn #=> String
resp.service.task_sets[0].load_balancers[0].load_balancer_name #=> String
resp.service.task_sets[0].load_balancers[0].container_name #=> String
resp.service.task_sets[0].load_balancers[0].container_port #=> Integer
resp.service.task_sets[0].service_registries #=> Array
resp.service.task_sets[0].service_registries[0].registry_arn #=> String
resp.service.task_sets[0].service_registries[0].port #=> Integer
resp.service.task_sets[0].service_registries[0].container_name #=> String
resp.service.task_sets[0].service_registries[0].container_port #=> Integer
resp.service.task_sets[0].scale.value #=> Float
resp.service.task_sets[0].scale.unit #=> String, one of "PERCENT"
resp.service.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.service.task_sets[0].stability_status_at #=> Time
resp.service.task_sets[0].tags #=> Array
resp.service.task_sets[0].tags[0].key #=> String
resp.service.task_sets[0].tags[0].value #=> String
resp.service.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.deployments #=> Array
resp.service.deployments[0].id #=> String
resp.service.deployments[0].status #=> String
resp.service.deployments[0].task_definition #=> String
resp.service.deployments[0].desired_count #=> Integer
resp.service.deployments[0].pending_count #=> Integer
resp.service.deployments[0].running_count #=> Integer
resp.service.deployments[0].failed_tasks #=> Integer
resp.service.deployments[0].created_at #=> Time
resp.service.deployments[0].updated_at #=> Time
resp.service.deployments[0].capacity_provider_strategy #=> Array
resp.service.deployments[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.deployments[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.deployments[0].capacity_provider_strategy[0].base #=> Integer
resp.service.deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.deployments[0].platform_version #=> String
resp.service.deployments[0].platform_family #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.deployments[0].rollout_state #=> String, one of "COMPLETED", "FAILED", "IN_PROGRESS"
resp.service.deployments[0].rollout_state_reason #=> String
resp.service.deployments[0].service_connect_configuration.enabled #=> Boolean
resp.service.deployments[0].service_connect_configuration.namespace #=> String
resp.service.deployments[0].service_connect_configuration.services #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].port_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].discovery_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.kms_key #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.role_arn #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.service.deployments[0].service_connect_configuration.log_configuration.options #=> Hash
resp.service.deployments[0].service_connect_configuration.log_configuration.options["String"] #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options #=> Array
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
resp.service.deployments[0].service_connect_resources #=> Array
resp.service.deployments[0].service_connect_resources[0].discovery_name #=> String
resp.service.deployments[0].service_connect_resources[0].discovery_arn #=> String
resp.service.deployments[0].volume_configurations #=> Array
resp.service.deployments[0].volume_configurations[0].name #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.role_arn #=> String
resp.service.events #=> Array
resp.service.events[0].id #=> String
resp.service.events[0].created_at #=> Time
resp.service.events[0].message #=> String
resp.service.created_at #=> Time
resp.service.placement_constraints #=> Array
resp.service.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.service.placement_constraints[0].expression #=> String
resp.service.placement_strategy #=> Array
resp.service.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.service.placement_strategy[0].field #=> String
resp.service.network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.health_check_grace_period_seconds #=> Integer
resp.service.scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
resp.service.deployment_controller.type #=> String, one of "ECS", "CODE_DEPLOY", "EXTERNAL"
resp.service.tags #=> Array
resp.service.tags[0].key #=> String
resp.service.tags[0].value #=> String
resp.service.created_by #=> String
resp.service.enable_ecs_managed_tags #=> Boolean
resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.enable_execute_command #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.

  • :service_name (required, String)

    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

  • :task_definition (String)

    The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.

    A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.

    For more information about deployment types, see Amazon ECS deployment types.

  • :load_balancers (Array<Types::LoadBalancer>)

    A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

    If the service uses the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

    If the service uses the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.

    If you use the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

    For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group that's specified here.

    For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's specified here.

    Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. This is because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

  • :service_registries (Array<Types::ServiceRegistry>)

    The details of the service discovery registry to associate with this service. For more information, see Service discovery.

    Each service may be associated with one service registry. Multiple service registries for each service isn't supported.

  • :desired_count (Integer)

    The number of instantiations of the specified task definition to place and keep running in your service.

    This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.

  • :client_token (String)

    An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

  • :launch_type (String)

    The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

    The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

    Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.

    The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

    The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

    A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

  • :capacity_provider_strategy (Array<Types::CapacityProviderStrategyItem>)

    The capacity provider strategy to use for the service.

    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

    A capacity provider strategy may contain a maximum of 6 capacity providers.

  • :platform_version (String)

    The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

  • :role (String)

    The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

    If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

    If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

  • :deployment_configuration (Types::DeploymentConfiguration)

    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

  • :placement_constraints (Array<Types::PlacementConstraint>)

    An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

  • :placement_strategy (Array<Types::PlacementStrategy>)

    The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.

  • :network_configuration (Types::NetworkConfiguration)

    The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

  • :health_check_grace_period_seconds (Integer)

    The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.

    If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see Health check.

    If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

  • :scheduling_strategy (String)

    The scheduling strategy to use for the service. For more information, see Services.

    There are two service scheduler strategies available:

    • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.

    • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

      Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

  • :deployment_controller (Types::DeploymentController)

    The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

  • :tags (Array<Types::Tag>)

    The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

    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 Amazon Web Services 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.

  • :enable_ecs_managed_tags (Boolean)

    Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.

    When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.

  • :propagate_tags (String)

    Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

    You must set this to a value other than NONE when you use Cost Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide.

    The default is NONE.

  • :enable_execute_command (Boolean)

    Determines whether the execute command functionality is turned on for the service. If true, this enables execute command functionality on all containers in the service tasks.

  • :service_connect_configuration (Types::ServiceConnectConfiguration)

    The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • :volume_configurations (Array<Types::ServiceVolumeConfiguration>)

    The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.

Returns:

See Also:



1726
1727
1728
1729
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1726

def create_service(params = {}, options = {})
  req = build_request(:create_service, params)
  req.send_request(options)
end

#create_task_set(params = {}) ⇒ Types::CreateTaskSetResponse

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

For information about the maximum number of task sets and otther quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_task_set({
  service: "String", # required
  cluster: "String", # required
  external_id: "String",
  task_definition: "String", # required
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  load_balancers: [
    {
      target_group_arn: "String",
      load_balancer_name: "String",
      container_name: "String",
      container_port: 1,
    },
  ],
  service_registries: [
    {
      registry_arn: "String",
      port: 1,
      container_name: "String",
      container_port: 1,
    },
  ],
  launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
  capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  platform_version: "String",
  scale: {
    value: 1.0,
    unit: "PERCENT", # accepts PERCENT
  },
  client_token: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.task_set.id #=> String
resp.task_set.task_set_arn #=> String
resp.task_set.service_arn #=> String
resp.task_set.cluster_arn #=> String
resp.task_set.started_by #=> String
resp.task_set.external_id #=> String
resp.task_set.status #=> String
resp.task_set.task_definition #=> String
resp.task_set.computed_desired_count #=> Integer
resp.task_set.pending_count #=> Integer
resp.task_set.running_count #=> Integer
resp.task_set.created_at #=> Time
resp.task_set.updated_at #=> Time
resp.task_set.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_set.capacity_provider_strategy #=> Array
resp.task_set.capacity_provider_strategy[0].capacity_provider #=> String
resp.task_set.capacity_provider_strategy[0].weight #=> Integer
resp.task_set.capacity_provider_strategy[0].base #=> Integer
resp.task_set.platform_version #=> String
resp.task_set.platform_family #=> String
resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.task_set.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.task_set.load_balancers #=> Array
resp.task_set.load_balancers[0].target_group_arn #=> String
resp.task_set.load_balancers[0].load_balancer_name #=> String
resp.task_set.load_balancers[0].container_name #=> String
resp.task_set.load_balancers[0].container_port #=> Integer
resp.task_set.service_registries #=> Array
resp.task_set.service_registries[0].registry_arn #=> String
resp.task_set.service_registries[0].port #=> Integer
resp.task_set.service_registries[0].container_name #=> String
resp.task_set.service_registries[0].container_port #=> Integer
resp.task_set.scale.value #=> Float
resp.task_set.scale.unit #=> String, one of "PERCENT"
resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.task_set.stability_status_at #=> Time
resp.task_set.tags #=> Array
resp.task_set.tags[0].key #=> String
resp.task_set.tags[0].value #=> String
resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :service (required, String)

    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

  • :cluster (required, String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

  • :external_id (String)

    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided value.

  • :task_definition (required, String)

    The task definition for the tasks in the task set to use. If a revision isn't specified, the latest ACTIVE revision is used.

  • :network_configuration (Types::NetworkConfiguration)

    An object representing the network configuration for a task set.

  • :load_balancers (Array<Types::LoadBalancer>)

    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

  • :service_registries (Array<Types::ServiceRegistry>)

    The details of the service discovery registries to assign to this task set. For more information, see Service discovery.

  • :launch_type (String)

    The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

  • :capacity_provider_strategy (Array<Types::CapacityProviderStrategyItem>)

    The capacity provider strategy to use for the task set.

    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

  • :platform_version (String)

    The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

  • :scale (Types::Scale)

    A floating-point percentage of the desired number of tasks to place and keep running in the task set.

  • :client_token (String)

    An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

  • :tags (Array<Types::Tag>)

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.

    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 Amazon Web Services 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.

Returns:

See Also:



1977
1978
1979
1980
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1977

def create_task_set(params = {}, options = {})
  req = build_request(:create_task_set, params)
  req.send_request(options)
end

#delete_account_setting(params = {}) ⇒ Types::DeleteAccountSettingResponse

Disables an account setting for a specified user, role, or the root user for an account.

Examples:

Example: To delete your account setting


# This example deletes the account setting for your user for the specified resource type.

resp = client.({
  name: "serviceLongArnFormat", 
})

resp.to_h outputs the following:
{
  setting: {
    name: "serviceLongArnFormat", 
    value: "enabled", 
    principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", 
  }, 
}

Example: To delete the account settings for a specific IAM user or IAM role


# This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the
# root user can view or modify the account settings for another user.

resp = client.({
  name: "containerInstanceLongArnFormat", 
  principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", 
})

resp.to_h outputs the following:
{
  setting: {
    name: "containerInstanceLongArnFormat", 
    value: "enabled", 
    principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking, containerInsights, fargateFIPSMode, tagResourceAuthorization, fargateTaskRetirementWaitPeriod, guardDutyActivate
  principal_arn: "String",
})

Response structure


resp.setting.name #=> String, one of "serviceLongArnFormat", "taskLongArnFormat", "containerInstanceLongArnFormat", "awsvpcTrunking", "containerInsights", "fargateFIPSMode", "tagResourceAuthorization", "fargateTaskRetirementWaitPeriod", "guardDutyActivate"
resp.setting.value #=> String
resp.setting.principal_arn #=> String
resp.setting.type #=> String, one of "user", "aws_managed"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

  • :principal_arn (String)

    The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

Returns:

See Also:



2062
2063
2064
2065
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2062

def (params = {}, options = {})
  req = build_request(:delete_account_setting, params)
  req.send_request(options)
end

#delete_attributes(params = {}) ⇒ Types::DeleteAttributesResponse

Deletes one or more custom attributes from an Amazon ECS resource.

Examples:

Request syntax with placeholder values


resp = client.delete_attributes({
  cluster: "String",
  attributes: [ # required
    {
      name: "String", # required
      value: "String",
      target_type: "container-instance", # accepts container-instance
      target_id: "String",
    },
  ],
})

Response structure


resp.attributes #=> Array
resp.attributes[0].name #=> String
resp.attributes[0].value #=> String
resp.attributes[0].target_type #=> String, one of "container-instance"
resp.attributes[0].target_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

  • :attributes (required, Array<Types::Attribute>)

    The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don't specify the value. If you specify the target ID using the short form, you must also specify the target type.

Returns:

See Also:



2111
2112
2113
2114
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2111

def delete_attributes(params = {}, options = {})
  req = build_request(:delete_attributes, params)
  req.send_request(options)
end

#delete_capacity_provider(params = {}) ⇒ Types::DeleteCapacityProviderResponse

Deletes the specified capacity provider.

The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.

Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_capacity_provider({
  capacity_provider: "String", # required
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.name #=> String
resp.capacity_provider.status #=> String, one of "ACTIVE", "INACTIVE"
resp.capacity_provider.auto_scaling_group_provider.auto_scaling_group_arn #=> String
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.instance_warmup_period #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_draining #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.capacity_provider.update_status_reason #=> String
resp.capacity_provider.tags #=> Array
resp.capacity_provider.tags[0].key #=> String
resp.capacity_provider.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :capacity_provider (required, String)

    The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.

Returns:

See Also:



2172
2173
2174
2175
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2172

def delete_capacity_provider(params = {}, options = {})
  req = build_request(:delete_capacity_provider, params)
  req.send_request(options)
end

#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

Examples:

Example: To delete an empty cluster


# This example deletes an empty cluster in your default region.

resp = client.delete_cluster({
  cluster: "my_cluster", 
})

resp.to_h outputs the following:
{
  cluster: {
    active_services_count: 0, 
    cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", 
    cluster_name: "my_cluster", 
    pending_tasks_count: 0, 
    registered_container_instances_count: 0, 
    running_tasks_count: 0, 
    status: "INACTIVE", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_cluster({
  cluster: "String", # required
})

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_name #=> String
resp.cluster.configuration.execute_command_configuration.kms_key_id #=> String
resp.cluster.configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.cluster.status #=> String
resp.cluster.registered_container_instances_count #=> Integer
resp.cluster.running_tasks_count #=> Integer
resp.cluster.pending_tasks_count #=> Integer
resp.cluster.active_services_count #=> Integer
resp.cluster.statistics #=> Array
resp.cluster.statistics[0].name #=> String
resp.cluster.statistics[0].value #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.settings #=> Array
resp.cluster.settings[0].name #=> String, one of "containerInsights"
resp.cluster.settings[0].value #=> String
resp.cluster.capacity_providers #=> Array
resp.cluster.capacity_providers[0] #=> String
resp.cluster.default_capacity_provider_strategy #=> Array
resp.cluster.default_capacity_provider_strategy[0].capacity_provider #=> String
resp.cluster.default_capacity_provider_strategy[0].weight #=> Integer
resp.cluster.default_capacity_provider_strategy[0].base #=> Integer
resp.cluster.attachments #=> Array
resp.cluster.attachments[0].id #=> String
resp.cluster.attachments[0].type #=> String
resp.cluster.attachments[0].status #=> String
resp.cluster.attachments[0].details #=> Array
resp.cluster.attachments[0].details[0].name #=> String
resp.cluster.attachments[0].details[0].value #=> String
resp.cluster.attachments_status #=> String
resp.cluster.service_connect_defaults.namespace #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster (required, String)

    The short name or full Amazon Resource Name (ARN) of the cluster to delete.

Returns:

See Also:



2271
2272
2273
2274
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2271

def delete_cluster(params = {}, options = {})
  req = build_request(:delete_cluster, params)
  req.send_request(options)
end

#delete_service(params = {}) ⇒ Types::DeleteServiceResponse

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can't delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

Examples:

Example: To delete a service


# This example deletes the my-http-service service. The service must have a desired count and running count of 0 before
# you can delete it.

resp = client.delete_service({
  service: "my-http-service", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_service({
  cluster: "String",
  service: "String", # required
  force: false,
})

Response structure


resp.service.service_arn #=> String
resp.service.service_name #=> String
resp.service.cluster_arn #=> String
resp.service.load_balancers #=> Array
resp.service.load_balancers[0].target_group_arn #=> String
resp.service.load_balancers[0].load_balancer_name #=> String
resp.service.load_balancers[0].container_name #=> String
resp.service.load_balancers[0].container_port #=> Integer
resp.service.service_registries #=> Array
resp.service.service_registries[0].registry_arn #=> String
resp.service.service_registries[0].port #=> Integer
resp.service.service_registries[0].container_name #=> String
resp.service.service_registries[0].container_port #=> Integer
resp.service.status #=> String
resp.service.desired_count #=> Integer
resp.service.running_count #=> Integer
resp.service.pending_count #=> Integer
resp.service.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.capacity_provider_strategy #=> Array
resp.service.capacity_provider_strategy[0].capacity_provider #=> String
resp.service.capacity_provider_strategy[0].weight #=> Integer
resp.service.capacity_provider_strategy[0].base #=> Integer
resp.service.platform_version #=> String
resp.service.platform_family #=> String
resp.service.task_definition #=> String
resp.service.deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
resp.service.deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
resp.service.deployment_configuration.maximum_percent #=> Integer
resp.service.deployment_configuration.minimum_healthy_percent #=> Integer
resp.service.deployment_configuration.alarms.alarm_names #=> Array
resp.service.deployment_configuration.alarms.alarm_names[0] #=> String
resp.service.deployment_configuration.alarms.enable #=> Boolean
resp.service.deployment_configuration.alarms.rollback #=> Boolean
resp.service.task_sets #=> Array
resp.service.task_sets[0].id #=> String
resp.service.task_sets[0].task_set_arn #=> String
resp.service.task_sets[0].service_arn #=> String
resp.service.task_sets[0].cluster_arn #=> String
resp.service.task_sets[0].started_by #=> String
resp.service.task_sets[0].external_id #=> String
resp.service.task_sets[0].status #=> String
resp.service.task_sets[0].task_definition #=> String
resp.service.task_sets[0].computed_desired_count #=> Integer
resp.service.task_sets[0].pending_count #=> Integer
resp.service.task_sets[0].running_count #=> Integer
resp.service.task_sets[0].created_at #=> Time
resp.service.task_sets[0].updated_at #=> Time
resp.service.task_sets[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.task_sets[0].capacity_provider_strategy #=> Array
resp.service.task_sets[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.task_sets[0].capacity_provider_strategy[0].base #=> Integer
resp.service.task_sets[0].platform_version #=> String
resp.service.task_sets[0].platform_family #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.task_sets[0].load_balancers #=> Array
resp.service.task_sets[0].load_balancers[0].target_group_arn #=> String
resp.service.task_sets[0].load_balancers[0].load_balancer_name #=> String
resp.service.task_sets[0].load_balancers[0].container_name #=> String
resp.service.task_sets[0].load_balancers[0].container_port #=> Integer
resp.service.task_sets[0].service_registries #=> Array
resp.service.task_sets[0].service_registries[0].registry_arn #=> String
resp.service.task_sets[0].service_registries[0].port #=> Integer
resp.service.task_sets[0].service_registries[0].container_name #=> String
resp.service.task_sets[0].service_registries[0].container_port #=> Integer
resp.service.task_sets[0].scale.value #=> Float
resp.service.task_sets[0].scale.unit #=> String, one of "PERCENT"
resp.service.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.service.task_sets[0].stability_status_at #=> Time
resp.service.task_sets[0].tags #=> Array
resp.service.task_sets[0].tags[0].key #=> String
resp.service.task_sets[0].tags[0].value #=> String
resp.service.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.deployments #=> Array
resp.service.deployments[0].id #=> String
resp.service.deployments[0].status #=> String
resp.service.deployments[0].task_definition #=> String
resp.service.deployments[0].desired_count #=> Integer
resp.service.deployments[0].pending_count #=> Integer
resp.service.deployments[0].running_count #=> Integer
resp.service.deployments[0].failed_tasks #=> Integer
resp.service.deployments[0].created_at #=> Time
resp.service.deployments[0].updated_at #=> Time
resp.service.deployments[0].capacity_provider_strategy #=> Array
resp.service.deployments[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.deployments[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.deployments[0].capacity_provider_strategy[0].base #=> Integer
resp.service.deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.deployments[0].platform_version #=> String
resp.service.deployments[0].platform_family #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.deployments[0].rollout_state #=> String, one of "COMPLETED", "FAILED", "IN_PROGRESS"
resp.service.deployments[0].rollout_state_reason #=> String
resp.service.deployments[0].service_connect_configuration.enabled #=> Boolean
resp.service.deployments[0].service_connect_configuration.namespace #=> String
resp.service.deployments[0].service_connect_configuration.services #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].port_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].discovery_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.kms_key #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.role_arn #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.service.deployments[0].service_connect_configuration.log_configuration.options #=> Hash
resp.service.deployments[0].service_connect_configuration.log_configuration.options["String"] #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options #=> Array
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
resp.service.deployments[0].service_connect_resources #=> Array
resp.service.deployments[0].service_connect_resources[0].discovery_name #=> String
resp.service.deployments[0].service_connect_resources[0].discovery_arn #=> String
resp.service.deployments[0].volume_configurations #=> Array
resp.service.deployments[0].volume_configurations[0].name #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.role_arn #=> String
resp.service.events #=> Array
resp.service.events[0].id #=> String
resp.service.events[0].created_at #=> Time
resp.service.events[0].message #=> String
resp.service.created_at #=> Time
resp.service.placement_constraints #=> Array
resp.service.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.service.placement_constraints[0].expression #=> String
resp.service.placement_strategy #=> Array
resp.service.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.service.placement_strategy[0].field #=> String
resp.service.network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.health_check_grace_period_seconds #=> Integer
resp.service.scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
resp.service.deployment_controller.type #=> String, one of "ECS", "CODE_DEPLOY", "EXTERNAL"
resp.service.tags #=> Array
resp.service.tags[0].key #=> String
resp.service.tags[0].value #=> String
resp.service.created_by #=> String
resp.service.enable_ecs_managed_tags #=> Boolean
resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.enable_execute_command #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

  • :service (required, String)

    The name of the service to delete.

  • :force (Boolean)

    If true, allows you to delete a service even if it wasn't scaled down to zero tasks. It's only necessary to use this if the service uses the REPLICA scheduling strategy.

Returns:

See Also:



2514
2515
2516
2517
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2514

def delete_service(params = {}, options = {})
  req = build_request(:delete_service, params)
  req.send_request(options)
end

#delete_task_definitions(params = {}) ⇒ Types::DeleteTaskDefinitionsResponse

Deletes one or more task definitions.

You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service's desired count.

You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition revision.

A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.

When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.

Examples:

Request syntax with placeholder values


resp = client.delete_task_definitions({
  task_definitions: ["String"], # required
})

Response structure


resp.task_definitions #=> Array
resp.task_definitions[0].task_definition_arn #=> String
resp.task_definitions[0].container_definitions #=> Array
resp.task_definitions[0].container_definitions[0].name #=> String
resp.task_definitions[0].container_definitions[0].image #=> String
resp.task_definitions[0].container_definitions[0].repository_credentials.credentials_parameter #=> String
resp.task_definitions[0].container_definitions[0].cpu #=> Integer
resp.task_definitions[0].container_definitions[0].memory #=> Integer
resp.task_definitions[0].container_definitions[0].memory_reservation #=> Integer
resp.task_definitions[0].container_definitions[0].links #=> Array
resp.task_definitions[0].container_definitions[0].links[0] #=> String
resp.task_definitions[0].container_definitions[0].port_mappings #=> Array
resp.task_definitions[0].container_definitions[0].port_mappings[0].container_port #=> Integer
resp.task_definitions[0].container_definitions[0].port_mappings[0].host_port #=> Integer
resp.task_definitions[0].container_definitions[0].port_mappings[0].protocol #=> String, one of "tcp", "udp"
resp.task_definitions[0].container_definitions[0].port_mappings[0].name #=> String
resp.task_definitions[0].container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
resp.task_definitions[0].container_definitions[0].port_mappings[0].container_port_range #=> String
resp.task_definitions[0].container_definitions[0].essential #=> Boolean
resp.task_definitions[0].container_definitions[0].entry_point #=> Array
resp.task_definitions[0].container_definitions[0].entry_point[0] #=> String
resp.task_definitions[0].container_definitions[0].command #=> Array
resp.task_definitions[0].container_definitions[0].command[0] #=> String
resp.task_definitions[0].container_definitions[0].environment #=> Array
resp.task_definitions[0].container_definitions[0].environment[0].name #=> String
resp.task_definitions[0].container_definitions[0].environment[0].value #=> String
resp.task_definitions[0].container_definitions[0].environment_files #=> Array
resp.task_definitions[0].container_definitions[0].environment_files[0].value #=> String
resp.task_definitions[0].container_definitions[0].environment_files[0].type #=> String, one of "s3"
resp.task_definitions[0].container_definitions[0].mount_points #=> Array
resp.task_definitions[0].container_definitions[0].mount_points[0].source_volume #=> String
resp.task_definitions[0].container_definitions[0].mount_points[0].container_path #=> String
resp.task_definitions[0].container_definitions[0].mount_points[0].read_only #=> Boolean
resp.task_definitions[0].container_definitions[0].volumes_from #=> Array
resp.task_definitions[0].container_definitions[0].volumes_from[0].source_container #=> String
resp.task_definitions[0].container_definitions[0].volumes_from[0].read_only #=> Boolean
resp.task_definitions[0].container_definitions[0].linux_parameters.capabilities.add #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.capabilities.add[0] #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.capabilities.drop #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.capabilities.drop[0] #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.devices #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.devices[0].host_path #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.devices[0].container_path #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.devices[0].permissions #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.devices[0].permissions[0] #=> String, one of "read", "write", "mknod"
resp.task_definitions[0].container_definitions[0].linux_parameters.init_process_enabled #=> Boolean
resp.task_definitions[0].container_definitions[0].linux_parameters.shared_memory_size #=> Integer
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs[0].container_path #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs[0].size #=> Integer
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs[0].mount_options #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.max_swap #=> Integer
resp.task_definitions[0].container_definitions[0].linux_parameters.swappiness #=> Integer
resp.task_definitions[0].container_definitions[0].secrets #=> Array
resp.task_definitions[0].container_definitions[0].secrets[0].name #=> String
resp.task_definitions[0].container_definitions[0].secrets[0].value_from #=> String
resp.task_definitions[0].container_definitions[0].depends_on #=> Array
resp.task_definitions[0].container_definitions[0].depends_on[0].container_name #=> String
resp.task_definitions[0].container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
resp.task_definitions[0].container_definitions[0].start_timeout #=> Integer
resp.task_definitions[0].container_definitions[0].stop_timeout #=> Integer
resp.task_definitions[0].container_definitions[0].hostname #=> String
resp.task_definitions[0].container_definitions[0].user #=> String
resp.task_definitions[0].container_definitions[0].working_directory #=> String
resp.task_definitions[0].container_definitions[0].disable_networking #=> Boolean
resp.task_definitions[0].container_definitions[0].privileged #=> Boolean
resp.task_definitions[0].container_definitions[0].readonly_root_filesystem #=> Boolean
resp.task_definitions[0].container_definitions[0].dns_servers #=> Array
resp.task_definitions[0].container_definitions[0].dns_servers[0] #=> String
resp.task_definitions[0].container_definitions[0].dns_search_domains #=> Array
resp.task_definitions[0].container_definitions[0].dns_search_domains[0] #=> String
resp.task_definitions[0].container_definitions[0].extra_hosts #=> Array
resp.task_definitions[0].container_definitions[0].extra_hosts[0].hostname #=> String
resp.task_definitions[0].container_definitions[0].extra_hosts[0].ip_address #=> String
resp.task_definitions[0].container_definitions[0].docker_security_options #=> Array
resp.task_definitions[0].container_definitions[0].docker_security_options[0] #=> String
resp.task_definitions[0].container_definitions[0].interactive #=> Boolean
resp.task_definitions[0].container_definitions[0].pseudo_terminal #=> Boolean
resp.task_definitions[0].container_definitions[0].docker_labels #=> Hash
resp.task_definitions[0].container_definitions[0].docker_labels["String"] #=> String
resp.task_definitions[0].container_definitions[0].ulimits #=> Array
resp.task_definitions[0].container_definitions[0].ulimits[0].name #=> String, one of "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack"
resp.task_definitions[0].container_definitions[0].ulimits[0].soft_limit #=> Integer
resp.task_definitions[0].container_definitions[0].ulimits[0].hard_limit #=> Integer
resp.task_definitions[0].container_definitions[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.task_definitions[0].container_definitions[0].log_configuration.options #=> Hash
resp.task_definitions[0].container_definitions[0].log_configuration.options["String"] #=> String
resp.task_definitions[0].container_definitions[0].log_configuration.secret_options #=> Array
resp.task_definitions[0].container_definitions[0].log_configuration.secret_options[0].name #=> String
resp.task_definitions[0].container_definitions[0].log_configuration.secret_options[0].value_from #=> String
resp.task_definitions[0].container_definitions[0].health_check.command #=> Array
resp.task_definitions[0].container_definitions[0].health_check.command[0] #=> String
resp.task_definitions[0].container_definitions[0].health_check.interval #=> Integer
resp.task_definitions[0].container_definitions[0].health_check.timeout #=> Integer
resp.task_definitions[0].container_definitions[0].health_check.retries #=> Integer
resp.task_definitions[0].container_definitions[0].health_check.start_period #=> Integer
resp.task_definitions[0].container_definitions[0].system_controls #=> Array
resp.task_definitions[0].container_definitions[0].system_controls[0].namespace #=> String
resp.task_definitions[0].container_definitions[0].system_controls[0].value #=> String
resp.task_definitions[0].container_definitions[0].resource_requirements #=> Array
resp.task_definitions[0].container_definitions[0].resource_requirements[0].value #=> String
resp.task_definitions[0].container_definitions[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.task_definitions[0].container_definitions[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
resp.task_definitions[0].container_definitions[0].firelens_configuration.options #=> Hash
resp.task_definitions[0].container_definitions[0].firelens_configuration.options["String"] #=> String
resp.task_definitions[0].container_definitions[0].credential_specs #=> Array
resp.task_definitions[0].container_definitions[0].credential_specs[0] #=> String
resp.task_definitions[0].family #=> String
resp.task_definitions[0].task_role_arn #=> String
resp.task_definitions[0].execution_role_arn #=> String
resp.task_definitions[0].network_mode #=> String, one of "bridge", "host", "awsvpc", "none"
resp.task_definitions[0].revision #=> Integer
resp.task_definitions[0].volumes #=> Array
resp.task_definitions[0].volumes[0].name #=> String
resp.task_definitions[0].volumes[0].host.source_path #=> String
resp.task_definitions[0].volumes[0].docker_volume_configuration.scope #=> String, one of "task", "shared"
resp.task_definitions[0].volumes[0].docker_volume_configuration.autoprovision #=> Boolean
resp.task_definitions[0].volumes[0].docker_volume_configuration.driver #=> String
resp.task_definitions[0].volumes[0].docker_volume_configuration.driver_opts #=> Hash
resp.task_definitions[0].volumes[0].docker_volume_configuration.driver_opts["String"] #=> String
resp.task_definitions[0].volumes[0].docker_volume_configuration.labels #=> Hash
resp.task_definitions[0].volumes[0].docker_volume_configuration.labels["String"] #=> String
resp.task_definitions[0].volumes[0].efs_volume_configuration.file_system_id #=> String
resp.task_definitions[0].volumes[0].efs_volume_configuration.root_directory #=> String
resp.task_definitions[0].volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
resp.task_definitions[0].volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
resp.task_definitions[0].volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
resp.task_definitions[0].volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
resp.task_definitions[0].volumes[0].fsx_windows_file_server_volume_configuration.file_system_id #=> String
resp.task_definitions[0].volumes[0].fsx_windows_file_server_volume_configuration.root_directory #=> String
resp.task_definitions[0].volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.credentials_parameter #=> String
resp.task_definitions[0].volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.domain #=> String
resp.task_definitions[0].volumes[0].configured_at_launch #=> Boolean
resp.task_definitions[0].status #=> String, one of "ACTIVE", "INACTIVE", "DELETE_IN_PROGRESS"
resp.task_definitions[0].requires_attributes #=> Array
resp.task_definitions[0].requires_attributes[0].name #=> String
resp.task_definitions[0].requires_attributes[0].value #=> String
resp.task_definitions[0].requires_attributes[0].target_type #=> String, one of "container-instance"
resp.task_definitions[0].requires_attributes[0].target_id #=> String
resp.task_definitions[0].placement_constraints #=> Array
resp.task_definitions[0].placement_constraints[0].type #=> String, one of "memberOf"
resp.task_definitions[0].placement_constraints[0].expression #=> String
resp.task_definitions[0].compatibilities #=> Array
resp.task_definitions[0].compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definitions[0].runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
resp.task_definitions[0].runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
resp.task_definitions[0].requires_compatibilities #=> Array
resp.task_definitions[0].requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definitions[0].cpu #=> String
resp.task_definitions[0].memory #=> String
resp.task_definitions[0].inference_accelerators #=> Array
resp.task_definitions[0].inference_accelerators[0].device_name #=> String
resp.task_definitions[0].inference_accelerators[0].device_type #=> String
resp.task_definitions[0].pid_mode #=> String, one of "host", "task"
resp.task_definitions[0].ipc_mode #=> String, one of "host", "task", "none"
resp.task_definitions[0].proxy_configuration.type #=> String, one of "APPMESH"
resp.task_definitions[0].proxy_configuration.container_name #=> String
resp.task_definitions[0].proxy_configuration.properties #=> Array
resp.task_definitions[0].proxy_configuration.properties[0].name #=> String
resp.task_definitions[0].proxy_configuration.properties[0].value #=> String
resp.task_definitions[0].registered_at #=> Time
resp.task_definitions[0].deregistered_at #=> Time
resp.task_definitions[0].registered_by #=> String
resp.task_definitions[0].ephemeral_storage.size_in_gi_b #=> Integer
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :task_definitions (required, Array<String>)

    The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to delete. You must specify a revision.

    You can specify up to 10 task definitions as a comma separated list.

Returns:

See Also:



2745
2746
2747
2748
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2745

def delete_task_definitions(params = {}, options = {})
  req = build_request(:delete_task_definitions, params)
  req.send_request(options)
end

#delete_task_set(params = {}) ⇒ Types::DeleteTaskSetResponse

Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_task_set({
  cluster: "String", # required
  service: "String", # required
  task_set: "String", # required
  force: false,
})

Response structure


resp.task_set.id #=> String
resp.task_set.task_set_arn #=> String
resp.task_set.service_arn #=> String
resp.task_set.cluster_arn #=> String
resp.task_set.started_by #=> String
resp.task_set.external_id #=> String
resp.task_set.status #=> String
resp.task_set.task_definition #=> String
resp.task_set.computed_desired_count #=> Integer
resp.task_set.pending_count #=> Integer
resp.task_set.running_count #=> Integer
resp.task_set.created_at #=> Time
resp.task_set.updated_at #=> Time
resp.task_set.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_set.capacity_provider_strategy #=> Array
resp.task_set.capacity_provider_strategy[0].capacity_provider #=> String
resp.task_set.capacity_provider_strategy[0].weight #=> Integer
resp.task_set.capacity_provider_strategy[0].base #=> Integer
resp.task_set.platform_version #=> String
resp.task_set.platform_family #=> String
resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.task_set.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.task_set.load_balancers #=> Array
resp.task_set.load_balancers[0].target_group_arn #=> String
resp.task_set.load_balancers[0].load_balancer_name #=> String
resp.task_set.load_balancers[0].container_name #=> String
resp.task_set.load_balancers[0].container_port #=> Integer
resp.task_set.service_registries #=> Array
resp.task_set.service_registries[0].registry_arn #=> String
resp.task_set.service_registries[0].port #=> Integer
resp.task_set.service_registries[0].container_name #=> String
resp.task_set.service_registries[0].container_port #=> Integer
resp.task_set.scale.value #=> Float
resp.task_set.scale.unit #=> String, one of "PERCENT"
resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.task_set.stability_status_at #=> Time
resp.task_set.tags #=> Array
resp.task_set.tags[0].key #=> String
resp.task_set.tags[0].value #=> String
resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster (required, String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.

  • :service (required, String)

    The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

  • :task_set (required, String)

    The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

  • :force (Boolean)

    If true, you can delete a task set even if it hasn't been scaled down to zero.

Returns:

See Also:



2838
2839
2840
2841
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2838

def delete_task_set(params = {}, options = {})
  req = build_request(:delete_task_set, params)
  req.send_request(options)
end

#deregister_container_instance(params = {}) ⇒ Types::DeregisterContainerInstanceResponse

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).

Examples:

Example: To deregister a container instance from a cluster


# This example deregisters a container instance from the specified cluster in your default region. If there are still
# tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.

resp = client.deregister_container_instance({
  cluster: "default", 
  container_instance: "container_instance_UUID", 
  force: true, 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.deregister_container_instance({
  cluster: "String",
  container_instance: "String", # required
  force: false,
})

Response structure


resp.container_instance.container_instance_arn #=> String
resp.container_instance.ec2_instance_id #=> String
resp.container_instance.capacity_provider_name #=> String
resp.container_instance.version #=> Integer
resp.container_instance.version_info.agent_version #=> String
resp.container_instance.version_info.agent_hash #=> String
resp.container_instance.version_info.docker_version #=> String
resp.container_instance.remaining_resources #=> Array
resp.container_instance.remaining_resources[0].name #=> String
resp.container_instance.remaining_resources[0].type #=> String
resp.container_instance.remaining_resources[0].double_value #=> Float
resp.container_instance.remaining_resources[0].long_value #=> Integer
resp.container_instance.remaining_resources[0].integer_value #=> Integer
resp.container_instance.remaining_resources[0].string_set_value #=> Array
resp.container_instance.remaining_resources[0].string_set_value[0] #=> String
resp.container_instance.registered_resources #=> Array
resp.container_instance.registered_resources[0].name #=> String
resp.container_instance.registered_resources[0].type #=> String
resp.container_instance.registered_resources[0].double_value #=> Float
resp.container_instance.registered_resources[0].long_value #=> Integer
resp.container_instance.registered_resources[0].integer_value #=> Integer
resp.container_instance.registered_resources[0].string_set_value #=> Array
resp.container_instance.registered_resources[0].string_set_value[0] #=> String
resp.container_instance.status #=> String
resp.container_instance.status_reason #=> String
resp.container_instance.agent_connected #=> Boolean
resp.container_instance.running_tasks_count #=> Integer
resp.container_instance.pending_tasks_count #=> Integer
resp.container_instance.agent_update_status #=> String, one of "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED"
resp.container_instance.attributes #=> Array
resp.container_instance.attributes[0].name #=> String
resp.container_instance.attributes[0].value #=> String
resp.container_instance.attributes[0].target_type #=> String, one of "container-instance"
resp.container_instance.attributes[0].target_id #=> String
resp.container_instance.registered_at #=> Time
resp.container_instance.attachments #=> Array
resp.container_instance.attachments[0].id #=> String
resp.container_instance.attachments[0].type #=> String
resp.container_instance.attachments[0].status #=> String
resp.container_instance.attachments[0].details #=> Array
resp.container_instance.attachments[0].details[0].name #=> String
resp.container_instance.attachments[0].details[0].value #=> String
resp.container_instance.tags #=> Array
resp.container_instance.tags[0].key #=> String
resp.container_instance.tags[0].value #=> String
resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instance.health_status.details #=> Array
resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instance.health_status.details[0].last_updated #=> Time
resp.container_instance.health_status.details[0].last_status_change #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

  • :container_instance (required, String)

    The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

  • :force (Boolean)

    Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

    Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

Returns:

See Also:



2978
2979
2980
2981
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2978

def deregister_container_instance(params = {}, options = {})
  req = build_request(:deregister_container_instance, params)
  req.send_request(options)
end

#deregister_task_definition(params = {}) ⇒ Types::DeregisterTaskDefinitionResponse

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.

You can't use an INACTIVE task definition to run new tasks or create new services, and you can't update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.

Examples:

Request syntax with placeholder values


resp = client.deregister_task_definition({
  task_definition: "String", # required
})

Response structure


resp.task_definition.task_definition_arn #=> String
resp.task_definition.container_definitions #=> Array
resp.task_definition.container_definitions[0].name #=> String
resp.task_definition.container_definitions[0].image #=> String
resp.task_definition.container_definitions[0].repository_credentials.credentials_parameter #=> String
resp.task_definition.container_definitions[0].cpu #=> Integer
resp.task_definition.container_definitions[0].memory #=> Integer
resp.task_definition.container_definitions[0].memory_reservation #=> Integer
resp.task_definition.container_definitions[0].links #=> Array
resp.task_definition.container_definitions[0].links[0] #=> String
resp.task_definition.container_definitions[0].port_mappings #=> Array
resp.task_definition.container_definitions[0].port_mappings[0].container_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].host_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].protocol #=> String, one of "tcp", "udp"
resp.task_definition.container_definitions[0].port_mappings[0].name #=> String
resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
resp.task_definition.container_definitions[0].essential #=> Boolean
resp.task_definition.container_definitions[0].entry_point #=> Array
resp.task_definition.container_definitions[0].entry_point[0] #=> String
resp.task_definition.container_definitions[0].command #=> Array
resp.task_definition.container_definitions[0].command[0] #=> String
resp.task_definition.container_definitions[0].environment #=> Array
resp.task_definition.container_definitions[0].environment[0].name #=> String
resp.task_definition.container_definitions[0].environment[0].value #=> String
resp.task_definition.container_definitions[0].environment_files #=> Array
resp.task_definition.container_definitions[0].environment_files[0].value #=> String
resp.task_definition.container_definitions[0].environment_files[0].type #=> String, one of "s3"
resp.task_definition.container_definitions[0].mount_points #=> Array
resp.task_definition.container_definitions[0].mount_points[0].source_volume #=> String
resp.task_definition.container_definitions[0].mount_points[0].container_path #=> String
resp.task_definition.container_definitions[0].mount_points[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].volumes_from #=> Array
resp.task_definition.container_definitions[0].volumes_from[0].source_container #=> String
resp.task_definition.container_definitions[0].volumes_from[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].host_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].container_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions[0] #=> String, one of "read", "write", "mknod"
resp.task_definition.container_definitions[0].linux_parameters.init_process_enabled #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.shared_memory_size #=> Integer
resp.task_definition.container_definitions[0].linux_parameters.tmpfs #=> Array
resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].container_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].size #=> Integer
resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options #=> Array
resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.max_swap #=> Integer
resp.task_definition.container_definitions[0].linux_parameters.swappiness #=> Integer
resp.task_definition.container_definitions[0].secrets #=> Array
resp.task_definition.container_definitions[0].secrets[0].name #=> String
resp.task_definition.container_definitions[0].secrets[0].value_from #=> String
resp.task_definition.container_definitions[0].depends_on #=> Array
resp.task_definition.container_definitions[0].depends_on[0].container_name #=> String
resp.task_definition.container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
resp.task_definition.container_definitions[0].start_timeout #=> Integer
resp.task_definition.container_definitions[0].stop_timeout #=> Integer
resp.task_definition.container_definitions[0].hostname #=> String
resp.task_definition.container_definitions[0].user #=> String
resp.task_definition.container_definitions[0].working_directory #=> String
resp.task_definition.container_definitions[0].disable_networking #=> Boolean
resp.task_definition.container_definitions[0].privileged #=> Boolean
resp.task_definition.container_definitions[0].readonly_root_filesystem #=> Boolean
resp.task_definition.container_definitions[0].dns_servers #=> Array
resp.task_definition.container_definitions[0].dns_servers[0] #=> String
resp.task_definition.container_definitions[0].dns_search_domains #=> Array
resp.task_definition.container_definitions[0].dns_search_domains[0] #=> String
resp.task_definition.container_definitions[0].extra_hosts #=> Array
resp.task_definition.container_definitions[0].extra_hosts[0].hostname #=> String
resp.task_definition.container_definitions[0].extra_hosts[0].ip_address #=> String
resp.task_definition.container_definitions[0].docker_security_options #=> Array
resp.task_definition.container_definitions[0].docker_security_options[0] #=> String
resp.task_definition.container_definitions[0].interactive #=> Boolean
resp.task_definition.container_definitions[0].pseudo_terminal #=> Boolean
resp.task_definition.container_definitions[0].docker_labels #=> Hash
resp.task_definition.container_definitions[0].docker_labels["String"] #=> String
resp.task_definition.container_definitions[0].ulimits #=> Array
resp.task_definition.container_definitions[0].ulimits[0].name #=> String, one of "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack"
resp.task_definition.container_definitions[0].ulimits[0].soft_limit #=> Integer
resp.task_definition.container_definitions[0].ulimits[0].hard_limit #=> Integer
resp.task_definition.container_definitions[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.task_definition.container_definitions[0].log_configuration.options #=> Hash
resp.task_definition.container_definitions[0].log_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options #=> Array
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].name #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].value_from #=> String
resp.task_definition.container_definitions[0].health_check.command #=> Array
resp.task_definition.container_definitions[0].health_check.command[0] #=> String
resp.task_definition.container_definitions[0].health_check.interval #=> Integer
resp.task_definition.container_definitions[0].health_check.timeout #=> Integer
resp.task_definition.container_definitions[0].health_check.retries #=> Integer
resp.task_definition.container_definitions[0].health_check.start_period #=> Integer
resp.task_definition.container_definitions[0].system_controls #=> Array
resp.task_definition.container_definitions[0].system_controls[0].namespace #=> String
resp.task_definition.container_definitions[0].system_controls[0].value #=> String
resp.task_definition.container_definitions[0].resource_requirements #=> Array
resp.task_definition.container_definitions[0].resource_requirements[0].value #=> String
resp.task_definition.container_definitions[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.task_definition.container_definitions[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
resp.task_definition.container_definitions[0].firelens_configuration.options #=> Hash
resp.task_definition.container_definitions[0].firelens_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].credential_specs #=> Array
resp.task_definition.container_definitions[0].credential_specs[0] #=> String
resp.task_definition.family #=> String
resp.task_definition.task_role_arn #=> String
resp.task_definition.execution_role_arn #=> String
resp.task_definition.network_mode #=> String, one of "bridge", "host", "awsvpc", "none"
resp.task_definition.revision #=> Integer
resp.task_definition.volumes #=> Array
resp.task_definition.volumes[0].name #=> String
resp.task_definition.volumes[0].host.source_path #=> String
resp.task_definition.volumes[0].docker_volume_configuration.scope #=> String, one of "task", "shared"
resp.task_definition.volumes[0].docker_volume_configuration.autoprovision #=> Boolean
resp.task_definition.volumes[0].docker_volume_configuration.driver #=> String
resp.task_definition.volumes[0].docker_volume_configuration.driver_opts #=> Hash
resp.task_definition.volumes[0].docker_volume_configuration.driver_opts["String"] #=> String
resp.task_definition.volumes[0].docker_volume_configuration.labels #=> Hash
resp.task_definition.volumes[0].docker_volume_configuration.labels["String"] #=> String
resp.task_definition.volumes[0].efs_volume_configuration.file_system_id #=> String
resp.task_definition.volumes[0].efs_volume_configuration.root_directory #=> String
resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.file_system_id #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.root_directory #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.credentials_parameter #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.domain #=> String
resp.task_definition.volumes[0].configured_at_launch #=> Boolean
resp.task_definition.status #=> String, one of "ACTIVE", "INACTIVE", "DELETE_IN_PROGRESS"
resp.task_definition.requires_attributes #=> Array
resp.task_definition.requires_attributes[0].name #=> String
resp.task_definition.requires_attributes[0].value #=> String
resp.task_definition.requires_attributes[0].target_type #=> String, one of "container-instance"
resp.task_definition.requires_attributes[0].target_id #=> String
resp.task_definition.placement_constraints #=> Array
resp.task_definition.placement_constraints[0].type #=> String, one of "memberOf"
resp.task_definition.placement_constraints[0].expression #=> String
resp.task_definition.compatibilities #=> Array
resp.task_definition.compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definition.runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
resp.task_definition.runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
resp.task_definition.requires_compatibilities #=> Array
resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definition.cpu #=> String
resp.task_definition.memory #=> String
resp.task_definition.inference_accelerators #=> Array
resp.task_definition.inference_accelerators[0].device_name #=> String
resp.task_definition.inference_accelerators[0].device_type #=> String
resp.task_definition.pid_mode #=> String, one of "host", "task"
resp.task_definition.ipc_mode #=> String, one of "host", "task", "none"
resp.task_definition.proxy_configuration.type #=> String, one of "APPMESH"
resp.task_definition.proxy_configuration.container_name #=> String
resp.task_definition.proxy_configuration.properties #=> Array
resp.task_definition.proxy_configuration.properties[0].name #=> String
resp.task_definition.proxy_configuration.properties[0].value #=> String
resp.task_definition.registered_at #=> Time
resp.task_definition.deregistered_at #=> Time
resp.task_definition.registered_by #=> String
resp.task_definition.ephemeral_storage.size_in_gi_b #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :task_definition (required, String)

    The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

Returns:

See Also:



3198
3199
3200
3201
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3198

def deregister_task_definition(params = {}, options = {})
  req = build_request(:deregister_task_definition, params)
  req.send_request(options)
end

#describe_capacity_providers(params = {}) ⇒ Types::DescribeCapacityProvidersResponse

Describes one or more of your capacity providers.

Examples:

Request syntax with placeholder values


resp = client.describe_capacity_providers({
  capacity_providers: ["String"],
  include: ["TAGS"], # accepts TAGS
  max_results: 1,
  next_token: "String",
})

Response structure


resp.capacity_providers #=> Array
resp.capacity_providers[0].capacity_provider_arn #=> String
resp.capacity_providers[0].name #=> String
resp.capacity_providers[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.capacity_providers[0].auto_scaling_group_provider.auto_scaling_group_arn #=> String
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.instance_warmup_period #=> Integer
resp.capacity_providers[0].auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
resp.capacity_providers[0].auto_scaling_group_provider.managed_draining #=> String, one of "ENABLED", "DISABLED"
resp.capacity_providers[0].update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.capacity_providers[0].update_status_reason #=> String
resp.capacity_providers[0].tags #=> Array
resp.capacity_providers[0].tags[0].key #=> String
resp.capacity_providers[0].tags[0].value #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :capacity_providers (Array<String>)

    The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

  • :include (Array<String>)

    Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

  • :max_results (Integer)

    The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders 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 DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

  • :next_token (String)

    The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

See Also:



3284
3285
3286
3287
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3284

def describe_capacity_providers(params = {}, options = {})
  req = build_request(:describe_capacity_providers, params)
  req.send_request(options)
end

#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse

Describes one or more of your clusters.

Examples:

Example: To describe a cluster


# This example provides a description of the specified cluster in your default region.

resp = client.describe_clusters({
  clusters: [
    "default", 
  ], 
})

resp.to_h outputs the following:
{
  clusters: [
    {
      cluster_arn: "arn:aws:ecs:us-east-1:aws_account_id:cluster/default", 
      cluster_name: "default", 
      status: "ACTIVE", 
    }, 
  ], 
  failures: [
  ], 
}

Request syntax with placeholder values


resp = client.describe_clusters({
  clusters: ["String"],
  include: ["ATTACHMENTS"], # accepts ATTACHMENTS, CONFIGURATIONS, SETTINGS, STATISTICS, TAGS
})

Response structure


resp.clusters #=> Array
resp.clusters[0].cluster_arn #=> String
resp.clusters[0].cluster_name #=> String
resp.clusters[0].configuration.execute_command_configuration.kms_key_id #=> String
resp.clusters[0].configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.clusters[0].configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.clusters[0].configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.clusters[0].configuration.managed_storage_configuration.kms_key_id #=> String
resp.clusters[0].configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.clusters[0].status #=> String
resp.clusters[0].registered_container_instances_count #=> Integer
resp.clusters[0].running_tasks_count #=> Integer
resp.clusters[0].pending_tasks_count #=> Integer
resp.clusters[0].active_services_count #=> Integer
resp.clusters[0].statistics #=> Array
resp.clusters[0].statistics[0].name #=> String
resp.clusters[0].statistics[0].value #=> String
resp.clusters[0].tags #=> Array
resp.clusters[0].tags[0].key #=> String
resp.clusters[0].tags[0].value #=> String
resp.clusters[0].settings #=> Array
resp.clusters[0].settings[0].name #=> String, one of "containerInsights"
resp.clusters[0].settings[0].value #=> String
resp.clusters[0].capacity_providers #=> Array
resp.clusters[0].capacity_providers[0] #=> String
resp.clusters[0].default_capacity_provider_strategy #=> Array
resp.clusters[0].default_capacity_provider_strategy[0].capacity_provider #=> String
resp.clusters[0].default_capacity_provider_strategy[0].weight #=> Integer
resp.clusters[0].default_capacity_provider_strategy[0].base #=> Integer
resp.clusters[0].attachments #=> Array
resp.clusters[0].attachments[0].id #=> String
resp.clusters[0].attachments[0].type #=> String
resp.clusters[0].attachments[0].status #=> String
resp.clusters[0].attachments[0].details #=> Array
resp.clusters[0].attachments[0].details[0].name #=> String
resp.clusters[0].attachments[0].details[0].value #=> String
resp.clusters[0].attachments_status #=> String
resp.clusters[0].service_connect_defaults.namespace #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :clusters (Array<String>)

    A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

  • :include (Array<String>)

    Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

    If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

    If SETTINGS is specified, the settings for the cluster are included.

    If CONFIGURATIONS is specified, the configuration for the cluster is included.

    If STATISTICS is specified, the task and service count is included, separated by launch type.

    If TAGS is specified, the metadata tags associated with the cluster are included.

Returns:

See Also:



3404
3405
3406
3407
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3404

def describe_clusters(params = {}, options = {})
  req = build_request(:describe_clusters, params)
  req.send_request(options)
end

#describe_container_instances(params = {}) ⇒ Types::DescribeContainerInstancesResponse

Describes one or more container instances. Returns metadata about each container instance requested.

Examples:

Example: To describe container instance


# This example provides a description of the specified container instance in your default region, using the container
# instance UUID as an identifier.

resp = client.describe_container_instances({
  cluster: "default", 
  container_instances: [
    "f2756532-8f13-4d53-87c9-aed50dc94cd7", 
  ], 
})

resp.to_h outputs the following:
{
  container_instances: [
    {
      agent_connected: true, 
      container_instance_arn: "arn:aws:ecs:us-east-1:012345678910:container-instance/default/f2756532-8f13-4d53-87c9-aed50dc94cd7", 
      ec2_instance_id: "i-807f3249", 
      pending_tasks_count: 0, 
      registered_resources: [
        {
          name: "CPU", 
          type: "INTEGER", 
          double_value: 0.0, 
          integer_value: 2048, 
          long_value: 0, 
        }, 
        {
          name: "MEMORY", 
          type: "INTEGER", 
          double_value: 0.0, 
          integer_value: 3768, 
          long_value: 0, 
        }, 
        {
          name: "PORTS", 
          type: "STRINGSET", 
          double_value: 0.0, 
          integer_value: 0, 
          long_value: 0, 
          string_set_value: [
            "2376", 
            "22", 
            "51678", 
            "2375", 
          ], 
        }, 
      ], 
      remaining_resources: [
        {
          name: "CPU", 
          type: "INTEGER", 
          double_value: 0.0, 
          integer_value: 1948, 
          long_value: 0, 
        }, 
        {
          name: "MEMORY", 
          type: "INTEGER", 
          double_value: 0.0, 
          integer_value: 3668, 
          long_value: 0, 
        }, 
        {
          name: "PORTS", 
          type: "STRINGSET", 
          double_value: 0.0, 
          integer_value: 0, 
          long_value: 0, 
          string_set_value: [
            "2376", 
            "22", 
            "80", 
            "51678", 
            "2375", 
          ], 
        }, 
      ], 
      running_tasks_count: 1, 
      status: "ACTIVE", 
    }, 
  ], 
  failures: [
  ], 
}

Request syntax with placeholder values


resp = client.describe_container_instances({
  cluster: "String",
  container_instances: ["String"], # required
  include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
})

Response structure


resp.container_instances #=> Array
resp.container_instances[0].container_instance_arn #=> String
resp.container_instances[0].ec2_instance_id #=> String
resp.container_instances[0].capacity_provider_name #=> String
resp.container_instances[0].version #=> Integer
resp.container_instances[0].version_info.agent_version #=> String
resp.container_instances[0].version_info.agent_hash #=> String
resp.container_instances[0].version_info.docker_version #=> String
resp.container_instances[0].remaining_resources #=> Array
resp.container_instances[0].remaining_resources[0].name #=> String
resp.container_instances[0].remaining_resources[0].type #=> String
resp.container_instances[0].remaining_resources[0].double_value #=> Float
resp.container_instances[0].remaining_resources[0].long_value #=> Integer
resp.container_instances[0].remaining_resources[0].integer_value #=> Integer
resp.container_instances[0].remaining_resources[0].string_set_value #=> Array
resp.container_instances[0].remaining_resources[0].string_set_value[0] #=> String
resp.container_instances[0].registered_resources #=> Array
resp.container_instances[0].registered_resources[0].name #=> String
resp.container_instances[0].registered_resources[0].type #=> String
resp.container_instances[0].registered_resources[0].double_value #=> Float
resp.container_instances[0].registered_resources[0].long_value #=> Integer
resp.container_instances[0].registered_resources[0].integer_value #=> Integer
resp.container_instances[0].registered_resources[0].string_set_value #=> Array
resp.container_instances[0].registered_resources[0].string_set_value[0] #=> String
resp.container_instances[0].status #=> String
resp.container_instances[0].status_reason #=> String
resp.container_instances[0].agent_connected #=> Boolean
resp.container_instances[0].running_tasks_count #=> Integer
resp.container_instances[0].pending_tasks_count #=> Integer
resp.container_instances[0].agent_update_status #=> String, one of "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED"
resp.container_instances[0].attributes #=> Array
resp.container_instances[0].attributes[0].name #=> String
resp.container_instances[0].attributes[0].value #=> String
resp.container_instances[0].attributes[0].target_type #=> String, one of "container-instance"
resp.container_instances[0].attributes[0].target_id #=> String
resp.container_instances[0].registered_at #=> Time
resp.container_instances[0].attachments #=> Array
resp.container_instances[0].attachments[0].id #=> String
resp.container_instances[0].attachments[0].type #=> String
resp.container_instances[0].attachments[0].status #=> String
resp.container_instances[0].attachments[0].details #=> Array
resp.container_instances[0].attachments[0].details[0].name #=> String
resp.container_instances[0].attachments[0].details[0].value #=> String
resp.container_instances[0].tags #=> Array
resp.container_instances[0].tags[0].key #=> String
resp.container_instances[0].tags[0].value #=> String
resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instances[0].health_status.details #=> Array
resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instances[0].health_status.details[0].last_updated #=> Time
resp.container_instances[0].health_status.details[0].last_status_change #=> Time
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

  • :container_instances (required, Array<String>)

    A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

  • :include (Array<String>)

    Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

Returns:

See Also:



3595
3596
3597
3598
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3595

def describe_container_instances(params = {}, options = {})
  req = build_request(:describe_container_instances, params)
  req.send_request(options)
end

#describe_services(params = {}) ⇒ Types::DescribeServicesResponse

Describes the specified services running in your cluster.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • services_inactive
  • services_stable

Examples:

Example: To describe a service


# This example provides descriptive information about the service named ``ecs-simple-service``.

resp = client.describe_services({
  services: [
    "ecs-simple-service", 
  ], 
})

resp.to_h outputs the following:
{
  failures: [
  ], 
  services: [
    {
      cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", 
      created_at: Time.parse("2016-08-29T16:25:52.130Z"), 
      deployment_configuration: {
        maximum_percent: 200, 
        minimum_healthy_percent: 100, 
      }, 
      deployments: [
        {
          created_at: Time.parse("2016-08-29T16:25:52.130Z"), 
          desired_count: 1, 
          id: "ecs-svc/9223370564341623665", 
          pending_count: 0, 
          running_count: 0, 
          status: "PRIMARY", 
          task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", 
          updated_at: Time.parse("2016-08-29T16:25:52.130Z"), 
        }, 
      ], 
      desired_count: 1, 
      events: [
        {
          created_at: Time.parse("2016-08-29T16:25:58.520Z"), 
          id: "38c285e5-d335-4b68-8b15-e46dedc8e88d", 
          message: "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide.", # In this example, there is a service event that shows unavailable cluster resources.
        }, 
      ], 
      load_balancers: [
      ], 
      pending_count: 0, 
      running_count: 0, 
      service_arn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", 
      service_name: "ecs-simple-service", 
      status: "ACTIVE", 
      task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_services({
  cluster: "String",
  services: ["String"], # required
  include: ["TAGS"], # accepts TAGS
})

Response structure


resp.services #=> Array
resp.services[0].service_arn #=> String
resp.services[0].service_name #=> String
resp.services[0].cluster_arn #=> String
resp.services[0].load_balancers #=> Array
resp.services[0].load_balancers[0].target_group_arn #=> String
resp.services[0].load_balancers[0].load_balancer_name #=> String
resp.services[0].load_balancers[0].container_name #=> String
resp.services[0].load_balancers[0].container_port #=> Integer
resp.services[0].service_registries #=> Array
resp.services[0].service_registries[0].registry_arn #=> String
resp.services[0].service_registries[0].port #=> Integer
resp.services[0].service_registries[0].container_name #=> String
resp.services[0].service_registries[0].container_port #=> Integer
resp.services[0].status #=> String
resp.services[0].desired_count #=> Integer
resp.services[0].running_count #=> Integer
resp.services[0].pending_count #=> Integer
resp.services[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.services[0].capacity_provider_strategy #=> Array
resp.services[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.services[0].capacity_provider_strategy[0].weight #=> Integer
resp.services[0].capacity_provider_strategy[0].base #=> Integer
resp.services[0].platform_version #=> String
resp.services[0].platform_family #=> String
resp.services[0].task_definition #=> String
resp.services[0].deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
resp.services[0].deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
resp.services[0].deployment_configuration.maximum_percent #=> Integer
resp.services[0].deployment_configuration.minimum_healthy_percent #=> Integer
resp.services[0].deployment_configuration.alarms.alarm_names #=> Array
resp.services[0].deployment_configuration.alarms.alarm_names[0] #=> String
resp.services[0].deployment_configuration.alarms.enable #=> Boolean
resp.services[0].deployment_configuration.alarms.rollback #=> Boolean
resp.services[0].task_sets #=> Array
resp.services[0].task_sets[0].id #=> String
resp.services[0].task_sets[0].task_set_arn #=> String
resp.services[0].task_sets[0].service_arn #=> String
resp.services[0].task_sets[0].cluster_arn #=> String
resp.services[0].task_sets[0].started_by #=> String
resp.services[0].task_sets[0].external_id #=> String
resp.services[0].task_sets[0].status #=> String
resp.services[0].task_sets[0].task_definition #=> String
resp.services[0].task_sets[0].computed_desired_count #=> Integer
resp.services[0].task_sets[0].pending_count #=> Integer
resp.services[0].task_sets[0].running_count #=> Integer
resp.services[0].task_sets[0].created_at #=> Time
resp.services[0].task_sets[0].updated_at #=> Time
resp.services[0].task_sets[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.services[0].task_sets[0].capacity_provider_strategy #=> Array
resp.services[0].task_sets[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.services[0].task_sets[0].capacity_provider_strategy[0].weight #=> Integer
resp.services[0].task_sets[0].capacity_provider_strategy[0].base #=> Integer
resp.services[0].task_sets[0].platform_version #=> String
resp.services[0].task_sets[0].platform_family #=> String
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.services[0].task_sets[0].load_balancers #=> Array
resp.services[0].task_sets[0].load_balancers[0].target_group_arn #=> String
resp.services[0].task_sets[0].load_balancers[0].load_balancer_name #=> String
resp.services[0].task_sets[0].load_balancers[0].container_name #=> String
resp.services[0].task_sets[0].load_balancers[0].container_port #=> Integer
resp.services[0].task_sets[0].service_registries #=> Array
resp.services[0].task_sets[0].service_registries[0].registry_arn #=> String
resp.services[0].task_sets[0].service_registries[0].port #=> Integer
resp.services[0].task_sets[0].service_registries[0].container_name #=> String
resp.services[0].task_sets[0].service_registries[0].container_port #=> Integer
resp.services[0].task_sets[0].scale.value #=> Float
resp.services[0].task_sets[0].scale.unit #=> String, one of "PERCENT"
resp.services[0].task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.services[0].task_sets[0].stability_status_at #=> Time
resp.services[0].task_sets[0].tags #=> Array
resp.services[0].task_sets[0].tags[0].key #=> String
resp.services[0].task_sets[0].tags[0].value #=> String
resp.services[0].task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.services[0].deployments #=> Array
resp.services[0].deployments[0].id #=> String
resp.services[0].deployments[0].status #=> String
resp.services[0].deployments[0].task_definition #=> String
resp.services[0].deployments[0].desired_count #=> Integer
resp.services[0].deployments[0].pending_count #=> Integer
resp.services[0].deployments[0].running_count #=> Integer
resp.services[0].deployments[0].failed_tasks #=> Integer
resp.services[0].deployments[0].created_at #=> Time
resp.services[0].deployments[0].updated_at #=> Time
resp.services[0].deployments[0].capacity_provider_strategy #=> Array
resp.services[0].deployments[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.services[0].deployments[0].capacity_provider_strategy[0].weight #=> Integer
resp.services[0].deployments[0].capacity_provider_strategy[0].base #=> Integer
resp.services[0].deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.services[0].deployments[0].platform_version #=> String
resp.services[0].deployments[0].platform_family #=> String
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.services[0].deployments[0].rollout_state #=> String, one of "COMPLETED", "FAILED", "IN_PROGRESS"
resp.services[0].deployments[0].rollout_state_reason #=> String
resp.services[0].deployments[0].service_connect_configuration.enabled #=> Boolean
resp.services[0].deployments[0].service_connect_configuration.namespace #=> String
resp.services[0].deployments[0].service_connect_configuration.services #=> Array
resp.services[0].deployments[0].service_connect_configuration.services[0].port_name #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].discovery_name #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].client_aliases #=> Array
resp.services[0].deployments[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
resp.services[0].deployments[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
resp.services[0].deployments[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
resp.services[0].deployments[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
resp.services[0].deployments[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].tls.kms_key #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].tls.role_arn #=> String
resp.services[0].deployments[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.services[0].deployments[0].service_connect_configuration.log_configuration.options #=> Hash
resp.services[0].deployments[0].service_connect_configuration.log_configuration.options["String"] #=> String
resp.services[0].deployments[0].service_connect_configuration.log_configuration.secret_options #=> Array
resp.services[0].deployments[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
resp.services[0].deployments[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
resp.services[0].deployments[0].service_connect_resources #=> Array
resp.services[0].deployments[0].service_connect_resources[0].discovery_name #=> String
resp.services[0].deployments[0].service_connect_resources[0].discovery_arn #=> String
resp.services[0].deployments[0].volume_configurations #=> Array
resp.services[0].deployments[0].volume_configurations[0].name #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs"
resp.services[0].deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.services[0].role_arn #=> String
resp.services[0].events #=> Array
resp.services[0].events[0].id #=> String
resp.services[0].events[0].created_at #=> Time
resp.services[0].events[0].message #=> String
resp.services[0].created_at #=> Time
resp.services[0].placement_constraints #=> Array
resp.services[0].placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.services[0].placement_constraints[0].expression #=> String
resp.services[0].placement_strategy #=> Array
resp.services[0].placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.services[0].placement_strategy[0].field #=> String
resp.services[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.services[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.services[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.services[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.services[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.services[0].health_check_grace_period_seconds #=> Integer
resp.services[0].scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
resp.services[0].deployment_controller.type #=> String, one of "ECS", "CODE_DEPLOY", "EXTERNAL"
resp.services[0].tags #=> Array
resp.services[0].tags[0].key #=> String
resp.services[0].tags[0].value #=> String
resp.services[0].created_by #=> String
resp.services[0].enable_ecs_managed_tags #=> Boolean
resp.services[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.services[0].enable_execute_command #=> Boolean
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :cluster (String)

    The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

  • :services (required, Array<String>)

    A list of services to describe. You may specify up to 10 services to describe in a single operation.

  • :include (Array<String>)

    Determines whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

Returns:

See Also:



3873
3874
3875
3876
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3873

def describe_services(params = {}, options = {})
  req = build_request(:describe_services, params)
  req.send_request(options)
end

#describe_task_definition(params = {}) ⇒ Types::DescribeTaskDefinitionResponse

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

You can only describe INACTIVE task definitions while an active task or service references them.

Examples:

Example: To describe a task definition


# This example provides a description of the specified task definition.

resp = client.describe_task_definition({
  task_definition: "hello_world:8", 
})

resp.to_h outputs the following:
{
  task_definition: {
    container_definitions: [
      {
        name: "wordpress", 
        cpu: 10, 
        environment: [
        ], 
        essential: true, 
        image: "wordpress", 
        links: [
          "mysql", 
        ], 
        memory: 500, 
        mount_points: [
        ], 
        port_mappings: [
          {
            container_port: 80, 
            host_port: 80, 
          }, 
        ], 
        volumes_from: [
        ], 
      }, 
      {
        name: "mysql", 
        cpu: 10, 
        environment: [
          {
            name: "MYSQL_ROOT_PASSWORD", 
            value: "password", 
          }, 
        ], 
        essential: true, 
        image: "mysql", 
        memory: 500, 
        mount_points: [
        ], 
        port_mappings: [
        ], 
        volumes_from: [
        ], 
      }, 
    ], 
    family: "hello_world", 
    revision: 8, 
    task_definition_arn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/hello_world:8", 
    volumes: [
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.describe_task_definition({
  task_definition: "String", # required
  include: ["TAGS"], # accepts TAGS
})

Response structure


resp.task_definition.task_definition_arn #=> String
resp.task_definition.container_definitions #=> Array
resp.task_definition.container_definitions[0].name #=> String
resp.task_definition.container_definitions[0].image #=> String
resp.task_definition.container_definitions[0].repository_credentials.credentials_parameter #=> String
resp.task_definition.container_definitions[0].cpu #=> Integer
resp.task_definition.container_definitions[0].memory #=> Integer
resp.task_definition.container_definitions[0].memory_reservation #=> Integer
resp.task_definition.container_definitions[0].links #=> Array
resp.task_definition.container_definitions[0].links[0] #=> String
resp.task_definition.container_definitions[0].port_mappings #=> Array
resp.task_definition.container_definitions[0].port_mappings[0].container_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].host_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].protocol #=> String, one of "tcp", "udp"
resp.task_definition.container_definitions[0].port_mappings[0].name #=> String
resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
resp.task_definition.container_definitions[0].essential #=> Boolean
resp.task_definition.container_definitions[0].entry_point #=> Array
resp.task_definition.container_definitions[0].entry_point[0] #=> String
resp.task_definition.container_definitions[0].command #=> Array
resp.task_definition.container_definitions[0].command[0] #=> String
resp.task_definition.container_definitions[0].environment #=> Array
resp.task_definition.container_definitions[0].environment[0].name #=> String
resp.task_definition.container_definitions[0].environment[0].value #=> String
resp.task_definition.container_definitions[0].environment_files #=> Array
resp.task_definition.container_definitions[0].environment_files[0].value #=> String
resp.task_definition.container_definitions[0].environment_files[0].type #=> String, one of "s3"
resp.task_definition.container_definitions[0].mount_points #=> Array
resp.task_definition.container_definitions[0].mount_points[0].source_volume #=> String
resp.task_definition.container_definitions[0].mount_points[0].container_path #=> String
resp.task_definition.container_definitions[0].mount_points[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].volumes_from #=> Array
resp.task_definition.container_definitions[0].volumes_from[0].source_container #=> String
resp.task_definition.container_definitions[0].volumes_from[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].host_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].container_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions[0] #=> String, one of "read", "write", "mknod"
resp.task_definition.container_definitions[0].linux_parameters.init_process_enabled #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.shared_memory_size #=> Integer
resp.task_definition.container_definitions[0].linux_parameters.tmpfs #=> Array
resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].container_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].size #=> Integer
resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options #=> Array
resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.max_swap #=> Integer
resp.task_definition.container_definitions[0].linux_parameters.swappiness #=> Integer
resp.task_definition.container_definitions[0].secrets #=> Array
resp.task_definition.container_definitions[0].secrets[0].name #=> String
resp.task_definition.container_definitions[0].secrets[0].value_from #=> String
resp.task_definition.container_definitions[0].depends_on #=> Array
resp.task_definition.container_definitions[0].depends_on[0].container_name #=> String
resp.task_definition.container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
resp.task_definition.container_definitions[0].start_timeout #=> Integer
resp.task_definition.container_definitions[0].stop_timeout #=> Integer
resp.task_definition.container_definitions[0].hostname #=> String
resp.task_definition.container_definitions[0].user #=> String
resp.task_definition.container_definitions[0].working_directory #=> String
resp.task_definition.container_definitions[0].disable_networking #=> Boolean
resp.task_definition.container_definitions[0].privileged #=> Boolean
resp.task_definition.container_definitions[0].readonly_root_filesystem #=> Boolean
resp.task_definition.container_definitions[0].dns_servers #=> Array
resp.task_definition.container_definitions[0].dns_servers[0] #=> String
resp.task_definition.container_definitions[0].dns_search_domains #=> Array
resp.task_definition.container_definitions[0].dns_search_domains[0] #=> String
resp.task_definition.container_definitions[0].extra_hosts #=> Array
resp.task_definition.container_definitions[0].extra_hosts[0].hostname #=> String
resp.task_definition.container_definitions[0].extra_hosts[0].ip_address #=> String
resp.task_definition.container_definitions[0].docker_security_options #=> Array
resp.task_definition.container_definitions[0].docker_security_options[0] #=> String
resp.task_definition.container_definitions[0].interactive #=> Boolean
resp.task_definition.container_definitions[0].pseudo_terminal #=> Boolean
resp.task_definition.container_definitions[0].docker_labels #=> Hash
resp.task_definition.container_definitions[0].docker_labels["String"] #=> String
resp.task_definition.container_definitions[0].ulimits #=> Array
resp.task_definition.container_definitions[0].ulimits[0].name #=> String, one of "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack"
resp.task_definition.container_definitions[0].ulimits[0].soft_limit #=> Integer
resp.task_definition.container_definitions[0].ulimits[0].hard_limit #=> Integer
resp.task_definition.container_definitions[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.task_definition.container_definitions[0].log_configuration.options #=> Hash
resp.task_definition.container_definitions[0].log_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options #=> Array
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].name #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].value_from #=> String
resp.task_definition.container_definitions[0].health_check.command #=> Array
resp.task_definition.container_definitions[0].health_check.command[0