AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateService operation. Creates a service. This action defines the configuration for the following entities:

After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.

For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ServiceDiscovery.AmazonServiceDiscoveryRequest
      Amazon.ServiceDiscovery.Model.CreateServiceRequest

Namespace: Amazon.ServiceDiscovery.Model
Assembly: AWSSDK.ServiceDiscovery.dll
Version: 3.x.y.z

Syntax

C# 
public class CreateServiceRequest : AmazonServiceDiscoveryRequest
         IAmazonWebServiceRequest

The CreateServiceRequest type exposes the following members

Constructors

NameDescription
Public Method CreateServiceRequest()

Properties

NameTypeDescription
Public Property CreatorRequestId System.String

Gets and sets the property CreatorRequestId.

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Public Property Description System.String

Gets and sets the property Description.

A description for the service.

Public Property DnsConfig Amazon.ServiceDiscovery.Model.DnsConfig

Gets and sets the property DnsConfig.

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

Public Property HealthCheckConfig Amazon.ServiceDiscovery.Model.HealthCheckConfig

Gets and sets the property HealthCheckConfig.

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

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

For information about the charges for health checks, see Cloud Map Pricing.

Public Property HealthCheckCustomConfig Amazon.ServiceDiscovery.Model.HealthCheckCustomConfig

Gets and sets the property HealthCheckCustomConfig.

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

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

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

Public Property Name System.String

Gets and sets the property Name.

The name that you want to assign to the service.

Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.

  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.

Public Property NamespaceId System.String

Gets and sets the property NamespaceId.

The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.

Public Property Tags System.Collections.Generic.List<Amazon.ServiceDiscovery.Model.Tag>

Gets and sets the property Tags.

The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

Public Property Type Amazon.ServiceDiscovery.ServiceTypeOption

Gets and sets the property Type.

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

Examples

Example: Create service

Example: Create service


var client = new AmazonServiceDiscoveryClient();
var response = client.CreateService(new CreateServiceRequest 
{
    CreatorRequestId = "567c1193-6b00-4308-bd57-ad38a8822d25",
    DnsConfig = new DnsConfig {
        DnsRecords = new List<DnsRecord> {
            new DnsRecord {
                TTL = 60,
                Type = "A"
            }
        },
        NamespaceId = "ns-ylexjili4cdxy3xm",
        RoutingPolicy = "MULTIVALUE"
    },
    Name = "myservice",
    NamespaceId = "ns-ylexjili4cdxy3xm"
});

Service service = response.Service;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5