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 |
Synopsis
- data ServiceConnectService = ServiceConnectService' {}
- newServiceConnectService :: Text -> ServiceConnectService
- serviceConnectService_clientAliases :: Lens' ServiceConnectService (Maybe [ServiceConnectClientAlias])
- serviceConnectService_discoveryName :: Lens' ServiceConnectService (Maybe Text)
- serviceConnectService_ingressPortOverride :: Lens' ServiceConnectService (Maybe Natural)
- serviceConnectService_portName :: Lens' ServiceConnectService Text
Documentation
data ServiceConnectService Source #
The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
See: newServiceConnectService
smart constructor.
ServiceConnectService' | |
|
Instances
newServiceConnectService Source #
Create a value of ServiceConnectService
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:clientAliases:ServiceConnectService'
, serviceConnectService_clientAliases
- The list of client aliases for this Service Connect service. You use
these to assign names that can be used by client applications. The
maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each ServiceConnectService
, you must provide at least one
clientAlias
with one port
.
$sel:discoveryName:ServiceConnectService'
, serviceConnectService_discoveryName
- The discoveryName
is the name of the new Cloud Map service that Amazon
ECS creates for this Amazon ECS service. This must be unique within the
Cloud Map namespace. The name can contain up to 64 characters. The name
can include lowercase letters, numbers, underscores (_), and hyphens
(-). 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
.
$sel:ingressPortOverride:ServiceConnectService'
, serviceConnectService_ingressPortOverride
- The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port
number specified in the named portMapping
in the task definition of
this application, and then use it in your VPC security groups to allow
traffic into the proxy for this Amazon ECS service.
In awsvpc
mode and Fargate, the default value is the container port
number. The container port number is in the portMapping
in the task
definition. In bridge mode, the default value is the ephemeral port of
the Service Connect proxy.
$sel:portName:ServiceConnectService'
, serviceConnectService_portName
- The portName
must match the name of one of the portMappings
from all
the containers in the task definition of this Amazon ECS service.
serviceConnectService_clientAliases :: Lens' ServiceConnectService (Maybe [ServiceConnectClientAlias]) Source #
The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each ServiceConnectService
, you must provide at least one
clientAlias
with one port
.
serviceConnectService_discoveryName :: Lens' ServiceConnectService (Maybe Text) Source #
The discoveryName
is the name of the new Cloud Map service that Amazon
ECS creates for this Amazon ECS service. This must be unique within the
Cloud Map namespace. The name can contain up to 64 characters. The name
can include lowercase letters, numbers, underscores (_), and hyphens
(-). 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
.
serviceConnectService_ingressPortOverride :: Lens' ServiceConnectService (Maybe Natural) Source #
The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port
number specified in the named portMapping
in the task definition of
this application, and then use it in your VPC security groups to allow
traffic into the proxy for this Amazon ECS service.
In awsvpc
mode and Fargate, the default value is the container port
number. The container port number is in the portMapping
in the task
definition. In bridge mode, the default value is the ephemeral port of
the Service Connect proxy.
serviceConnectService_portName :: Lens' ServiceConnectService Text Source #
The portName
must match the name of one of the portMappings
from all
the containers in the task definition of this Amazon ECS service.