Resource for managing an AWS VPC Lattice Domain Verification.
Starts the domain verification process for a custom domain name. Use this resource to verify ownership of a domain before associating it with VPC Lattice resources.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.vpclattice.DomainVerification("example", {domainName: "example.com"});
// Create DNS TXT record for domain verification
const exampleRecord = new aws.route53.Record("example", {
zoneId: exampleAwsRoute53Zone.zoneId,
name: example.txtRecordName,
type: aws.route53.RecordType.TXT,
ttl: 300,
records: [example.txtRecordValue],
});
import pulumi
import pulumi_aws as aws
example = aws.vpclattice.DomainVerification("example", domain_name="example.com")
# Create DNS TXT record for domain verification
example_record = aws.route53.Record("example",
zone_id=example_aws_route53_zone["zoneId"],
name=example.txt_record_name,
type=aws.route53.RecordType.TXT,
ttl=300,
records=[example.txt_record_value])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/vpclattice"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := vpclattice.NewDomainVerification(ctx, "example", &vpclattice.DomainVerificationArgs{
DomainName: pulumi.String("example.com"),
})
if err != nil {
return err
}
// Create DNS TXT record for domain verification
_, err = route53.NewRecord(ctx, "example", &route53.RecordArgs{
ZoneId: pulumi.Any(exampleAwsRoute53Zone.ZoneId),
Name: example.TxtRecordName,
Type: pulumi.String(route53.RecordTypeTXT),
Ttl: pulumi.Int(300),
Records: pulumi.StringArray{
example.TxtRecordValue,
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.VpcLattice.DomainVerification("example", new()
{
DomainName = "example.com",
});
// Create DNS TXT record for domain verification
var exampleRecord = new Aws.Route53.Record("example", new()
{
ZoneId = exampleAwsRoute53Zone.ZoneId,
Name = example.TxtRecordName,
Type = Aws.Route53.RecordType.TXT,
Ttl = 300,
Records = new[]
{
example.TxtRecordValue,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpclattice.DomainVerification;
import com.pulumi.aws.vpclattice.DomainVerificationArgs;
import com.pulumi.aws.route53.Record;
import com.pulumi.aws.route53.RecordArgs;
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 DomainVerification("example", DomainVerificationArgs.builder()
.domainName("example.com")
.build());
// Create DNS TXT record for domain verification
var exampleRecord = new Record("exampleRecord", RecordArgs.builder()
.zoneId(exampleAwsRoute53Zone.zoneId())
.name(example.txtRecordName())
.type("TXT")
.ttl(300)
.records(example.txtRecordValue())
.build());
}
}
resources:
example:
type: aws:vpclattice:DomainVerification
properties:
domainName: example.com
# Create DNS TXT record for domain verification
exampleRecord:
type: aws:route53:Record
name: example
properties:
zoneId: ${exampleAwsRoute53Zone.zoneId}
name: ${example.txtRecordName}
type: TXT
ttl: 300
records:
- ${example.txtRecordValue}
With Tags
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.vpclattice.DomainVerification("example", {
domainName: "example.com",
tags: {
Environment: "production",
Purpose: "domain-verification",
},
});
import pulumi
import pulumi_aws as aws
example = aws.vpclattice.DomainVerification("example",
domain_name="example.com",
tags={
"Environment": "production",
"Purpose": "domain-verification",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/vpclattice"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vpclattice.NewDomainVerification(ctx, "example", &vpclattice.DomainVerificationArgs{
DomainName: pulumi.String("example.com"),
Tags: pulumi.StringMap{
"Environment": pulumi.String("production"),
"Purpose": pulumi.String("domain-verification"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.VpcLattice.DomainVerification("example", new()
{
DomainName = "example.com",
Tags =
{
{ "Environment", "production" },
{ "Purpose", "domain-verification" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpclattice.DomainVerification;
import com.pulumi.aws.vpclattice.DomainVerificationArgs;
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 DomainVerification("example", DomainVerificationArgs.builder()
.domainName("example.com")
.tags(Map.ofEntries(
Map.entry("Environment", "production"),
Map.entry("Purpose", "domain-verification")
))
.build());
}
}
resources:
example:
type: aws:vpclattice:DomainVerification
properties:
domainName: example.com
tags:
Environment: production
Purpose: domain-verification
Create DomainVerification Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DomainVerification(name: string, args: DomainVerificationArgs, opts?: CustomResourceOptions);@overload
def DomainVerification(resource_name: str,
args: DomainVerificationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DomainVerification(resource_name: str,
opts: Optional[ResourceOptions] = None,
domain_name: Optional[str] = None,
region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewDomainVerification(ctx *Context, name string, args DomainVerificationArgs, opts ...ResourceOption) (*DomainVerification, error)public DomainVerification(string name, DomainVerificationArgs args, CustomResourceOptions? opts = null)
public DomainVerification(String name, DomainVerificationArgs args)
public DomainVerification(String name, DomainVerificationArgs args, CustomResourceOptions options)
type: aws:vpclattice:DomainVerification
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DomainVerificationArgs
- 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 DomainVerificationArgs
- 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 DomainVerificationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DomainVerificationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DomainVerificationArgs
- 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 domainVerificationResource = new Aws.VpcLattice.DomainVerification("domainVerificationResource", new()
{
DomainName = "string",
Region = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := vpclattice.NewDomainVerification(ctx, "domainVerificationResource", &vpclattice.DomainVerificationArgs{
DomainName: pulumi.String("string"),
Region: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var domainVerificationResource = new DomainVerification("domainVerificationResource", DomainVerificationArgs.builder()
.domainName("string")
.region("string")
.tags(Map.of("string", "string"))
.build());
domain_verification_resource = aws.vpclattice.DomainVerification("domainVerificationResource",
domain_name="string",
region="string",
tags={
"string": "string",
})
const domainVerificationResource = new aws.vpclattice.DomainVerification("domainVerificationResource", {
domainName: "string",
region: "string",
tags: {
string: "string",
},
});
type: aws:vpclattice:DomainVerification
properties:
domainName: string
region: string
tags:
string: string
DomainVerification 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 DomainVerification resource accepts the following input properties:
- Domain
Name string The domain name to verify ownership for.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Domain
Name string The domain name to verify ownership for.
The following arguments are optional:
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- domain
Name String The domain name to verify ownership for.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- domain
Name string The domain name to verify ownership for.
The following arguments are optional:
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- domain_
name str The domain name to verify ownership for.
The following arguments are optional:
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- domain
Name String The domain name to verify ownership for.
The following arguments are optional:
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the DomainVerification resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the domain verification.
- Created
At string - The date and time that the domain verification was created, in ISO-8601 format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Verified stringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- Status string
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Txt
Record stringName - The name of the TXT record that must be created for domain verification.
- Txt
Record stringValue - The value that must be added to the TXT record for domain verification.
- Arn string
- The Amazon Resource Name (ARN) of the domain verification.
- Created
At string - The date and time that the domain verification was created, in ISO-8601 format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Verified stringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- Status string
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Txt
Record stringName - The name of the TXT record that must be created for domain verification.
- Txt
Record stringValue - The value that must be added to the TXT record for domain verification.
- arn String
- The Amazon Resource Name (ARN) of the domain verification.
- created
At String - The date and time that the domain verification was created, in ISO-8601 format.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Verified StringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- status String
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - txt
Record StringName - The name of the TXT record that must be created for domain verification.
- txt
Record StringValue - The value that must be added to the TXT record for domain verification.
- arn string
- The Amazon Resource Name (ARN) of the domain verification.
- created
At string - The date and time that the domain verification was created, in ISO-8601 format.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Verified stringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- status string
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - txt
Record stringName - The name of the TXT record that must be created for domain verification.
- txt
Record stringValue - The value that must be added to the TXT record for domain verification.
- arn str
- The Amazon Resource Name (ARN) of the domain verification.
- created_
at str - The date and time that the domain verification was created, in ISO-8601 format.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
verified_ strtime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- status str
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - txt_
record_ strname - The name of the TXT record that must be created for domain verification.
- txt_
record_ strvalue - The value that must be added to the TXT record for domain verification.
- arn String
- The Amazon Resource Name (ARN) of the domain verification.
- created
At String - The date and time that the domain verification was created, in ISO-8601 format.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Verified StringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- status String
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - txt
Record StringName - The name of the TXT record that must be created for domain verification.
- txt
Record StringValue - The value that must be added to the TXT record for domain verification.
Look up Existing DomainVerification Resource
Get an existing DomainVerification 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?: DomainVerificationState, opts?: CustomResourceOptions): DomainVerification@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
created_at: Optional[str] = None,
domain_name: Optional[str] = None,
last_verified_time: Optional[str] = None,
region: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
txt_record_name: Optional[str] = None,
txt_record_value: Optional[str] = None) -> DomainVerificationfunc GetDomainVerification(ctx *Context, name string, id IDInput, state *DomainVerificationState, opts ...ResourceOption) (*DomainVerification, error)public static DomainVerification Get(string name, Input<string> id, DomainVerificationState? state, CustomResourceOptions? opts = null)public static DomainVerification get(String name, Output<String> id, DomainVerificationState state, CustomResourceOptions options)resources: _: type: aws:vpclattice:DomainVerification get: id: ${id}- 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.
- 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.
- Arn string
- The Amazon Resource Name (ARN) of the domain verification.
- Created
At string - The date and time that the domain verification was created, in ISO-8601 format.
- Domain
Name string The domain name to verify ownership for.
The following arguments are optional:
- Last
Verified stringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Status string
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - Dictionary<string, string>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Txt
Record stringName - The name of the TXT record that must be created for domain verification.
- Txt
Record stringValue - The value that must be added to the TXT record for domain verification.
- Arn string
- The Amazon Resource Name (ARN) of the domain verification.
- Created
At string - The date and time that the domain verification was created, in ISO-8601 format.
- Domain
Name string The domain name to verify ownership for.
The following arguments are optional:
- Last
Verified stringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Status string
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - map[string]string
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Txt
Record stringName - The name of the TXT record that must be created for domain verification.
- Txt
Record stringValue - The value that must be added to the TXT record for domain verification.
- arn String
- The Amazon Resource Name (ARN) of the domain verification.
- created
At String - The date and time that the domain verification was created, in ISO-8601 format.
- domain
Name String The domain name to verify ownership for.
The following arguments are optional:
- last
Verified StringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- status String
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - Map<String,String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - txt
Record StringName - The name of the TXT record that must be created for domain verification.
- txt
Record StringValue - The value that must be added to the TXT record for domain verification.
- arn string
- The Amazon Resource Name (ARN) of the domain verification.
- created
At string - The date and time that the domain verification was created, in ISO-8601 format.
- domain
Name string The domain name to verify ownership for.
The following arguments are optional:
- last
Verified stringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- status string
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - {[key: string]: string}
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - txt
Record stringName - The name of the TXT record that must be created for domain verification.
- txt
Record stringValue - The value that must be added to the TXT record for domain verification.
- arn str
- The Amazon Resource Name (ARN) of the domain verification.
- created_
at str - The date and time that the domain verification was created, in ISO-8601 format.
- domain_
name str The domain name to verify ownership for.
The following arguments are optional:
- last_
verified_ strtime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- status str
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - Mapping[str, str]
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - txt_
record_ strname - The name of the TXT record that must be created for domain verification.
- txt_
record_ strvalue - The value that must be added to the TXT record for domain verification.
- arn String
- The Amazon Resource Name (ARN) of the domain verification.
- created
At String - The date and time that the domain verification was created, in ISO-8601 format.
- domain
Name String The domain name to verify ownership for.
The following arguments are optional:
- last
Verified StringTime - The date and time that the domain was last successfully verified, in ISO-8601 format.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- status String
- The current status of the domain verification process. Valid values:
VERIFIED,PENDING,VERIFICATION_TIMED_OUT. - Map<String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - txt
Record StringName - The name of the TXT record that must be created for domain verification.
- txt
Record StringValue - The value that must be added to the TXT record for domain verification.
Import
Using pulumi import, import VPC Lattice Domain Verification using the id. For example:
$ pulumi import aws:vpclattice/domainVerification:DomainVerification example dv-0a1b2c3d4e5f
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
awsTerraform Provider.
