1.204.0

interface ServiceRegistryProperty

LanguageType name
.NETAmazon.CDK.AWS.ECS.CfnService.ServiceRegistryProperty
Javasoftware.amazon.awscdk.services.ecs.CfnService.ServiceRegistryProperty
Pythonaws_cdk.aws_ecs.CfnService.ServiceRegistryProperty
TypeScript @aws-cdk/aws-ecs » CfnService » ServiceRegistryProperty

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 * as ecs from '@aws-cdk/aws-ecs';
const serviceRegistryProperty: ecs.CfnService.ServiceRegistryProperty = {
  containerName: 'containerName',
  containerPort: 123,
  port: 123,
  registryArn: 'registryArn',
};

Properties

NameTypeDescription
containerName?stringThe container name value to be used for your service discovery service.
containerPort?numberThe port value to be used for your service discovery service.
port?numberThe port value used if your service discovery service specified an SRV record.
registryArn?stringThe Amazon Resource Name (ARN) of the service registry.

containerName?

Type: string (optional)

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.

containerPort?

Type: number (optional)

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.

port?

Type: number (optional)

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.

registryArn?

Type: string (optional)

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

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

← PreviousNext →