Package software.amazon.awscdk.services.ecs

Interface CfnService.ServiceRegistryProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ServiceRegistryProperty.Jsii$Proxy

Enclosing class:

CfnService

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

The ServiceRegistry property specifies details of the service registry.

For more information, see Service Discovery 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.*;
 ServiceRegistryProperty serviceRegistryProperty = ServiceRegistryProperty.builder()
         .containerName("containerName")
         .containerPort(123)
         .port(123)
         .registryArn("registryArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.ServiceRegistryProperty.Builder	builder()
default String	getContainerName()	The container name value to be used for your service discovery service.
default Number	getContainerPort()	The port value to be used for your service discovery service.
default Number	getPort()	The port value used if your service discovery service specified an SRV record.
default String	getRegistryArn()	The Amazon Resource Name (ARN) of the service registry.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerName

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

The container name value to be used for your service discovery service.

It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

getContainerPort

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

The port value to be used for your service discovery service.

It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.

getPort

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

The port value used if your service discovery service specified an SRV record.

This field might be used if both the awsvpc network mode and SRV records are used.

getRegistryArn

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

The Amazon Resource Name (ARN) of the service registry.

The currently supported service registry is AWS Cloud Map . For more information, see CreateService .

builder

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

Returns:

a CfnService.ServiceRegistryProperty.Builder of CfnService.ServiceRegistryProperty