Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. vpc
  5. EndpointServicePrivateDnsVerification
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.vpc.EndpointServicePrivateDnsVerification

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Resource for managing an AWS VPC (Virtual Private Cloud) Endpoint Service Private DNS Verification. This resource begins the verification process by calling the StartVpcEndpointServicePrivateDnsVerification API. The service provider should add a record to the DNS server before creating this resource.

For additional details, refer to the AWS documentation on managing VPC endpoint service DNS names.

Destruction of this resource will not stop the verification process, only remove the resource from state.

Example Usage

Basic Usage

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

const example = new aws.vpc.EndpointServicePrivateDnsVerification("example", {serviceId: exampleAwsVpcEndpointService.id});
Copy
import pulumi
import pulumi_aws as aws

example = aws.vpc.EndpointServicePrivateDnsVerification("example", service_id=example_aws_vpc_endpoint_service["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpc.NewEndpointServicePrivateDnsVerification(ctx, "example", &vpc.EndpointServicePrivateDnsVerificationArgs{
			ServiceId: pulumi.Any(exampleAwsVpcEndpointService.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Vpc.EndpointServicePrivateDnsVerification("example", new()
    {
        ServiceId = exampleAwsVpcEndpointService.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpc.EndpointServicePrivateDnsVerification;
import com.pulumi.aws.vpc.EndpointServicePrivateDnsVerificationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new EndpointServicePrivateDnsVerification("example", EndpointServicePrivateDnsVerificationArgs.builder()
            .serviceId(exampleAwsVpcEndpointService.id())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:vpc:EndpointServicePrivateDnsVerification
    properties:
      serviceId: ${exampleAwsVpcEndpointService.id}
Copy

Create EndpointServicePrivateDnsVerification Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EndpointServicePrivateDnsVerification(name: string, args: EndpointServicePrivateDnsVerificationArgs, opts?: CustomResourceOptions);
@overload
def EndpointServicePrivateDnsVerification(resource_name: str,
                                          args: EndpointServicePrivateDnsVerificationArgs,
                                          opts: Optional[ResourceOptions] = None)

@overload
def EndpointServicePrivateDnsVerification(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          service_id: Optional[str] = None,
                                          timeouts: Optional[EndpointServicePrivateDnsVerificationTimeoutsArgs] = None,
                                          wait_for_verification: Optional[bool] = None)
func NewEndpointServicePrivateDnsVerification(ctx *Context, name string, args EndpointServicePrivateDnsVerificationArgs, opts ...ResourceOption) (*EndpointServicePrivateDnsVerification, error)
public EndpointServicePrivateDnsVerification(string name, EndpointServicePrivateDnsVerificationArgs args, CustomResourceOptions? opts = null)
public EndpointServicePrivateDnsVerification(String name, EndpointServicePrivateDnsVerificationArgs args)
public EndpointServicePrivateDnsVerification(String name, EndpointServicePrivateDnsVerificationArgs args, CustomResourceOptions options)

type: aws:vpc:EndpointServicePrivateDnsVerification
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EndpointServicePrivateDnsVerificationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EndpointServicePrivateDnsVerificationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EndpointServicePrivateDnsVerificationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EndpointServicePrivateDnsVerificationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EndpointServicePrivateDnsVerificationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var endpointServicePrivateDnsVerificationResource = new Aws.Vpc.EndpointServicePrivateDnsVerification("endpointServicePrivateDnsVerificationResource", new()
{
    ServiceId = "string",
    Timeouts = new Aws.Vpc.Inputs.EndpointServicePrivateDnsVerificationTimeoutsArgs
    {
        Create = "string",
    },
    WaitForVerification = false,
});
Copy
example, err := vpc.NewEndpointServicePrivateDnsVerification(ctx, "endpointServicePrivateDnsVerificationResource", &vpc.EndpointServicePrivateDnsVerificationArgs{
	ServiceId: pulumi.String("string"),
	Timeouts: &vpc.EndpointServicePrivateDnsVerificationTimeoutsArgs{
		Create: pulumi.String("string"),
	},
	WaitForVerification: pulumi.Bool(false),
})
Copy
var endpointServicePrivateDnsVerificationResource = new EndpointServicePrivateDnsVerification("endpointServicePrivateDnsVerificationResource", EndpointServicePrivateDnsVerificationArgs.builder()
    .serviceId("string")
    .timeouts(EndpointServicePrivateDnsVerificationTimeoutsArgs.builder()
        .create("string")
        .build())
    .waitForVerification(false)
    .build());
Copy
endpoint_service_private_dns_verification_resource = aws.vpc.EndpointServicePrivateDnsVerification("endpointServicePrivateDnsVerificationResource",
    service_id="string",
    timeouts={
        "create": "string",
    },
    wait_for_verification=False)
Copy
const endpointServicePrivateDnsVerificationResource = new aws.vpc.EndpointServicePrivateDnsVerification("endpointServicePrivateDnsVerificationResource", {
    serviceId: "string",
    timeouts: {
        create: "string",
    },
    waitForVerification: false,
});
Copy
type: aws:vpc:EndpointServicePrivateDnsVerification
properties:
    serviceId: string
    timeouts:
        create: string
    waitForVerification: false
Copy

EndpointServicePrivateDnsVerification Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EndpointServicePrivateDnsVerification resource accepts the following input properties:

ServiceId This property is required. string

ID of the endpoint service.

The following arguments are optional:

Timeouts EndpointServicePrivateDnsVerificationTimeouts
WaitForVerification bool
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
ServiceId This property is required. string

ID of the endpoint service.

The following arguments are optional:

Timeouts EndpointServicePrivateDnsVerificationTimeoutsArgs
WaitForVerification bool
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
serviceId This property is required. String

ID of the endpoint service.

The following arguments are optional:

timeouts EndpointServicePrivateDnsVerificationTimeouts
waitForVerification Boolean
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
serviceId This property is required. string

ID of the endpoint service.

The following arguments are optional:

timeouts EndpointServicePrivateDnsVerificationTimeouts
waitForVerification boolean
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
service_id This property is required. str

ID of the endpoint service.

The following arguments are optional:

timeouts EndpointServicePrivateDnsVerificationTimeoutsArgs
wait_for_verification bool
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
serviceId This property is required. String

ID of the endpoint service.

The following arguments are optional:

timeouts Property Map
waitForVerification Boolean
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing EndpointServicePrivateDnsVerification Resource

Get an existing EndpointServicePrivateDnsVerification 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?: EndpointServicePrivateDnsVerificationState, opts?: CustomResourceOptions): EndpointServicePrivateDnsVerification
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        service_id: Optional[str] = None,
        timeouts: Optional[EndpointServicePrivateDnsVerificationTimeoutsArgs] = None,
        wait_for_verification: Optional[bool] = None) -> EndpointServicePrivateDnsVerification
func GetEndpointServicePrivateDnsVerification(ctx *Context, name string, id IDInput, state *EndpointServicePrivateDnsVerificationState, opts ...ResourceOption) (*EndpointServicePrivateDnsVerification, error)
public static EndpointServicePrivateDnsVerification Get(string name, Input<string> id, EndpointServicePrivateDnsVerificationState? state, CustomResourceOptions? opts = null)
public static EndpointServicePrivateDnsVerification get(String name, Output<String> id, EndpointServicePrivateDnsVerificationState state, CustomResourceOptions options)
resources:  _:    type: aws:vpc:EndpointServicePrivateDnsVerification    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ServiceId string

ID of the endpoint service.

The following arguments are optional:

Timeouts EndpointServicePrivateDnsVerificationTimeouts
WaitForVerification bool
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
ServiceId string

ID of the endpoint service.

The following arguments are optional:

Timeouts EndpointServicePrivateDnsVerificationTimeoutsArgs
WaitForVerification bool
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
serviceId String

ID of the endpoint service.

The following arguments are optional:

timeouts EndpointServicePrivateDnsVerificationTimeouts
waitForVerification Boolean
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
serviceId string

ID of the endpoint service.

The following arguments are optional:

timeouts EndpointServicePrivateDnsVerificationTimeouts
waitForVerification boolean
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
service_id str

ID of the endpoint service.

The following arguments are optional:

timeouts EndpointServicePrivateDnsVerificationTimeoutsArgs
wait_for_verification bool
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.
serviceId String

ID of the endpoint service.

The following arguments are optional:

timeouts Property Map
waitForVerification Boolean
Whether to wait until the endpoint service returns a Verified status for the configured private DNS name.

Supporting Types

EndpointServicePrivateDnsVerificationTimeouts
, EndpointServicePrivateDnsVerificationTimeoutsArgs

Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Import

You cannot import this resource.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws