Class CfnServiceProps

Properties for defining a CfnService.

Inheritance

object

CfnServiceProps

Implements

ICfnServiceProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ServiceDiscovery

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnServiceProps : ICfnServiceProps

Syntax (vb)

Public Class CfnServiceProps Implements ICfnServiceProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.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.AWS.ServiceDiscovery;

             var serviceAttributes;

             var cfnServiceProps = new CfnServiceProps {
                 Description = "description",
                 DnsConfig = new DnsConfigProperty {
                     DnsRecords = new [] { new DnsRecordProperty {
                         Ttl = 123,
                         Type = "type"
                     } },

                     // the properties below are optional
                     NamespaceId = "namespaceId",
                     RoutingPolicy = "routingPolicy"
                 },
                 HealthCheckConfig = new HealthCheckConfigProperty {
                     Type = "type",

                     // the properties below are optional
                     FailureThreshold = 123,
                     ResourcePath = "resourcePath"
                 },
                 HealthCheckCustomConfig = new HealthCheckCustomConfigProperty {
                     FailureThreshold = 123
                 },
                 Name = "name",
                 NamespaceId = "namespaceId",
                 ServiceAttributes = serviceAttributes,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             };

Synopsis

Constructors

CfnServiceProps()

Properties for defining a CfnService.

Properties

Description	The description of the service.
DnsConfig	A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
HealthCheckConfig	Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig .
HealthCheckCustomConfig	A complex type that contains information about an optional custom health check.
Name	The name of the service.
NamespaceId	The ID or Amazon Resource Name (ARN) of the namespace that you want to use to create the service.
ServiceAttributes	A complex type that contains information about attributes associated with a specific service.
Tags	The tags for the service.
Type	If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation.

Constructors

CfnServiceProps()

Properties for defining a CfnService.

public CfnServiceProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.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.AWS.ServiceDiscovery;

             var serviceAttributes;

             var cfnServiceProps = new CfnServiceProps {
                 Description = "description",
                 DnsConfig = new DnsConfigProperty {
                     DnsRecords = new [] { new DnsRecordProperty {
                         Ttl = 123,
                         Type = "type"
                     } },

                     // the properties below are optional
                     NamespaceId = "namespaceId",
                     RoutingPolicy = "routingPolicy"
                 },
                 HealthCheckConfig = new HealthCheckConfigProperty {
                     Type = "type",

                     // the properties below are optional
                     FailureThreshold = 123,
                     ResourcePath = "resourcePath"
                 },
                 HealthCheckCustomConfig = new HealthCheckCustomConfigProperty {
                     FailureThreshold = 123
                 },
                 Name = "name",
                 NamespaceId = "namespaceId",
                 ServiceAttributes = serviceAttributes,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             };

Properties

Description

The description of the service.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-description

DnsConfig

A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

public object? DnsConfig { get; set; }

Property Value

object

Remarks

The record types of a service can only be changed by deleting the service and recreating it with a new <code>Dnsconfig</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-dnsconfig

HealthCheckConfig

Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig .

public object? HealthCheckConfig { get; set; }

Property Value

object

Remarks

For information about the charges for health checks, see Amazon Route 53 Pricing .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-healthcheckconfig

HealthCheckCustomConfig

A complex type that contains information about an optional custom health check.

public object? HealthCheckCustomConfig { get; set; }

Property Value

object

Remarks

If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-healthcheckcustomconfig

Name

The name of the service.

public string? Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-name

NamespaceId

The ID or Amazon Resource Name (ARN) of the namespace that you want to use to create the service.

public string? NamespaceId { get; set; }

Property Value

string

Remarks

For namespaces shared with your AWS account, specify the namespace ARN. For more information about shared namespaces, see Cross-account AWS Cloud Map namespace sharing in the AWS Cloud Map Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-namespaceid

ServiceAttributes

A complex type that contains information about attributes associated with a specific service.

public object? ServiceAttributes { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-serviceattributes

Tags

The tags for the service.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-tags

Type

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation.

public string? Type { get; set; }

Property Value

string

Remarks

No DNS records is registered for the service instances. The only valid value is HTTP .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-type

Implements

ICfnServiceProps