Package software.amazon.awscdk.services.ecs

Interface CfnTaskSet.ServiceRegistryProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnTaskSet.ServiceRegistryProperty.Jsii$Proxy
Enclosing class:
CfnTaskSet
@Stability(Stable) public static interface CfnTaskSet.ServiceRegistryProperty extends software.amazon.jsii.JsiiSerializable
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.

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();

  • 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 CfnTaskSet.ServiceRegistryProperty.Builder builder()
      Returns:
      a CfnTaskSet.ServiceRegistryProperty.Builder of CfnTaskSet.ServiceRegistryProperty