ServiceConnectServiceProperty Struct
The Service Connect service object configuration.
For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const serviceConnectServiceProperty: ecs.CfnService.ServiceConnectServiceProperty = {
portName: 'portName',
// the properties below are optional
clientAliases: [{
port: 123,
// the properties below are optional
dnsName: 'dnsName',
testTrafficRules: {
header: {
name: 'name',
// the properties below are optional
value: {
exact: 'exact',
},
},
},
}],
discoveryName: 'discoveryName',
ingressPortOverride: 123,
timeout: {
idleTimeoutSeconds: 123,
perRequestTimeoutSeconds: 123,
},
tls: {
issuerCertificateAuthority: {
awsPcaAuthorityArn: 'awsPcaAuthorityArn',
},
// the properties below are optional
kmsKey: 'kmsKey',
roleArn: 'roleArn',
},
};
Properties
clientAliasesoptionalIResolvable | IResolvable | CfnService.ServiceConnectClientAliasProperty[]client_aliasesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ServiceConnectClientAliasProperty]]]clientAliasesoptionalIResolvableClientAliasesoptionalIResolvableClientAliasesoptionalinterface{}#notes
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 .
discoveryNameoptionalstringdiscovery_nameoptionalstrdiscoveryNameoptionalStringDiscoveryNameoptionalstringDiscoveryNameoptional*string#notes
This must be unique within the AWS 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 the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace .
ingressPortOverrideoptionalnumberingress_port_overrideoptionalint | floatingressPortOverrideoptionalNumberIngressPortOverrideoptionaldoubleIngressPortOverrideoptional*float64#notes
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.
timeoutoptionalIResolvable | CfnService.TimeoutConfigurationPropertytimeoutoptionaltyping.Union[IResolvable, TimeoutConfigurationProperty]timeoutoptionalIResolvableTimeoutoptionalIResolvableTimeoutoptionalinterface{}#tlsoptionalIResolvable | CfnService.ServiceConnectTlsConfigurationPropertytlsoptionaltyping.Union[IResolvable, ServiceConnectTlsConfigurationProperty]tlsoptionalIResolvableTlsoptionalIResolvableTlsoptionalinterface{}#