Amazonka.ECS.Types.ServiceConnectConfiguration

Documentation

data ServiceConnectConfiguration

The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

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: newServiceConnectConfiguration smart constructor.

Constructors

ServiceConnectConfiguration'

Fields

• logConfiguration :: Maybe LogConfiguration
• namespace :: Maybe Text

  The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

• services :: Maybe [ServiceConnectService]

  The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

  This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

  An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

• enabled :: Bool

  Specifies whether to use Service Connect with this service.

Instances

FromJSON ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Methods

parseJSON :: Value -> Parser ServiceConnectConfiguration

parseJSONList :: Value -> Parser [ServiceConnectConfiguration]

ToJSON ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Methods

toJSON :: ServiceConnectConfiguration -> Value

toEncoding :: ServiceConnectConfiguration -> Encoding

toJSONList :: [ServiceConnectConfiguration] -> Value

toEncodingList :: [ServiceConnectConfiguration] -> Encoding

Generic ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Associated Types

type Rep ServiceConnectConfiguration :: Type -> Type

Methods

from :: ServiceConnectConfiguration -> Rep ServiceConnectConfiguration x

to :: Rep ServiceConnectConfiguration x -> ServiceConnectConfiguration

Read ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Methods

readsPrec :: Int -> ReadS ServiceConnectConfiguration

readList :: ReadS [ServiceConnectConfiguration]

readPrec :: ReadPrec ServiceConnectConfiguration

readListPrec :: ReadPrec [ServiceConnectConfiguration]

Show ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Methods

showsPrec :: Int -> ServiceConnectConfiguration -> ShowS

show :: ServiceConnectConfiguration -> String

showList :: [ServiceConnectConfiguration] -> ShowS

NFData ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Methods

rnf :: ServiceConnectConfiguration -> ()

Eq ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Methods

(==) :: ServiceConnectConfiguration -> ServiceConnectConfiguration -> Bool

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

Hashable ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

Methods

hashWithSalt :: Int -> ServiceConnectConfiguration -> Int

hash :: ServiceConnectConfiguration -> Int

type Rep ServiceConnectConfiguration

Defined in Amazonka.ECS.Types.ServiceConnectConfiguration

type Rep ServiceConnectConfiguration = D1 ('MetaData "ServiceConnectConfiguration" "Amazonka.ECS.Types.ServiceConnectConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ServiceConnectConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "logConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogConfiguration)) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "services") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceConnectService])) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newServiceConnectConfiguration

Arguments

:: Bool

$sel:enabled:ServiceConnectConfiguration'

-> ServiceConnectConfiguration

Create a value of ServiceConnectConfiguration 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:logConfiguration:ServiceConnectConfiguration', serviceConnectConfiguration_logConfiguration - Undocumented member.

$sel:namespace:ServiceConnectConfiguration', serviceConnectConfiguration_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

$sel:services:ServiceConnectConfiguration', serviceConnectConfiguration_services - The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

$sel:enabled:ServiceConnectConfiguration', serviceConnectConfiguration_enabled - Specifies whether to use Service Connect with this service.

serviceConnectConfiguration_logConfiguration :: Lens' ServiceConnectConfiguration (Maybe LogConfiguration)

Undocumented member.

serviceConnectConfiguration_namespace :: Lens' ServiceConnectConfiguration (Maybe Text)

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the /Cloud Map Developer Guide/.

serviceConnectConfiguration_services :: Lens' ServiceConnectConfiguration (Maybe [ServiceConnectService])

The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

serviceConnectConfiguration_enabled :: Lens' ServiceConnectConfiguration Bool

Specifies whether to use Service Connect with this service.