Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateContainerAssociation

Creates a AWS 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.

Request Syntax


{
   "ContainerAssociationName": "string",
   "ContainerMonitoringConfigurations": [ 
      { 
         "AttributeFilters": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "ClusterArn": "string"
      }
   ],
   "Description": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ContainerAssociationName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Required: Yes

ContainerMonitoringConfigurations

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.

Type: Array of ContainerMonitoringConfiguration objects

Required: Yes

Description

A description of the container association.

Type: String

Length Constraints: Maximum length of 512.

Pattern: ^.*$

Required: No

Tags

The key:value pairs to associate with the resource.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Type

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

Type: String

Valid Values: ECS | EKS

Required: Yes

Response Syntax


{
   "ContainerAssociationArn": "string",
   "ContainerAssociationName": "string",
   "ContainerMonitoringConfigurations": [ 
      { 
         "AttributeFilters": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "ClusterArn": "string"
      }
   ],
   "Description": "string",
   "Status": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string",
   "UpdateToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ContainerAssociationArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

ContainerAssociationName

The descriptive name of the container association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

ContainerMonitoringConfigurations

The monitoring configurations for the container association.

Type: Array of ContainerMonitoringConfiguration objects

Description

A description of the container association.

Type: String

Length Constraints: Maximum length of 512.

Pattern: ^.*$

Status

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

Type: String

Valid Values: ACTIVE | CREATING | DELETING

Tags

The key:value pairs to associate with the resource.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Type

The container type. Valid values:

ECS - Amazon Elastic Container Service
EKS - Amazon Elastic Kubernetes Service

Type: String

Valid Values: ECS | EKS

UpdateToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

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

Errors

For information about the errors that are common to all actions, see Common Error Types.

InsufficientCapacityException

AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.

HTTP Status Code: 500

InternalServerError

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

InvalidRequestException

The operation failed because of a problem with your request. Examples include:

You specified an unsupported parameter name or value.
You tried to update a property with a value that isn't among the available types.
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

HTTP Status Code: 400

LimitExceededException

Unable to perform the operation because doing so would violate a limit setting.

HTTP Status Code: 400

ThrottlingException

Unable to process the request due to throttling limitations.

HTTP Status Code: 400