associate_gateway_with_cluster¶
Operation¶
associate_gateway_with_cluster
async
¶
associate_gateway_with_cluster(request: AssociateGatewayWithClusterInput | AssociateGatewayWithClusterInputDict, /, *, plugins: list[Plugin] | None = None) -> AssociateGatewayWithClusterOutput
associate_gateway_with_cluster(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociateGatewayWithClusterInputDict]) -> AssociateGatewayWithClusterOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
AssociateGatewayWithClusterOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
AssociateGatewayWithClusterInput
dataclass
¶
Dictionaries¶
AssociateGatewayWithClusterInputDict
¶
Bases: TypedDict
Dictionary form of AssociateGatewayWithClusterInput.
Output¶
AssociateGatewayWithClusterOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for AssociateGatewayWithClusterOutput structure.
Attributes¶
cluster_arn
class-attribute
instance-attribute
¶
cluster_arn: str | None = ...
The Amazon Resource Name (ARN) of the cluster.
gateway_arn
class-attribute
instance-attribute
¶
gateway_arn: str | None = ...
The Amazon Resource Name (ARN) of the gateway.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.