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.

servicediscovery¶

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.

class pulumi_aws.servicediscovery.HttpNamespace(resource_name, opts=None, description=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

import pulumi
import pulumi_aws as aws

example = aws.servicediscovery.HttpNamespace("example", description="example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description that you specify for the namespace when you create it.
name (pulumi.Input[str]) – The name of the http namespace.
tags (pulumi.Input[dict]) – A map of tags to assign to the namespace.

arn: pulumi.Output[str] = None¶: The ARN that Amazon Route 53 assigns to the namespace when you create it.

description: pulumi.Output[str] = None¶: The description that you specify for the namespace when you create it.

name: pulumi.Output[str] = None¶: The name of the http namespace.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the namespace.

static get(resource_name, id, opts=None, arn=None, description=None, name=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN that Amazon Route 53 assigns to the namespace when you create it.
description (pulumi.Input[str]) – The description that you specify for the namespace when you create it.
name (pulumi.Input[str]) – The name of the http namespace.
tags (pulumi.Input[dict]) – A map of tags to assign to the namespace.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.servicediscovery.PrivateDnsNamespace(resource_name, opts=None, description=None, name=None, tags=None, vpc=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Service Discovery Private DNS Namespace resource.

import pulumi
import pulumi_aws as aws

example_vpc = aws.ec2.Vpc("exampleVpc", cidr_block="10.0.0.0/16")
example_private_dns_namespace = aws.servicediscovery.PrivateDnsNamespace("examplePrivateDnsNamespace",
    description="example",
    vpc=example_vpc.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description that you specify for the namespace when you create it.
name (pulumi.Input[str]) – The name of the namespace.
tags (pulumi.Input[dict]) – A map of tags to assign to the namespace.
vpc (pulumi.Input[str]) – The ID of VPC that you want to associate the namespace with.

arn: pulumi.Output[str] = None¶: The ARN that Amazon Route 53 assigns to the namespace when you create it.

description: pulumi.Output[str] = None¶: The description that you specify for the namespace when you create it.

hosted_zone: pulumi.Output[str] = None¶: The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.

name: pulumi.Output[str] = None¶: The name of the namespace.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the namespace.

vpc: pulumi.Output[str] = None¶: The ID of VPC that you want to associate the namespace with.

static get(resource_name, id, opts=None, arn=None, description=None, hosted_zone=None, name=None, tags=None, vpc=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN that Amazon Route 53 assigns to the namespace when you create it.
description (pulumi.Input[str]) – The description that you specify for the namespace when you create it.
hosted_zone (pulumi.Input[str]) – The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
name (pulumi.Input[str]) – The name of the namespace.
tags (pulumi.Input[dict]) – A map of tags to assign to the namespace.
vpc (pulumi.Input[str]) – The ID of VPC that you want to associate the namespace with.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.servicediscovery.PublicDnsNamespace(resource_name, opts=None, description=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Service Discovery Public DNS Namespace resource.

import pulumi
import pulumi_aws as aws

example = aws.servicediscovery.PublicDnsNamespace("example", description="example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description that you specify for the namespace when you create it.
name (pulumi.Input[str]) – The name of the namespace.
tags (pulumi.Input[dict]) – A map of tags to assign to the namespace.

arn: pulumi.Output[str] = None¶: The ARN that Amazon Route 53 assigns to the namespace when you create it.

description: pulumi.Output[str] = None¶: The description that you specify for the namespace when you create it.

hosted_zone: pulumi.Output[str] = None¶: The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.

name: pulumi.Output[str] = None¶: The name of the namespace.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the namespace.

static get(resource_name, id, opts=None, arn=None, description=None, hosted_zone=None, name=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN that Amazon Route 53 assigns to the namespace when you create it.
description (pulumi.Input[str]) – The description that you specify for the namespace when you create it.
hosted_zone (pulumi.Input[str]) – The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
name (pulumi.Input[str]) – The name of the namespace.
tags (pulumi.Input[dict]) – A map of tags to assign to the namespace.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.servicediscovery.Service(resource_name, opts=None, description=None, dns_config=None, health_check_config=None, health_check_custom_config=None, name=None, namespace_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Service Discovery Service resource.

import pulumi
import pulumi_aws as aws

example_vpc = aws.ec2.Vpc("exampleVpc",
    cidr_block="10.0.0.0/16",
    enable_dns_hostnames=True,
    enable_dns_support=True)
example_private_dns_namespace = aws.servicediscovery.PrivateDnsNamespace("examplePrivateDnsNamespace",
    description="example",
    vpc=example_vpc.id)
example_service = aws.servicediscovery.Service("exampleService",
    dns_config={
        "dnsRecords": [{
            "ttl": 10,
            "type": "A",
        }],
        "namespace_id": example_private_dns_namespace.id,
        "routingPolicy": "MULTIVALUE",
    },
    health_check_custom_config={
        "failure_threshold": 1,
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the service.
dns_config (pulumi.Input[dict]) – A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.
health_check_config (pulumi.Input[dict]) – A complex type that contains settings for an optional health check. Only for Public DNS namespaces.
health_check_custom_config (pulumi.Input[dict]) – A complex type that contains settings for ECS managed health checks.
name (pulumi.Input[str]) – The name of the service.
namespace_id (pulumi.Input[str]) – The ID of the namespace to use for DNS configuration.
tags (pulumi.Input[dict]) – A map of tags to assign to the service.

The dns_config object supports the following:

dnsRecords (pulumi.Input[list]) - An array that contains one DnsRecord object for each resource record set.
- ttl (pulumi.Input[float]) - The amount of time, in seconds, that you want DNS resolvers to cache the settings for this resource record set.
- type (pulumi.Input[str]) - The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid Values: HTTP, HTTPS, TCP
namespace_id (pulumi.Input[str]) - The ID of the namespace to use for DNS configuration.
routingPolicy (pulumi.Input[str]) - The routing policy that you want to apply to all records that Route 53 creates when you register an instance and specify the service. Valid Values: MULTIVALUE, WEIGHTED

The health_check_config object supports the following:

failure_threshold (pulumi.Input[float]) - The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10.
resource_path (pulumi.Input[str]) - The path that you want Route 53 to request when performing health checks. Route 53 automatically adds the DNS name for the service. If you don’t specify a value, the default value is /.
type (pulumi.Input[str]) - The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid Values: HTTP, HTTPS, TCP

The health_check_custom_config object supports the following:

failure_threshold (pulumi.Input[float]) - The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10.

arn: pulumi.Output[str] = None¶: The ARN of the service.

description: pulumi.Output[str] = None¶: The description of the service.

dns_config: pulumi.Output[dict] = None¶

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

dnsRecords (list) - An array that contains one DnsRecord object for each resource record set.
- ttl (float) - The amount of time, in seconds, that you want DNS resolvers to cache the settings for this resource record set.
- type (str) - The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid Values: HTTP, HTTPS, TCP
namespace_id (str) - The ID of the namespace to use for DNS configuration.
routingPolicy (str) - The routing policy that you want to apply to all records that Route 53 creates when you register an instance and specify the service. Valid Values: MULTIVALUE, WEIGHTED

health_check_config: pulumi.Output[dict] = None¶

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

failure_threshold (float) - The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10.
resource_path (str) - The path that you want Route 53 to request when performing health checks. Route 53 automatically adds the DNS name for the service. If you don’t specify a value, the default value is /.
type (str) - The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid Values: HTTP, HTTPS, TCP

health_check_custom_config: pulumi.Output[dict] = None¶

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

failure_threshold (float) - The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10.

name: pulumi.Output[str] = None¶: The name of the service.

namespace_id: pulumi.Output[str] = None¶: The ID of the namespace to use for DNS configuration.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the service.

static get(resource_name, id, opts=None, arn=None, description=None, dns_config=None, health_check_config=None, health_check_custom_config=None, name=None, namespace_id=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the service.
description (pulumi.Input[str]) – The description of the service.
dns_config (pulumi.Input[dict]) – A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.
health_check_config (pulumi.Input[dict]) – A complex type that contains settings for an optional health check. Only for Public DNS namespaces.
health_check_custom_config (pulumi.Input[dict]) – A complex type that contains settings for ECS managed health checks.
name (pulumi.Input[str]) – The name of the service.
namespace_id (pulumi.Input[str]) – The ID of the namespace to use for DNS configuration.
tags (pulumi.Input[dict]) – A map of tags to assign to the service.

The dns_config object supports the following:

dnsRecords (pulumi.Input[list]) - An array that contains one DnsRecord object for each resource record set.
- ttl (pulumi.Input[float]) - The amount of time, in seconds, that you want DNS resolvers to cache the settings for this resource record set.
- type (pulumi.Input[str]) - The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid Values: HTTP, HTTPS, TCP
namespace_id (pulumi.Input[str]) - The ID of the namespace to use for DNS configuration.
routingPolicy (pulumi.Input[str]) - The routing policy that you want to apply to all records that Route 53 creates when you register an instance and specify the service. Valid Values: MULTIVALUE, WEIGHTED

The health_check_config object supports the following:

failure_threshold (pulumi.Input[float]) - The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10.
resource_path (pulumi.Input[str]) - The path that you want Route 53 to request when performing health checks. Route 53 automatically adds the DNS name for the service. If you don’t specify a value, the default value is /.
type (pulumi.Input[str]) - The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Valid Values: HTTP, HTTPS, TCP

The health_check_custom_config object supports the following:

failure_threshold (pulumi.Input[float]) - The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

servicediscovery¶

On This Page