Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ECS.Types.ServiceConnectClientAlias

Description

Synopsis

data ServiceConnectClientAlias = ServiceConnectClientAlias' {
- dnsName :: Maybe Text
- port :: Natural
}
newServiceConnectClientAlias :: Natural -> ServiceConnectClientAlias
serviceConnectClientAlias_dnsName :: Lens' ServiceConnectClientAlias (Maybe Text)
serviceConnectClientAlias_port :: Lens' ServiceConnectClientAlias Natural

Documentation

data ServiceConnectClientAlias Source #

Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.

Each name and port mapping must be unique within the 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: newServiceConnectClientAlias smart constructor.

Constructors

ServiceConnectClientAlias'

Fields

dnsName :: Maybe Text
The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.
If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
port :: Natural
The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Instances

Instances details

FromJSON ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias Methods parseJSON :: Value -> Parser ServiceConnectClientAlias # parseJSONList :: Value -> Parser [ServiceConnectClientAlias] #
ToJSON ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias Methods toJSON :: ServiceConnectClientAlias -> Value # toEncoding :: ServiceConnectClientAlias -> Encoding # toJSONList :: [ServiceConnectClientAlias] -> Value # toEncodingList :: [ServiceConnectClientAlias] -> Encoding #
Generic ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias Associated Types type Rep ServiceConnectClientAlias :: Type -> Type # Methods from :: ServiceConnectClientAlias -> Rep ServiceConnectClientAlias x # to :: Rep ServiceConnectClientAlias x -> ServiceConnectClientAlias #
Read ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias Methods readsPrec :: Int -> ReadS ServiceConnectClientAlias # readList :: ReadS [ServiceConnectClientAlias] # readPrec :: ReadPrec ServiceConnectClientAlias # readListPrec :: ReadPrec [ServiceConnectClientAlias] #
Show ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias Methods showsPrec :: Int -> ServiceConnectClientAlias -> ShowS # show :: ServiceConnectClientAlias -> String # showList :: [ServiceConnectClientAlias] -> ShowS #
NFData ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias Methods rnf :: ServiceConnectClientAlias -> () #
Eq ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias Methods (==) :: ServiceConnectClientAlias -> ServiceConnectClientAlias -> Bool # (/=) :: ServiceConnectClientAlias -> ServiceConnectClientAlias -> Bool #
Hashable ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias Methods hashWithSalt :: Int -> ServiceConnectClientAlias -> Int # hash :: ServiceConnectClientAlias -> Int #
type Rep ServiceConnectClientAlias Source #
Instance details Defined in Amazonka.ECS.Types.ServiceConnectClientAlias type Rep ServiceConnectClientAlias = D1 ('MetaData "ServiceConnectClientAlias" "Amazonka.ECS.Types.ServiceConnectClientAlias" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ServiceConnectClientAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dnsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newServiceConnectClientAlias Source #

Arguments

:: Natural	`$sel:port:ServiceConnectClientAlias'`
-> ServiceConnectClientAlias

Create a value of ServiceConnectClientAlias 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:dnsName:ServiceConnectClientAlias', serviceConnectClientAlias_dnsName - The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

$sel:port:ServiceConnectClientAlias', serviceConnectClientAlias_port - The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

serviceConnectClientAlias_dnsName :: Lens' ServiceConnectClientAlias (Maybe Text) Source #

The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

serviceConnectClientAlias_port :: Lens' ServiceConnectClientAlias Natural Source #

The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.