@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
193 lines • 7.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Apigee Dns Zone.
*
* To get more information about DnsZone, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.dnsZones/create)
* * How-to Guides
* * [Creating a DnsZone](https://cloud.google.com/apigee/docs/api-platform/get-started/create-dns)
*
* ## Example Usage
*
* ### Apigee Dns Zone Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const current = gcp.organizations.getClientConfig({});
* const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
* const org = new gcp.apigee.Organization("org", {
* description: "Terraform-provisioned basic Apigee Org without VPC Peering.",
* analyticsRegion: "us-central1",
* projectId: current.then(current => current.project),
* disableVpcPeering: true,
* });
* const apigeeDnsZone = new gcp.apigee.DnsZone("apigee_dns_zone", {
* orgId: apigeeOrg.id,
* dnsZoneId: "test1",
* domain: "foo.com",
* description: "test",
* peeringConfig: {
* targetProjectId: current.then(current => current.project),
* targetNetworkId: apigeeNetwork.id,
* },
* });
* ```
*
* ## Import
*
* DnsZone can be imported using any of these accepted formats:
*
* * `{{org_id}}/dnsZones/{{dns_zone_id}}`
* * `{{org_id}}/{{dns_zone_id}}`
*
* When using the `pulumi import` command, DnsZone can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apigee/dnsZone:DnsZone default {{org_id}}/dnsZones/{{dns_zone_id}}
* $ pulumi import gcp:apigee/dnsZone:DnsZone default {{org_id}}/{{dns_zone_id}}
* ```
*/
export declare class DnsZone extends pulumi.CustomResource {
/**
* Get an existing DnsZone 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?: DnsZoneState, opts?: pulumi.CustomResourceOptions): DnsZone;
/**
* Returns true if the given object is an instance of DnsZone. 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 DnsZone;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* Description for the zone.
*/
readonly description: pulumi.Output<string>;
/**
* ID of the dns zone.
*/
readonly dnsZoneId: pulumi.Output<string>;
/**
* Doamin for the zone.
*/
readonly domain: pulumi.Output<string>;
/**
* Name of the Dns Zone in the following format:
* organizations/{organization}/dnsZones/{dnsZone}.
*/
readonly name: pulumi.Output<string>;
/**
* The Apigee Organization associated with the Apigee instance,
* in the format `organizations/{{org_name}}`.
*/
readonly orgId: pulumi.Output<string>;
/**
* Peering zone config
* Structure is documented below.
*/
readonly peeringConfig: pulumi.Output<outputs.apigee.DnsZonePeeringConfig>;
/**
* Create a DnsZone 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: DnsZoneArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DnsZone resources.
*/
export interface DnsZoneState {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Description for the zone.
*/
description?: pulumi.Input<string | undefined>;
/**
* ID of the dns zone.
*/
dnsZoneId?: pulumi.Input<string | undefined>;
/**
* Doamin for the zone.
*/
domain?: pulumi.Input<string | undefined>;
/**
* Name of the Dns Zone in the following format:
* organizations/{organization}/dnsZones/{dnsZone}.
*/
name?: pulumi.Input<string | undefined>;
/**
* The Apigee Organization associated with the Apigee instance,
* in the format `organizations/{{org_name}}`.
*/
orgId?: pulumi.Input<string | undefined>;
/**
* Peering zone config
* Structure is documented below.
*/
peeringConfig?: pulumi.Input<inputs.apigee.DnsZonePeeringConfig | undefined>;
}
/**
* The set of arguments for constructing a DnsZone resource.
*/
export interface DnsZoneArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Description for the zone.
*/
description: pulumi.Input<string>;
/**
* ID of the dns zone.
*/
dnsZoneId: pulumi.Input<string>;
/**
* Doamin for the zone.
*/
domain: pulumi.Input<string>;
/**
* The Apigee Organization associated with the Apigee instance,
* in the format `organizations/{{org_name}}`.
*/
orgId: pulumi.Input<string>;
/**
* Peering zone config
* Structure is documented below.
*/
peeringConfig: pulumi.Input<inputs.apigee.DnsZonePeeringConfig>;
}
//# sourceMappingURL=dnsZone.d.ts.map