Skip to content

UpdateClusterRequest

Source code in docs_src/capo_ecs/types/update_cluster_request.py
class UpdateClusterRequest(TypedDict, closed=True):
    cluster: "capo_ecs.types.string.String"
    """<p>The name of the cluster to modify the settings for.</p>"""
    settings: NotRequired["capo_ecs.types.cluster_settings.ClusterSettings"]
    """<p>The cluster settings for your cluster.</p>"""
    configuration: NotRequired[
        "capo_ecs.types.cluster_configuration.ClusterConfiguration"
    ]
    """<p>The execute command configuration for the cluster.</p>"""
    service_connect_defaults: NotRequired[
        "capo_ecs.types.cluster_service_connect_defaults_request.ClusterServiceConnectDefaultsRequest"
    ]
    """<p>Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the <code>enabled</code> parameter to <code>true</code> in the <code>ServiceConnectConfiguration</code>. You can set the namespace of each service individually in the <code>ServiceConnectConfiguration</code> to override this default parameter.</p> <p>Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"""

cluster instance-attribute

cluster: String

The name of the cluster to modify the settings for.

configuration instance-attribute

configuration: NotRequired[ClusterConfiguration]

The execute command configuration for the cluster.

service_connect_defaults instance-attribute

service_connect_defaults: NotRequired[ClusterServiceConnectDefaultsRequest]

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

settings instance-attribute

settings: NotRequired[ClusterSettings]

The cluster settings for your cluster.