@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
171 lines (170 loc) • 6.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS Route 53 Profiles Association.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.route53.ProfilesProfile("example", {name: "example"});
* const exampleVpc = new aws.ec2.Vpc("example", {cidr: "10.0.0.0/16"});
* const exampleProfilesAssociation = new aws.route53.ProfilesAssociation("example", {
* name: "example",
* profileId: example.id,
* resourceId: exampleVpc.id,
* tags: {
* Environment: "dev",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Route 53 Profiles Association using the `id`. For example:
*
* ```sh
* $ pulumi import aws:route53/profilesAssociation:ProfilesAssociation example rpa-id-12345678
* ```
*/
export declare class ProfilesAssociation extends pulumi.CustomResource {
/**
* Get an existing ProfilesAssociation 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?: ProfilesAssociationState, opts?: pulumi.CustomResourceOptions): ProfilesAssociation;
/**
* Returns true if the given object is an instance of ProfilesAssociation. 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 ProfilesAssociation;
readonly arn: pulumi.Output<string>;
/**
* Name of the Profile Association. Must match a regex of `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`.
*/
readonly name: pulumi.Output<string>;
readonly ownerId: pulumi.Output<string>;
/**
* ID of the profile associated with the VPC.
*/
readonly profileId: 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>;
/**
* Resource ID of the VPC the profile to be associated with.
*/
readonly resourceId: pulumi.Output<string>;
/**
* Status of the Profile Association.
*/
readonly status: pulumi.Output<string>;
/**
* Status message of the Profile Association.
*/
readonly statusMessage: pulumi.Output<string>;
/**
* Map of tags to assign to the resource. 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;
}>;
readonly timeouts: pulumi.Output<outputs.route53.ProfilesAssociationTimeouts | undefined>;
/**
* Create a ProfilesAssociation 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: ProfilesAssociationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProfilesAssociation resources.
*/
export interface ProfilesAssociationState {
arn?: pulumi.Input<string>;
/**
* Name of the Profile Association. Must match a regex of `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`.
*/
name?: pulumi.Input<string>;
ownerId?: pulumi.Input<string>;
/**
* ID of the profile associated with the VPC.
*/
profileId?: 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>;
/**
* Resource ID of the VPC the profile to be associated with.
*/
resourceId?: pulumi.Input<string>;
/**
* Status of the Profile Association.
*/
status?: pulumi.Input<string>;
/**
* Status message of the Profile Association.
*/
statusMessage?: pulumi.Input<string>;
/**
* Map of tags to assign to the resource. 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>;
}>;
timeouts?: pulumi.Input<inputs.route53.ProfilesAssociationTimeouts>;
}
/**
* The set of arguments for constructing a ProfilesAssociation resource.
*/
export interface ProfilesAssociationArgs {
/**
* Name of the Profile Association. Must match a regex of `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`.
*/
name?: pulumi.Input<string>;
/**
* ID of the profile associated with the VPC.
*/
profileId: 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>;
/**
* Resource ID of the VPC the profile to be associated with.
*/
resourceId: pulumi.Input<string>;
/**
* Map of tags to assign to the resource. 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>;
}>;
timeouts?: pulumi.Input<inputs.route53.ProfilesAssociationTimeouts>;
}