amazonka-ecs-2.0: Amazon EC2 Container Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECS.UpdateCluster

Description

Updates the cluster.

Synopsis

Creating a Request

data UpdateCluster Source #

See: newUpdateCluster smart constructor.

Constructors

UpdateCluster' 

Fields

  • configuration :: Maybe ClusterConfiguration

    The execute command configuration for the cluster.

  • serviceConnectDefaults :: Maybe 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 :: Maybe [ClusterSetting]

    The cluster settings for your cluster.

  • cluster :: Text

    The name of the cluster to modify the settings for.

Instances

Instances details
ToJSON UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

ToHeaders UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

ToPath UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

ToQuery UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

AWSRequest UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

Associated Types

type AWSResponse UpdateCluster #

Generic UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

Associated Types

type Rep UpdateCluster :: Type -> Type #

Read UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

Show UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

NFData UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

Methods

rnf :: UpdateCluster -> () #

Eq UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

Hashable UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

type AWSResponse UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

type Rep UpdateCluster Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

type Rep UpdateCluster = D1 ('MetaData "UpdateCluster" "Amazonka.ECS.UpdateCluster" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "UpdateCluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterConfiguration)) :*: S1 ('MetaSel ('Just "serviceConnectDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterServiceConnectDefaultsRequest))) :*: (S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterSetting])) :*: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateCluster Source #

Create a value of UpdateCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateCluster, updateCluster_configuration - The execute command configuration for the cluster.

UpdateCluster, updateCluster_serviceConnectDefaults - 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.

UpdateCluster, updateCluster_settings - The cluster settings for your cluster.

UpdateCluster, updateCluster_cluster - The name of the cluster to modify the settings for.

Request Lenses

updateCluster_configuration :: Lens' UpdateCluster (Maybe ClusterConfiguration) Source #

The execute command configuration for the cluster.

updateCluster_serviceConnectDefaults :: Lens' UpdateCluster (Maybe ClusterServiceConnectDefaultsRequest) Source #

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.

updateCluster_settings :: Lens' UpdateCluster (Maybe [ClusterSetting]) Source #

The cluster settings for your cluster.

updateCluster_cluster :: Lens' UpdateCluster Text Source #

The name of the cluster to modify the settings for.

Destructuring the Response

data UpdateClusterResponse Source #

See: newUpdateClusterResponse smart constructor.

Constructors

UpdateClusterResponse' 

Fields

Instances

Instances details
Generic UpdateClusterResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

Associated Types

type Rep UpdateClusterResponse :: Type -> Type #

Read UpdateClusterResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

Show UpdateClusterResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

NFData UpdateClusterResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

Methods

rnf :: UpdateClusterResponse -> () #

Eq UpdateClusterResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

type Rep UpdateClusterResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateCluster

type Rep UpdateClusterResponse = D1 ('MetaData "UpdateClusterResponse" "Amazonka.ECS.UpdateCluster" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "UpdateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateClusterResponse Source #

Create a value of UpdateClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateCluster, updateClusterResponse_cluster - Details about the cluster.

$sel:httpStatus:UpdateClusterResponse', updateClusterResponse_httpStatus - The response's http status code.

Response Lenses