aws-cdk-lib.aws_ecs.CfnService.ServiceRegistryProperty

ServiceRegistryProperty Struct

The details for the service registry.

Each service may be associated with one service registry. Multiple service registries for each service are not supported.

When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const serviceRegistryProperty: ecs.CfnService.ServiceRegistryProperty = {
  containerName: 'containerName',
  containerPort: 123,
  port: 123,
  registryArn: 'registryArn',
};

Properties

containerNamestringcontainer_namestrcontainerNameStringContainerNamestringContainerName*string#

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

notes

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.

containerPortnumbercontainer_portint | floatcontainerPortNumberContainerPortdoubleContainerPort*float64#

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

notes

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.

portnumberportint | floatportNumberPortdoublePort*float64#

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.

registryArnstringregistry_arnstrregistryArnStringRegistryArnstringRegistryArn*string#

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

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