Class CfnService.ServiceConnectServiceProperty

The Service Connect service object configuration.

Inheritance
System.Object
CfnService.ServiceConnectServiceProperty
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public class ServiceConnectServiceProperty : Object, CfnService.IServiceConnectServiceProperty
Syntax (vb)
Public Class ServiceConnectServiceProperty
    Inherits Object
    Implements CfnService.IServiceConnectServiceProperty
Remarks

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.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 serviceConnectServiceProperty = new ServiceConnectServiceProperty {
    PortName = "portName",

    // the properties below are optional
    ClientAliases = new [] { new ServiceConnectClientAliasProperty {
        Port = 123,

        // the properties below are optional
        DnsName = "dnsName"
    } },
    DiscoveryName = "discoveryName",
    IngressPortOverride = 123
};

Synopsis

Constructors

ServiceConnectServiceProperty()

Properties

ClientAliases

The list of client aliases for this Service Connect service.
DiscoveryName

The discoveryName is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service.
IngressPortOverride

The port number for the Service Connect proxy to listen on.
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.

Constructors

ServiceConnectServiceProperty()

public ServiceConnectServiceProperty()

Properties

ClientAliases

The list of client aliases for this Service Connect service.

public object ClientAliases { get; set; }
Property Value

System.Object

Remarks

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-clientaliases

DiscoveryName

The discoveryName is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service.

public string DiscoveryName { get; set; }
Property Value

System.String

Remarks

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-discoveryname

IngressPortOverride

The port number for the Service Connect proxy to listen on.

public Nullable<double> IngressPortOverride { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-ingressportoverride

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.

public string PortName { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html#cfn-ecs-service-serviceconnectservice-portname

Implements