Interface CfnService.IServiceConnectClientAliasProperty

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

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnService.IServiceConnectClientAliasProperty

Syntax (vb)

Public Interface CfnService.IServiceConnectClientAliasProperty

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ECS;

             var serviceConnectClientAliasProperty = new ServiceConnectClientAliasProperty {
                 Port = 123,

                 // the properties below are optional
                 DnsName = "dnsName",
                 TestTrafficRules = new ServiceConnectTestTrafficRulesProperty {
                     Header = new ServiceConnectTestTrafficRulesHeaderProperty {
                         Name = "name",

                         // the properties below are optional
                         Value = new ServiceConnectTestTrafficRulesHeaderValueProperty {
                             Exact = "exact"
                         }
                     }
                 }
             };

Synopsis

Properties

DnsName	The `dnsName` is the name that you use in the applications of client tasks to connect to this service.
Port	The listening port number for the Service Connect proxy.
TestTrafficRules	The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect.

Properties

DnsName

The dnsName is the name that you use in the applications of client tasks to connect to this service.

string? DnsName { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html#cfn-ecs-service-serviceconnectclientalias-dnsname

Port

The listening port number for the Service Connect proxy.

double Port { get; }

Property Value

double

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html#cfn-ecs-service-serviceconnectclientalias-port

TestTrafficRules

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

object? TestTrafficRules { get; }

Property Value

object

Remarks

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

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