ECS / Client / associate_gateway_with_cluster

associate_gateway_with_cluster

ECS.Client.associate_gateway_with_cluster(**kwargs)

Associates a gateway with an Amazon ECS cluster. After a cluster is associated with a gateway, services in that cluster can use the gateway for ingress. No changes take effect until you update a service in the cluster to use the gateway. A single cluster can be associated with up to 5 gateways.

See also: AWS API Documentation

Request Syntax

response = client.associate_gateway_with_cluster(
    gateway='string',
    cluster='string'
)
Parameters:

  • gateway (string) –

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the gateway to associate.

  • cluster (string) –

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the cluster to associate the gateway with.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayArn': 'string',
    'clusterArn': 'string',
    'status': 'ACTIVE'|'DISASSOCIATING'|'INACTIVE'
}

Response Structure

  • (dict) –

    • gatewayArn (string) –

      The Amazon Resource Name (ARN) of the gateway.

    • clusterArn (string) –

      The Amazon Resource Name (ARN) of the cluster.

    • status (string) –

      The status of the association. A new association is ACTIVE.

Exceptions