@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
168 lines (167 loc) • 5.76 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a DNS zone transfer request in the OpenStack DNS Service.
*
* ## Example Usage
*
* ### Automatically detect the correct network
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const exampleZone = new openstack.dns.Zone("example_zone", {
* name: "example.com.",
* email: "jdoe@example.com",
* description: "An example zone",
* ttl: 3000,
* type: "PRIMARY",
* });
* const request1 = new openstack.dns.TransferRequest("request_1", {
* zoneId: exampleZone.id,
* description: "a transfer request",
* });
* ```
*
* ## Import
*
* This resource can be imported by specifying the transferRequest ID:
*
* ```sh
* $ pulumi import openstack:dns/transferRequest:TransferRequest request_1 request_id
* ```
*/
export declare class TransferRequest extends pulumi.CustomResource {
/**
* Get an existing TransferRequest 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?: TransferRequestState, opts?: pulumi.CustomResourceOptions): TransferRequest;
/**
* Returns true if the given object is an instance of TransferRequest. 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 TransferRequest;
/**
* A description of the zone tranfer request.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Disable wait for zone to reach ACTIVE
* status. The check is enabled by default. If this argument is true, zone
* will be considered as created/updated if OpenStack request returned success.
*/
readonly disableStatusCheck: pulumi.Output<boolean | undefined>;
readonly key: pulumi.Output<string>;
/**
* The region in which to obtain the V2 DNS client.
* If omitted, the `region` argument of the provider is used.
* Changing this creates a new DNS zone zone transfer accept.
*/
readonly region: pulumi.Output<string>;
/**
* The target Project ID to transfer to.
*/
readonly targetProjectId: pulumi.Output<string>;
/**
* Map of additional options. Changing this creates a
* new transfer request.
*/
readonly valueSpecs: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The ID of the zone for which to create the transfer
* request.
*/
readonly zoneId: pulumi.Output<string>;
/**
* Create a TransferRequest 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: TransferRequestArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TransferRequest resources.
*/
export interface TransferRequestState {
/**
* A description of the zone tranfer request.
*/
description?: pulumi.Input<string>;
/**
* Disable wait for zone to reach ACTIVE
* status. The check is enabled by default. If this argument is true, zone
* will be considered as created/updated if OpenStack request returned success.
*/
disableStatusCheck?: pulumi.Input<boolean>;
key?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 DNS client.
* If omitted, the `region` argument of the provider is used.
* Changing this creates a new DNS zone zone transfer accept.
*/
region?: pulumi.Input<string>;
/**
* The target Project ID to transfer to.
*/
targetProjectId?: pulumi.Input<string>;
/**
* Map of additional options. Changing this creates a
* new transfer request.
*/
valueSpecs?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The ID of the zone for which to create the transfer
* request.
*/
zoneId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TransferRequest resource.
*/
export interface TransferRequestArgs {
/**
* A description of the zone tranfer request.
*/
description?: pulumi.Input<string>;
/**
* Disable wait for zone to reach ACTIVE
* status. The check is enabled by default. If this argument is true, zone
* will be considered as created/updated if OpenStack request returned success.
*/
disableStatusCheck?: pulumi.Input<boolean>;
key?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 DNS client.
* If omitted, the `region` argument of the provider is used.
* Changing this creates a new DNS zone zone transfer accept.
*/
region?: pulumi.Input<string>;
/**
* The target Project ID to transfer to.
*/
targetProjectId?: pulumi.Input<string>;
/**
* Map of additional options. Changing this creates a
* new transfer request.
*/
valueSpecs?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The ID of the zone for which to create the transfer
* request.
*/
zoneId: pulumi.Input<string>;
}