1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. servicediscovery

Module servicediscovery

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource HttpNamespace

class HttpNamespace extends CustomResource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.servicediscovery.HttpNamespace("example", {
    description: "example",
});

constructor

new HttpNamespace(name: string, args?: HttpNamespaceArgs, opts?: pulumi.CustomResourceOptions)

Create a HttpNamespace resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HttpNamespaceState, opts?: pulumi.CustomResourceOptions): HttpNamespace

Get an existing HttpNamespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is HttpNamespace

Returns true if the given object is an instance of HttpNamespace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN that Amazon Route 53 assigns to the namespace when you create it.

property description

public description: pulumi.Output<string | undefined>;

The description that you specify for the namespace when you create it.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the http namespace.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource PrivateDnsNamespace

class PrivateDnsNamespace extends CustomResource

Provides a Service Discovery Private DNS Namespace resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleVpc = new aws.ec2.Vpc("example", {
    cidrBlock: "10.0.0.0/16",
});
const examplePrivateDnsNamespace = new aws.servicediscovery.PrivateDnsNamespace("example", {
    description: "example",
    vpc: exampleVpc.id,
});

constructor

new PrivateDnsNamespace(name: string, args: PrivateDnsNamespaceArgs, opts?: pulumi.CustomResourceOptions)

Create a PrivateDnsNamespace resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PrivateDnsNamespaceState, opts?: pulumi.CustomResourceOptions): PrivateDnsNamespace

Get an existing PrivateDnsNamespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PrivateDnsNamespace

Returns true if the given object is an instance of PrivateDnsNamespace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN that Amazon Route 53 assigns to the namespace when you create it.

property description

public description: pulumi.Output<string | undefined>;

The description that you specify for the namespace when you create it.

property hostedZone

public hostedZone: pulumi.Output<string>;

The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the namespace.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpc

public vpc: pulumi.Output<string>;

The ID of VPC that you want to associate the namespace with.

Resource PublicDnsNamespace

class PublicDnsNamespace extends CustomResource

Provides a Service Discovery Public DNS Namespace resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.servicediscovery.PublicDnsNamespace("example", {
    description: "example",
});

constructor

new PublicDnsNamespace(name: string, args?: PublicDnsNamespaceArgs, opts?: pulumi.CustomResourceOptions)

Create a PublicDnsNamespace resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PublicDnsNamespaceState, opts?: pulumi.CustomResourceOptions): PublicDnsNamespace

Get an existing PublicDnsNamespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PublicDnsNamespace

Returns true if the given object is an instance of PublicDnsNamespace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN that Amazon Route 53 assigns to the namespace when you create it.

property description

public description: pulumi.Output<string | undefined>;

The description that you specify for the namespace when you create it.

property hostedZone

public hostedZone: pulumi.Output<string>;

The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the namespace.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Service

class Service extends CustomResource

Provides a Service Discovery Service resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleVpc = new aws.ec2.Vpc("example", {
    cidrBlock: "10.0.0.0/16",
    enableDnsHostnames: true,
    enableDnsSupport: true,
});
const examplePrivateDnsNamespace = new aws.servicediscovery.PrivateDnsNamespace("example", {
    description: "example",
    vpc: exampleVpc.id,
});
const exampleService = new aws.servicediscovery.Service("example", {
    dnsConfig: {
        dnsRecords: [{
            ttl: 10,
            type: "A",
        }],
        namespaceId: examplePrivateDnsNamespace.id,
        routingPolicy: "MULTIVALUE",
    },
    healthCheckCustomConfig: {
        failureThreshold: 1,
    },
});

constructor

new Service(name: string, args?: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the service.

property description

public description: pulumi.Output<string | undefined>;

The description of the service.

property dnsConfig

public dnsConfig: pulumi.Output<ServiceDnsConfig | undefined>;

A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.

property healthCheckConfig

public healthCheckConfig: pulumi.Output<ServiceHealthCheckConfig | undefined>;

A complex type that contains settings for an optional health check. Only for Public DNS namespaces.

property healthCheckCustomConfig

public healthCheckCustomConfig: pulumi.Output<ServiceHealthCheckCustomConfig | undefined>;

A complex type that contains settings for ECS managed health checks.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the service.

property namespaceId

public namespaceId: pulumi.Output<string>;

The ID of the namespace to use for DNS configuration.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface HttpNamespaceArgs

interface HttpNamespaceArgs

The set of arguments for constructing a HttpNamespace resource.

property description

description?: pulumi.Input<string>;

The description that you specify for the namespace when you create it.

property name

name?: pulumi.Input<string>;

The name of the http namespace.

interface HttpNamespaceState

interface HttpNamespaceState

Input properties used for looking up and filtering HttpNamespace resources.

property arn

arn?: pulumi.Input<string>;

The ARN that Amazon Route 53 assigns to the namespace when you create it.

property description

description?: pulumi.Input<string>;

The description that you specify for the namespace when you create it.

property name

name?: pulumi.Input<string>;

The name of the http namespace.

interface PrivateDnsNamespaceArgs

interface PrivateDnsNamespaceArgs

The set of arguments for constructing a PrivateDnsNamespace resource.

property description

description?: pulumi.Input<string>;

The description that you specify for the namespace when you create it.

property name

name?: pulumi.Input<string>;

The name of the namespace.

property vpc

vpc: pulumi.Input<string>;

The ID of VPC that you want to associate the namespace with.

interface PrivateDnsNamespaceState

interface PrivateDnsNamespaceState

Input properties used for looking up and filtering PrivateDnsNamespace resources.

property arn

arn?: pulumi.Input<string>;

The ARN that Amazon Route 53 assigns to the namespace when you create it.

property description

description?: pulumi.Input<string>;

The description that you specify for the namespace when you create it.

property hostedZone

hostedZone?: pulumi.Input<string>;

The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.

property name

name?: pulumi.Input<string>;

The name of the namespace.

property vpc

vpc?: pulumi.Input<string>;

The ID of VPC that you want to associate the namespace with.

interface PublicDnsNamespaceArgs

interface PublicDnsNamespaceArgs

The set of arguments for constructing a PublicDnsNamespace resource.

property description

description?: pulumi.Input<string>;

The description that you specify for the namespace when you create it.

property name

name?: pulumi.Input<string>;

The name of the namespace.

interface PublicDnsNamespaceState

interface PublicDnsNamespaceState

Input properties used for looking up and filtering PublicDnsNamespace resources.

property arn

arn?: pulumi.Input<string>;

The ARN that Amazon Route 53 assigns to the namespace when you create it.

property description

description?: pulumi.Input<string>;

The description that you specify for the namespace when you create it.

property hostedZone

hostedZone?: pulumi.Input<string>;

The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.

property name

name?: pulumi.Input<string>;

The name of the namespace.

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property description

description?: pulumi.Input<string>;

The description of the service.

property dnsConfig

dnsConfig?: pulumi.Input<ServiceDnsConfig>;

A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.

property healthCheckConfig

healthCheckConfig?: pulumi.Input<ServiceHealthCheckConfig>;

A complex type that contains settings for an optional health check. Only for Public DNS namespaces.

property healthCheckCustomConfig

healthCheckCustomConfig?: pulumi.Input<ServiceHealthCheckCustomConfig>;

A complex type that contains settings for ECS managed health checks.

property name

name?: pulumi.Input<string>;

The name of the service.

property namespaceId

namespaceId?: pulumi.Input<string>;

The ID of the namespace to use for DNS configuration.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the service.

property description

description?: pulumi.Input<string>;

The description of the service.

property dnsConfig

dnsConfig?: pulumi.Input<ServiceDnsConfig>;

A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.

property healthCheckConfig

healthCheckConfig?: pulumi.Input<ServiceHealthCheckConfig>;

A complex type that contains settings for an optional health check. Only for Public DNS namespaces.

property healthCheckCustomConfig

healthCheckCustomConfig?: pulumi.Input<ServiceHealthCheckCustomConfig>;

A complex type that contains settings for ECS managed health checks.

property name

name?: pulumi.Input<string>;

The name of the service.

property namespaceId

namespaceId?: pulumi.Input<string>;

The ID of the namespace to use for DNS configuration.