Package software.amazon.awscdk.services.ecs

Interface CfnService.ServiceConnectServiceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ServiceConnectServiceProperty.Jsii$Proxy

Enclosing class:

CfnService

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

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 software.amazon.awscdk.services.ecs.*;
 ServiceConnectServiceProperty serviceConnectServiceProperty = ServiceConnectServiceProperty.builder()
         .portName("portName")
         // the properties below are optional
         .clientAliases(List.of(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()))
         .discoveryName("discoveryName")
         .ingressPortOverride(123)
         .timeout(TimeoutConfigurationProperty.builder()
                 .idleTimeoutSeconds(123)
                 .perRequestTimeoutSeconds(123)
                 .build())
         .tls(ServiceConnectTlsConfigurationProperty.builder()
                 .issuerCertificateAuthority(ServiceConnectTlsCertificateAuthorityProperty.builder()
                         .awsPcaAuthorityArn("awsPcaAuthorityArn")
                         .build())
                 // the properties below are optional
                 .kmsKey("kmsKey")
                 .roleArn("roleArn")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.ServiceConnectServiceProperty.Builder	builder()
default Object	getClientAliases()	The list of client aliases for this Service Connect service.
default String	getDiscoveryName()	The discoveryName is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service.
default Number	getIngressPortOverride()	The port number for the Service Connect proxy to listen on.
String	getPortName()	The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
default Object	getTimeout()	A reference to an object that represents the configured timeouts for Service Connect.
default Object	getTls()	A reference to an object that represents a Transport Layer Security (TLS) configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPortName

@Stability(Stable)
@NotNull
String getPortName()

The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.

See Also:

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

getClientAliases

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

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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnService.ServiceConnectClientAliasProperty>

See Also:

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

getDiscoveryName

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

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

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 .

See Also:

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

getIngressPortOverride

@Stability(Stable)
@Nullable
default Number getIngressPortOverride()

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.

See Also:

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

getTimeout

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

A reference to an object that represents the configured timeouts for Service Connect.

Returns union: either IResolvable or CfnService.TimeoutConfigurationProperty

See Also:

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

getTls

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

A reference to an object that represents a Transport Layer Security (TLS) configuration.

Returns union: either IResolvable or CfnService.ServiceConnectTlsConfigurationProperty

See Also:

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

builder

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

Returns:

a CfnService.ServiceConnectServiceProperty.Builder of CfnService.ServiceConnectServiceProperty