Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Documentation

data 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.

See: newClusterServiceConnectDefaultsRequest smart constructor.

Constructors

ClusterServiceConnectDefaultsRequest'

Fields

• namespace :: Text

  The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

  If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

  If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

  If you update the service with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

  For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

Instances

ToJSON ClusterServiceConnectDefaultsRequest

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Methods

toJSON :: ClusterServiceConnectDefaultsRequest -> Value

toEncoding :: ClusterServiceConnectDefaultsRequest -> Encoding

toJSONList :: [ClusterServiceConnectDefaultsRequest] -> Value

toEncodingList :: [ClusterServiceConnectDefaultsRequest] -> Encoding

Generic ClusterServiceConnectDefaultsRequest

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Associated Types

type Rep ClusterServiceConnectDefaultsRequest :: Type -> Type

Methods

from :: ClusterServiceConnectDefaultsRequest -> Rep ClusterServiceConnectDefaultsRequest x

to :: Rep ClusterServiceConnectDefaultsRequest x -> ClusterServiceConnectDefaultsRequest

Read ClusterServiceConnectDefaultsRequest

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Methods

readsPrec :: Int -> ReadS ClusterServiceConnectDefaultsRequest

readList :: ReadS [ClusterServiceConnectDefaultsRequest]

readPrec :: ReadPrec ClusterServiceConnectDefaultsRequest

readListPrec :: ReadPrec [ClusterServiceConnectDefaultsRequest]

Show ClusterServiceConnectDefaultsRequest

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Methods

showsPrec :: Int -> ClusterServiceConnectDefaultsRequest -> ShowS

show :: ClusterServiceConnectDefaultsRequest -> String

showList :: [ClusterServiceConnectDefaultsRequest] -> ShowS

NFData ClusterServiceConnectDefaultsRequest

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Methods

rnf :: ClusterServiceConnectDefaultsRequest -> ()

Eq ClusterServiceConnectDefaultsRequest

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Methods

(==) :: ClusterServiceConnectDefaultsRequest -> ClusterServiceConnectDefaultsRequest -> Bool

(/=) :: ClusterServiceConnectDefaultsRequest -> ClusterServiceConnectDefaultsRequest -> Bool

Hashable ClusterServiceConnectDefaultsRequest

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

Methods

hashWithSalt :: Int -> ClusterServiceConnectDefaultsRequest -> Int

hash :: ClusterServiceConnectDefaultsRequest -> Int

type Rep ClusterServiceConnectDefaultsRequest

Defined in Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest

type Rep ClusterServiceConnectDefaultsRequest = D1 ('MetaData "ClusterServiceConnectDefaultsRequest" "Amazonka.ECS.Types.ClusterServiceConnectDefaultsRequest" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ClusterServiceConnectDefaultsRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newClusterServiceConnectDefaultsRequest

Arguments

:: Text

$sel:namespace:ClusterServiceConnectDefaultsRequest'

-> ClusterServiceConnectDefaultsRequest

Create a value of ClusterServiceConnectDefaultsRequest 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:

$sel:namespace:ClusterServiceConnectDefaultsRequest', clusterServiceConnectDefaultsRequest_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

If you update the service with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

clusterServiceConnectDefaultsRequest_namespace :: Lens' ClusterServiceConnectDefaultsRequest Text

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

If you update the service with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.