Package software.amazon.awscdk.services.ecs

Interface CfnService.ServiceConnectClientAliasProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ServiceConnectClientAliasProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.ServiceConnectClientAliasProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 ServiceConnectClientAliasProperty serviceConnectClientAliasProperty = ServiceConnectClientAliasProperty.builder()
         .port(123)
         // the properties below are optional
         .dnsName("dnsName")
         .testTrafficRules(ServiceConnectTestTrafficRulesProperty.builder()
                 .header(ServiceConnectTestTrafficRulesHeaderProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .value(ServiceConnectTestTrafficRulesHeaderValueProperty.builder()
                                 .exact("exact")
                                 .build())
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnService.ServiceConnectClientAliasProperty.Builder	A builder for CfnService.ServiceConnectClientAliasProperty
static final class	CfnService.ServiceConnectClientAliasProperty.Jsii$Proxy	An implementation for CfnService.ServiceConnectClientAliasProperty

Method Summary

Modifier and Type	Method	Description
static CfnService.ServiceConnectClientAliasProperty.Builder	builder()
default String	getDnsName()	The dnsName is the name that you use in the applications of client tasks to connect to this service.
Number	getPort()	The listening port number for the Service Connect proxy.
default Object	getTestTrafficRules()	The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPort

@Stability(Stable)
@NotNull
Number getPort()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html#cfn-ecs-service-serviceconnectclientalias-port

getDnsName

@Stability(Stable)
@Nullable
default String getDnsName()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html#cfn-ecs-service-serviceconnectclientalias-dnsname

getTestTrafficRules

@Stability(Stable)
@Nullable
default Object getTestTrafficRules()

The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect.

This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic.

Returns union: either IResolvable or CfnService.ServiceConnectTestTrafficRulesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html#cfn-ecs-service-serviceconnectclientalias-testtrafficrules

builder

@Stability(Stable)
static CfnService.ServiceConnectClientAliasProperty.Builder builder()

Returns:

a CfnService.ServiceConnectClientAliasProperty.Builder of CfnService.ServiceConnectClientAliasProperty