UNPKG

@pulumi/openstack

Version:

A Pulumi package for creating and managing OpenStack cloud resources.

246 lines (245 loc) • 7.79 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages a DNS zone 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 exampleCom = new openstack.dns.Zone("example_com", { * name: "example.com.", * email: "jdoe@example.com", * description: "An example zone", * ttl: 3000, * type: "PRIMARY", * }); * ``` * * ## Import * * This resource can be imported by specifying the zone ID with optional project ID: * * ```sh * $ pulumi import openstack:dns/zone:Zone zone_1 zone_id * ``` * * ```sh * $ pulumi import openstack:dns/zone:Zone zone_1 zone_id/project_id * ``` */ export declare class Zone extends pulumi.CustomResource { /** * Get an existing Zone 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?: ZoneState, opts?: pulumi.CustomResourceOptions): Zone; /** * Returns true if the given object is an instance of Zone. 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 Zone; /** * Attributes for the DNS Service scheduler. * Changing this creates a new zone. */ readonly attributes: pulumi.Output<{ [key: string]: string; } | undefined>; /** * A description of the zone. */ 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>; /** * The email contact for the zone record. */ readonly email: pulumi.Output<string | undefined>; /** * An array of master DNS servers. For when `type` is * `SECONDARY`. */ readonly masters: pulumi.Output<string[] | undefined>; /** * The name of the zone. Note the `.` at the end of the name. * Changing this creates a new DNS zone. */ readonly name: pulumi.Output<string>; /** * The ID of the project DNS zone is created * for, sets `X-Auth-Sudo-Tenant-ID` header (requires an assigned * user role in target project). */ readonly projectId: 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. */ readonly region: pulumi.Output<string>; /** * The time to live (TTL) of the zone. */ readonly ttl: pulumi.Output<number>; /** * The type of zone. Can either be `PRIMARY` or `SECONDARY`. * Changing this creates a new zone. */ readonly type: pulumi.Output<string>; /** * Map of additional options. Changing this creates a * new zone. */ readonly valueSpecs: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Create a Zone 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?: ZoneArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Zone resources. */ export interface ZoneState { /** * Attributes for the DNS Service scheduler. * Changing this creates a new zone. */ attributes?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * A description of the zone. */ 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>; /** * The email contact for the zone record. */ email?: pulumi.Input<string>; /** * An array of master DNS servers. For when `type` is * `SECONDARY`. */ masters?: pulumi.Input<pulumi.Input<string>[]>; /** * The name of the zone. Note the `.` at the end of the name. * Changing this creates a new DNS zone. */ name?: pulumi.Input<string>; /** * The ID of the project DNS zone is created * for, sets `X-Auth-Sudo-Tenant-ID` header (requires an assigned * user role in target project). */ projectId?: 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. */ region?: pulumi.Input<string>; /** * The time to live (TTL) of the zone. */ ttl?: pulumi.Input<number>; /** * The type of zone. Can either be `PRIMARY` or `SECONDARY`. * Changing this creates a new zone. */ type?: pulumi.Input<string>; /** * Map of additional options. Changing this creates a * new zone. */ valueSpecs?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; } /** * The set of arguments for constructing a Zone resource. */ export interface ZoneArgs { /** * Attributes for the DNS Service scheduler. * Changing this creates a new zone. */ attributes?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * A description of the zone. */ 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>; /** * The email contact for the zone record. */ email?: pulumi.Input<string>; /** * An array of master DNS servers. For when `type` is * `SECONDARY`. */ masters?: pulumi.Input<pulumi.Input<string>[]>; /** * The name of the zone. Note the `.` at the end of the name. * Changing this creates a new DNS zone. */ name?: pulumi.Input<string>; /** * The ID of the project DNS zone is created * for, sets `X-Auth-Sudo-Tenant-ID` header (requires an assigned * user role in target project). */ projectId?: 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. */ region?: pulumi.Input<string>; /** * The time to live (TTL) of the zone. */ ttl?: pulumi.Input<number>; /** * The type of zone. Can either be `PRIMARY` or `SECONDARY`. * Changing this creates a new zone. */ type?: pulumi.Input<string>; /** * Map of additional options. Changing this creates a * new zone. */ valueSpecs?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; }