@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
226 lines (225 loc) • 7.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage dns zone
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.dns.Zone("foo", {
* projectName: "default",
* remark: "xxx",
* tags: [{
* key: "xx",
* value: "xx",
* }],
* zoneName: "xxxx.com",
* });
* ```
*
* ## Import
*
* Zone can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:dns/zone:Zone default resource_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;
/**
* The list of DNS servers allocated to the domain by BytePlus DNS.
*/
readonly allocateDnsServerLists: pulumi.Output<string[]>;
/**
* Whether automatic domain renewal is enabled.
*/
readonly autoRenew: pulumi.Output<boolean>;
/**
* The version of DNS DDoS protection service.
*/
readonly dnsSecurity: pulumi.Output<string>;
/**
* The expiration time of the domain.
*/
readonly expiredTime: pulumi.Output<number>;
/**
* The ID of the instance. For free edition, the value of this field is null.
*/
readonly instanceNo: pulumi.Output<string>;
/**
* Indicates whether the configuration of NS servers is correct. If the configuration is correct, the status of the domain in BytePlus DNS is Active.
*/
readonly isNsCorrect: pulumi.Output<boolean>;
/**
* Whether the domain is a subdomain.
*/
readonly isSubDomain: pulumi.Output<boolean>;
/**
* The project to which the domain name belongs. The default value is default.
*/
readonly projectName: pulumi.Output<string>;
/**
* The list of DNS servers actually used by the domain.
*/
readonly realDnsServerLists: pulumi.Output<string[]>;
/**
* The total number of DNS records under the domain.
*/
readonly recordCount: pulumi.Output<number>;
/**
* The remark for the domain.
*/
readonly remark: pulumi.Output<string | undefined>;
/**
* The status of the domain.
*/
readonly stage: pulumi.Output<number>;
/**
* The domain prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
*/
readonly subDomainHost: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.dns.ZoneTag[] | undefined>;
/**
* The edition of the domain.
*/
readonly tradeCode: pulumi.Output<string>;
/**
* The update time of the domain.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The ID of the domain.
*/
readonly zid: pulumi.Output<number>;
/**
* The domain to be created. The domain must be a second-level domain and cannot be a wildcard domain.
*/
readonly zoneName: pulumi.Output<string>;
/**
* 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 {
/**
* The list of DNS servers allocated to the domain by BytePlus DNS.
*/
allocateDnsServerLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Whether automatic domain renewal is enabled.
*/
autoRenew?: pulumi.Input<boolean>;
/**
* The version of DNS DDoS protection service.
*/
dnsSecurity?: pulumi.Input<string>;
/**
* The expiration time of the domain.
*/
expiredTime?: pulumi.Input<number>;
/**
* The ID of the instance. For free edition, the value of this field is null.
*/
instanceNo?: pulumi.Input<string>;
/**
* Indicates whether the configuration of NS servers is correct. If the configuration is correct, the status of the domain in BytePlus DNS is Active.
*/
isNsCorrect?: pulumi.Input<boolean>;
/**
* Whether the domain is a subdomain.
*/
isSubDomain?: pulumi.Input<boolean>;
/**
* The project to which the domain name belongs. The default value is default.
*/
projectName?: pulumi.Input<string>;
/**
* The list of DNS servers actually used by the domain.
*/
realDnsServerLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The total number of DNS records under the domain.
*/
recordCount?: pulumi.Input<number>;
/**
* The remark for the domain.
*/
remark?: pulumi.Input<string>;
/**
* The status of the domain.
*/
stage?: pulumi.Input<number>;
/**
* The domain prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
*/
subDomainHost?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.dns.ZoneTag>[]>;
/**
* The edition of the domain.
*/
tradeCode?: pulumi.Input<string>;
/**
* The update time of the domain.
*/
updatedAt?: pulumi.Input<string>;
/**
* The ID of the domain.
*/
zid?: pulumi.Input<number>;
/**
* The domain to be created. The domain must be a second-level domain and cannot be a wildcard domain.
*/
zoneName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Zone resource.
*/
export interface ZoneArgs {
/**
* The project to which the domain name belongs. The default value is default.
*/
projectName?: pulumi.Input<string>;
/**
* The remark for the domain.
*/
remark?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.dns.ZoneTag>[]>;
/**
* The domain to be created. The domain must be a second-level domain and cannot be a wildcard domain.
*/
zoneName: pulumi.Input<string>;
}