Skip to content

UpdateContainerAssociationRequest

Source code in docs_src/capo_network_firewall/types/update_container_association_request.py
class UpdateContainerAssociationRequest(TypedDict, closed=True):
    container_association_name: NotRequired[
        "capo_network_firewall.types.resource_name.ResourceName"
    ]
    """<p>The descriptive name of the container association.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"""
    container_association_arn: NotRequired[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the container association.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"""
    description: NotRequired["capo_network_firewall.types.description.Description"]
    """<p>A description of the container association. When omitted, the existing description remains unchanged. To clear the description, pass an empty string.</p>"""
    type: (
        "capo_network_firewall.types.container_monitoring_type.ContainerMonitoringType"
    )
    """<p>The container type. This value must match the existing type and can't be changed. Valid values:</p> <ul> <li> <p> <code>ECS</code> - Amazon Elastic Container Service</p> </li> <li> <p> <code>EKS</code> - Amazon Elastic Kubernetes Service</p> </li> </ul>"""
    container_monitoring_configurations: "capo_network_firewall.types.container_monitoring_configurations.ContainerMonitoringConfigurations"
    """<p>The updated monitoring configurations for the container association. Each configuration specifies an Amazon ECS or Amazon EKS cluster to monitor and optional attribute filters.</p>"""
    tags: NotRequired["capo_network_firewall.types.tag_list.TagList"]
    """<p>The key:value pairs to associate with the resource.</p>"""
    update_token: "capo_network_firewall.types.update_token.UpdateToken"
    """<p>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.</p> <p>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 <code>InvalidTokenException</code>. 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.</p>"""

container_association_arn instance-attribute

container_association_arn: NotRequired[ResourceArn]

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

You must specify the ARN or the name, and you can specify both.

container_association_name instance-attribute

container_association_name: NotRequired[ResourceName]

The descriptive name of the container association.

You must specify the ARN or the name, and you can specify both.

container_monitoring_configurations instance-attribute

container_monitoring_configurations: ContainerMonitoringConfigurations

The updated monitoring configurations for the container association. Each configuration specifies an Amazon ECS or Amazon EKS cluster to monitor and optional attribute filters.

description instance-attribute

description: NotRequired[Description]

A description of the container association. When omitted, the existing description remains unchanged. To clear the description, pass an empty string.

tags instance-attribute

tags: NotRequired[TagList]

The key:value pairs to associate with the resource.

type instance-attribute

The container type. This value must match the existing type and can't be changed. Valid values:

  • ECS - Amazon Elastic Container Service

  • EKS - Amazon Elastic Kubernetes Service

update_token instance-attribute

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