AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . network-firewall ]

describe-container-association

Description

Returns the properties of a container association.

See also: AWS API Documentation

Synopsis

  describe-container-association
[--container-association-name <value>]
[--container-association-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--container-association-name (string)

The descriptive name of the container association. You must specify the ARN or the name, and you can specify both.

--container-association-arn (string)

The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

ContainerAssociationName -> (string)

The descriptive name of the container association.

ContainerAssociationArn -> (string)

The Amazon Resource Name (ARN) of the container association.

Description -> (string)

A description of the container association.

Type -> (string)

The type of container orchestration platform. Either ECS or EKS .

ContainerMonitoringConfigurations -> (list)

The container monitoring configurations for this container association.

(structure)

Defines a container cluster to monitor, along with optional attribute filters that narrow the scope of monitored containers within the cluster.

ClusterArn -> (string)

The Amazon Resource Name (ARN) of the container cluster to monitor.

AttributeFilters -> (list)

A list of key-value pairs that filter which containers within the cluster are monitored. Only containers that match the specified attributes are included.

(structure)

A key-value pair that defines a container attribute filter for a container monitoring configuration.

Key -> (string)

The key of the container attribute to filter on.

Value -> (string)

The value of the container attribute to filter on.

Status -> (string)

The current status of the container association.

ResolvedCidrCount -> (integer)

The number of CIDR blocks that have been resolved from the monitored containers for this container association.

LastUpdatedTime -> (timestamp)

The last time that the container association was updated or resolved new container IP addresses.

Tags -> (list)

The key:value pairs associated with the resource.

(structure)

A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource.

Key -> (string)

The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.

Value -> (string)

The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.

UpdateToken -> (string)

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.