create-container-association¶

Description¶

Creates a Network Firewall container association. The association monitors container lifecycle events in your Amazon ECS or Amazon EKS clusters and resolves running container addresses for use in firewall rules.

Synopsis¶

  create-container-association
--container-association-name <value>
[--description <value>]
--type <value>
--container-monitoring-configurations <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--container-association-name (string) [required]

The descriptive name of the container association. You can’t change the name of a container association after you create it.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

--description (string)

A description of the container association.

Constraints:

max: 512

pattern: ^.*$

--type (string) [required]

The type of containers to monitor. You can’t change the container type after creation. Valid values:

ECS - Amazon Elastic Container Service

EKS - Amazon Elastic Kubernetes Service

Possible values:

ECS

EKS

--container-monitoring-configurations (list) [required]

The monitoring configurations for the container association. Each configuration specifies an Amazon ECS or Amazon EKS cluster to monitor and optional attribute filters to narrow which containers are tracked.

(structure)

Contains the monitoring configuration for a single cluster in a container association. Specifies the cluster ARN and optional attribute filters to narrow which containers are tracked.

ClusterArn -> (string) [required]

The ARN of the Amazon ECS or Amazon EKS cluster to monitor. The cluster must be in the same Region and account as the container association.

Constraints:

min: 1

max: 256

pattern: ^arn:aws.*

AttributeFilters -> (list)

Key-value pairs that filter which containers are tracked. For Amazon EKS, you can filter by namespace and Kubernetes labels. For Amazon ECS, you can filter by container instance attributes (EC2 launch type only).

(structure)

A key-value filter pair used in container association monitoring configurations to narrow which containers are tracked.

Key -> (string) [required]

The attribute key to filter on.

Constraints:

min: 1

max: 256

pattern: \S+

Value -> (string) [required]

The attribute value to match.

Constraints:

min: 1

max: 256

pattern: \S+

Shorthand Syntax:

ClusterArn=string,AttributeFilters=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ClusterArn": "string",
    "AttributeFilters": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--tags (list)

The key:value pairs to associate with the resource.

Constraints:

min: 1

max: 200

(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) [required]

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.

Constraints:

min: 1

max: 128

pattern: ^.*$

Value -> (string) [required]

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.

Constraints:

min: 0

max: 256

pattern: ^.*$

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

ContainerAssociationName -> (string)

The descriptive name of the container association.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

ContainerAssociationArn -> (string)

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

Constraints:

min: 1

max: 256

pattern: ^arn:aws.*

Description -> (string)

A description of the container association.

Constraints:

max: 512

pattern: ^.*$

Type -> (string)

The container type. Valid values:

ECS - Amazon Elastic Container Service

EKS - Amazon Elastic Kubernetes Service

Possible values:

ECS

EKS

ContainerMonitoringConfigurations -> (list)

The monitoring configurations for the container association.

(structure)

Contains the monitoring configuration for a single cluster in a container association. Specifies the cluster ARN and optional attribute filters to narrow which containers are tracked.

ClusterArn -> (string) [required]

The ARN of the Amazon ECS or Amazon EKS cluster to monitor. The cluster must be in the same Region and account as the container association.

Constraints:

min: 1

max: 256

pattern: ^arn:aws.*

AttributeFilters -> (list)

Key-value pairs that filter which containers are tracked. For Amazon EKS, you can filter by namespace and Kubernetes labels. For Amazon ECS, you can filter by container instance attributes (EC2 launch type only).

(structure)

A key-value filter pair used in container association monitoring configurations to narrow which containers are tracked.

Key -> (string) [required]

The attribute key to filter on.

Constraints:

min: 1

max: 256

pattern: \S+

Value -> (string) [required]

The attribute value to match.

Constraints:

min: 1

max: 256

pattern: \S+

Status -> (string)

The current status of the container association. For a new container association, the status is CREATING .

Possible values:

ACTIVE

CREATING

DELETING

UPDATING

Tags -> (list)

The key:value pairs to associate with the resource.

Constraints:

min: 1

max: 200

(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) [required]

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.

Constraints:

min: 1

max: 128

pattern: ^.*$

Value -> (string) [required]

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.

Constraints:

min: 0

max: 256

pattern: ^.*$

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.

To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException . If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Constraints:

min: 1

max: 1024

pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

Table of Contents

Feedback

User Guide