@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
192 lines (191 loc) • 7.34 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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
*
* ```typescript
* 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],
* });
* ```
*
* ### With Tags
*
* ```typescript
* 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
*
* Using `pulumi import`, import VPC Lattice Domain Verification using the `id`. For example:
*
* ```sh
* $ pulumi import aws:vpclattice/domainVerification:DomainVerification example dv-0a1b2c3d4e5f
* ```
*/
export declare class DomainVerification extends pulumi.CustomResource {
/**
* Get an existing DomainVerification resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainVerificationState, opts?: pulumi.CustomResourceOptions): DomainVerification;
/**
* Returns true if the given object is an instance of DomainVerification. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DomainVerification;
/**
* The Amazon Resource Name (ARN) of the domain verification.
*/
readonly arn: pulumi.Output<string>;
/**
* The date and time that the domain verification was created, in ISO-8601 format.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The domain name to verify ownership for.
*
* The following arguments are optional:
*/
readonly domainName: pulumi.Output<string>;
/**
* The date and time that the domain was last successfully verified, in ISO-8601 format.
*/
readonly lastVerifiedTime: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The current status of the domain verification process. Valid values: `VERIFIED`, `PENDING`, `VERIFICATION_TIMED_OUT`.
*/
readonly status: pulumi.Output<string>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The name of the TXT record that must be created for domain verification.
*/
readonly txtRecordName: pulumi.Output<string>;
/**
* The value that must be added to the TXT record for domain verification.
*/
readonly txtRecordValue: pulumi.Output<string>;
/**
* Create a DomainVerification resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DomainVerificationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DomainVerification resources.
*/
export interface DomainVerificationState {
/**
* The Amazon Resource Name (ARN) of the domain verification.
*/
arn?: pulumi.Input<string>;
/**
* The date and time that the domain verification was created, in ISO-8601 format.
*/
createdAt?: pulumi.Input<string>;
/**
* The domain name to verify ownership for.
*
* The following arguments are optional:
*/
domainName?: pulumi.Input<string>;
/**
* The date and time that the domain was last successfully verified, in ISO-8601 format.
*/
lastVerifiedTime?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The current status of the domain verification process. Valid values: `VERIFIED`, `PENDING`, `VERIFICATION_TIMED_OUT`.
*/
status?: pulumi.Input<string>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the TXT record that must be created for domain verification.
*/
txtRecordName?: pulumi.Input<string>;
/**
* The value that must be added to the TXT record for domain verification.
*/
txtRecordValue?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DomainVerification resource.
*/
export interface DomainVerificationArgs {
/**
* The domain name to verify ownership for.
*
* The following arguments are optional:
*/
domainName: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}