@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
189 lines (188 loc) • 7 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 private zone
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.private_zone.PrivateZone("foo", {
* intelligentMode: true,
* loadBalanceMode: true,
* projectName: "default",
* recursionMode: true,
* remark: "acc-test-new",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* vpcs: [
* {
* vpcId: "vpc-rs4mi0jedipsv0x57pf****",
* },
* {
* region: "cn-shanghai",
* vpcId: "vpc-3qdzk9xju6o747prml0jk****",
* },
* ],
* zoneName: "acc-test-pz.com",
* });
* ```
*
* ## Import
*
* PrivateZone can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:private_zone/privateZone:PrivateZone default resource_id
* ```
*/
export declare class PrivateZone extends pulumi.CustomResource {
/**
* Get an existing PrivateZone 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?: PrivateZoneState, opts?: pulumi.CustomResourceOptions): PrivateZone;
/**
* Returns true if the given object is an instance of PrivateZone. 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 PrivateZone;
/**
* Whether to enable the intelligent mode of the private zone.
*/
readonly intelligentMode: pulumi.Output<boolean | undefined>;
/**
* Whether to enable the load balance mode of the private zone.
*/
readonly loadBalanceMode: pulumi.Output<boolean | undefined>;
/**
* The project name of the private zone.
*/
readonly projectName: pulumi.Output<string>;
/**
* Whether to enable the recursion mode of the private zone.
*/
readonly recursionMode: pulumi.Output<boolean | undefined>;
/**
* The remark of the private zone.
*/
readonly remark: pulumi.Output<string | undefined>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.private_zone.PrivateZoneTag[] | undefined>;
/**
* The vpc trns of the private zone. Format: trn:vpc:region:accountId:vpc/vpcId. This field is only effected when creating resource.
* When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly vpcTrns: pulumi.Output<string[] | undefined>;
/**
* The bind vpc object of the private zone. If you want to bind another account's VPC, you need to first use resource volcengine.private_zone.UserVpcAuthorization to complete the authorization.
*/
readonly vpcs: pulumi.Output<outputs.private_zone.PrivateZoneVpc[]>;
/**
* The name of the private zone.
*/
readonly zoneName: pulumi.Output<string>;
/**
* Create a PrivateZone 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: PrivateZoneArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PrivateZone resources.
*/
export interface PrivateZoneState {
/**
* Whether to enable the intelligent mode of the private zone.
*/
intelligentMode?: pulumi.Input<boolean>;
/**
* Whether to enable the load balance mode of the private zone.
*/
loadBalanceMode?: pulumi.Input<boolean>;
/**
* The project name of the private zone.
*/
projectName?: pulumi.Input<string>;
/**
* Whether to enable the recursion mode of the private zone.
*/
recursionMode?: pulumi.Input<boolean>;
/**
* The remark of the private zone.
*/
remark?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.private_zone.PrivateZoneTag>[]>;
/**
* The vpc trns of the private zone. Format: trn:vpc:region:accountId:vpc/vpcId. This field is only effected when creating resource.
* When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
vpcTrns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The bind vpc object of the private zone. If you want to bind another account's VPC, you need to first use resource volcengine.private_zone.UserVpcAuthorization to complete the authorization.
*/
vpcs?: pulumi.Input<pulumi.Input<inputs.private_zone.PrivateZoneVpc>[]>;
/**
* The name of the private zone.
*/
zoneName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a PrivateZone resource.
*/
export interface PrivateZoneArgs {
/**
* Whether to enable the intelligent mode of the private zone.
*/
intelligentMode?: pulumi.Input<boolean>;
/**
* Whether to enable the load balance mode of the private zone.
*/
loadBalanceMode?: pulumi.Input<boolean>;
/**
* The project name of the private zone.
*/
projectName?: pulumi.Input<string>;
/**
* Whether to enable the recursion mode of the private zone.
*/
recursionMode?: pulumi.Input<boolean>;
/**
* The remark of the private zone.
*/
remark?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.private_zone.PrivateZoneTag>[]>;
/**
* The vpc trns of the private zone. Format: trn:vpc:region:accountId:vpc/vpcId. This field is only effected when creating resource.
* When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
vpcTrns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The bind vpc object of the private zone. If you want to bind another account's VPC, you need to first use resource volcengine.private_zone.UserVpcAuthorization to complete the authorization.
*/
vpcs: pulumi.Input<pulumi.Input<inputs.private_zone.PrivateZoneVpc>[]>;
/**
* The name of the private zone.
*/
zoneName: pulumi.Input<string>;
}