Class CfnServicePropsMixin.ServiceRegistryProperty

The details for the service registry.

Inheritance

object

CfnServicePropsMixin.ServiceRegistryProperty

Implements

CfnServicePropsMixin.IServiceRegistryProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.ECS.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnServicePropsMixin.ServiceRegistryProperty : CfnServicePropsMixin.IServiceRegistryProperty

Syntax (vb)

Public Class CfnServicePropsMixin.ServiceRegistryProperty Implements CfnServicePropsMixin.IServiceRegistryProperty

Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.ECS.Mixins;

             var serviceRegistryProperty = new ServiceRegistryProperty {
                 ContainerName = "containerName",
                 ContainerPort = 123,
                 Port = 123,
                 RegistryArn = "registryArn"
             };

Synopsis

Constructors

ServiceRegistryProperty()

The details for the service registry.

Properties

ContainerName	The container name value to be used for your service discovery service.
ContainerPort	The port value to be used for your service discovery service.
Port	The port value used if your service discovery service specified an SRV record.
RegistryArn	The Amazon Resource Name (ARN) of the service registry.

Constructors

ServiceRegistryProperty()

The details for the service registry.

public ServiceRegistryProperty()

Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.ECS.Mixins;

             var serviceRegistryProperty = new ServiceRegistryProperty {
                 ContainerName = "containerName",
                 ContainerPort = 123,
                 Port = 123,
                 RegistryArn = "registryArn"
             };

Properties

ContainerName

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

public string? ContainerName { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containername

ContainerPort

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

public double? ContainerPort { get; set; }

Property Value

double?

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-containerport

Port

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

public double? Port { get; set; }

Property Value

double?

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-port

RegistryArn

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

public string? RegistryArn { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-registryarn

Implements

CfnServicePropsMixin.IServiceRegistryProperty