PrivateDnsNamespace

Provides a Service Discovery Private DNS Namespace resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleVpc = new Aws.Ec2.Vpc("exampleVpc", new Aws.Ec2.VpcArgs
        {
            CidrBlock = "10.0.0.0/16",
        });
        var examplePrivateDnsNamespace = new Aws.ServiceDiscovery.PrivateDnsNamespace("examplePrivateDnsNamespace", new Aws.ServiceDiscovery.PrivateDnsNamespaceArgs
        {
            Description = "example",
            Vpc = exampleVpc.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/servicediscovery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleVpc, err := ec2.NewVpc(ctx, "exampleVpc", &ec2.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		_, err = servicediscovery.NewPrivateDnsNamespace(ctx, "examplePrivateDnsNamespace", &servicediscovery.PrivateDnsNamespaceArgs{
			Description: pulumi.String("example"),
			Vpc:         exampleVpc.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

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

Create a PrivateDnsNamespace Resource

new PrivateDnsNamespace(name: string, args: PrivateDnsNamespaceArgs, opts?: CustomResourceOptions);
@overload
def PrivateDnsNamespace(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None,
                        tags_all: Optional[Mapping[str, str]] = None,
                        vpc: Optional[str] = None)
@overload
def PrivateDnsNamespace(resource_name: str,
                        args: PrivateDnsNamespaceArgs,
                        opts: Optional[ResourceOptions] = None)
func NewPrivateDnsNamespace(ctx *Context, name string, args PrivateDnsNamespaceArgs, opts ...ResourceOption) (*PrivateDnsNamespace, error)
public PrivateDnsNamespace(string name, PrivateDnsNamespaceArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args PrivateDnsNamespaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args PrivateDnsNamespaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args PrivateDnsNamespaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PrivateDnsNamespaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

PrivateDnsNamespace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The PrivateDnsNamespace resource accepts the following input properties:

Vpc string
The ID of VPC that you want to associate the namespace with.
Description string
The description that you specify for the namespace when you create it.
Name string
The name of the namespace.
Tags Dictionary<string, string>
A map of tags to assign to the namespace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
Vpc string
The ID of VPC that you want to associate the namespace with.
Description string
The description that you specify for the namespace when you create it.
Name string
The name of the namespace.
Tags map[string]string
A map of tags to assign to the namespace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
vpc string
The ID of VPC that you want to associate the namespace with.
description string
The description that you specify for the namespace when you create it.
name string
The name of the namespace.
tags {[key: string]: string}
A map of tags to assign to the namespace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
vpc str
The ID of VPC that you want to associate the namespace with.
description str
The description that you specify for the namespace when you create it.
name str
The name of the namespace.
tags Mapping[str, str]
A map of tags to assign to the namespace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .

Outputs

All input properties are implicitly available as output properties. Additionally, the PrivateDnsNamespace resource produces the following output properties:

Arn string
The ARN that Amazon Route 53 assigns to the namespace when you create it.
HostedZone string
The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The ARN that Amazon Route 53 assigns to the namespace when you create it.
HostedZone string
The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
Id string
The provider-assigned unique ID for this managed resource.
arn string
The ARN that Amazon Route 53 assigns to the namespace when you create it.
hostedZone string
The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
id string
The provider-assigned unique ID for this managed resource.
arn str
The ARN that Amazon Route 53 assigns to the namespace when you create it.
hosted_zone str
The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing PrivateDnsNamespace Resource

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

public static get(name: string, id: Input<ID>, state?: PrivateDnsNamespaceState, opts?: CustomResourceOptions): PrivateDnsNamespace
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        hosted_zone: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc: Optional[str] = None) -> PrivateDnsNamespace
func GetPrivateDnsNamespace(ctx *Context, name string, id IDInput, state *PrivateDnsNamespaceState, opts ...ResourceOption) (*PrivateDnsNamespace, error)
public static PrivateDnsNamespace Get(string name, Input<string> id, PrivateDnsNamespaceState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string
The ARN that Amazon Route 53 assigns to the namespace when you create it.
Description string
The description that you specify for the namespace when you create it.
HostedZone string
The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
Name string
The name of the namespace.
Tags Dictionary<string, string>
A map of tags to assign to the namespace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
Vpc string
The ID of VPC that you want to associate the namespace with.
Arn string
The ARN that Amazon Route 53 assigns to the namespace when you create it.
Description string
The description that you specify for the namespace when you create it.
HostedZone string
The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
Name string
The name of the namespace.
Tags map[string]string
A map of tags to assign to the namespace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
Vpc string
The ID of VPC that you want to associate the namespace with.
arn string
The ARN that Amazon Route 53 assigns to the namespace when you create it.
description string
The description that you specify for the namespace when you create it.
hostedZone string
The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
name string
The name of the namespace.
tags {[key: string]: string}
A map of tags to assign to the namespace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
vpc string
The ID of VPC that you want to associate the namespace with.
arn str
The ARN that Amazon Route 53 assigns to the namespace when you create it.
description str
The description that you specify for the namespace when you create it.
hosted_zone str
The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.
name str
The name of the namespace.
tags Mapping[str, str]
A map of tags to assign to the namespace. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .
vpc str
The ID of VPC that you want to associate the namespace with.

Import

Service Discovery Private DNS Namespace can be imported using the namespace ID and VPC ID, e.g.

 $ pulumi import aws:servicediscovery/privateDnsNamespace:PrivateDnsNamespace example 0123456789:vpc-123345

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.