Interface ICfnServiceProps

Properties for defining a CfnService.

Namespace: Amazon.CDK.AWS.ServiceDiscovery

Assembly: Amazon.CDK.AWS.ServiceDiscovery.dll

Syntax (csharp)

public interface ICfnServiceProps

Syntax (vb)

Public Interface ICfnServiceProps

Remarks

Link: 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;

CfnServiceProps 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",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Type = "type"
};

Synopsis

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 of the namespace that was used to create the service.
Tags	The tags for the service.
Type	If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation.

Properties

Description

The description of the service.

virtual string Description { get; }

Property Value

System.String

Remarks

Link: 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.

virtual object DnsConfig { get; }

Property Value

System.Object

Remarks

Link: 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 .

virtual object HealthCheckConfig { get; }

Property Value

System.Object

Remarks

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

Link: 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.

virtual object HealthCheckCustomConfig { get; }

Property Value

System.Object

Remarks

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

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

Name

The name of the service.

virtual string Name { get; }

Property Value

System.String

Remarks

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

NamespaceId

The ID of the namespace that was used to create the service.

virtual string NamespaceId { get; }

Property Value

System.String

Remarks

You must specify a value for NamespaceId either for the service properties or for DnsConfig . Don't specify a value in both places.

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

Tags

The tags for the service.

virtual ICfnTag[] Tags { get; }

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.

Link: 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.

virtual string Type { get; }

Property Value

System.String

Remarks

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

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