Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. private_zone
  5. PrivateZone
Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.private_zone.PrivateZone

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage private zone

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Private_zone.PrivateZone("foo", new()
    {
        IntelligentMode = true,
        LoadBalanceMode = true,
        RecursionMode = true,
        Remark = "acc-test-new",
        Vpcs = new[]
        {
            new Volcengine.Private_zone.Inputs.PrivateZoneVpcArgs
            {
                VpcId = "vpc-rs4mi0jedipsv0x57pf****",
            },
            new Volcengine.Private_zone.Inputs.PrivateZoneVpcArgs
            {
                Region = "cn-shanghai",
                VpcId = "vpc-3qdzk9xju6o747prml0jk****",
            },
        },
        ZoneName = "acc-test-pz.com",
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/private_zone"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := private_zone.NewPrivateZone(ctx, "foo", &private_zone.PrivateZoneArgs{
			IntelligentMode: pulumi.Bool(true),
			LoadBalanceMode: pulumi.Bool(true),
			RecursionMode:   pulumi.Bool(true),
			Remark:          pulumi.String("acc-test-new"),
			Vpcs: private_zone.PrivateZoneVpcArray{
				&private_zone.PrivateZoneVpcArgs{
					VpcId: pulumi.String("vpc-rs4mi0jedipsv0x57pf****"),
				},
				&private_zone.PrivateZoneVpcArgs{
					Region: pulumi.String("cn-shanghai"),
					VpcId:  pulumi.String("vpc-3qdzk9xju6o747prml0jk****"),
				},
			},
			ZoneName: pulumi.String("acc-test-pz.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.private_zone.PrivateZone;
import com.pulumi.volcengine.private_zone.PrivateZoneArgs;
import com.pulumi.volcengine.private_zone.inputs.PrivateZoneVpcArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new PrivateZone("foo", PrivateZoneArgs.builder()        
            .intelligentMode(true)
            .loadBalanceMode(true)
            .recursionMode(true)
            .remark("acc-test-new")
            .vpcs(            
                PrivateZoneVpcArgs.builder()
                    .vpcId("vpc-rs4mi0jedipsv0x57pf****")
                    .build(),
                PrivateZoneVpcArgs.builder()
                    .region("cn-shanghai")
                    .vpcId("vpc-3qdzk9xju6o747prml0jk****")
                    .build())
            .zoneName("acc-test-pz.com")
            .build());

    }
}

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.private_zone.PrivateZone("foo",
    intelligent_mode=True,
    load_balance_mode=True,
    recursion_mode=True,
    remark="acc-test-new",
    vpcs=[
        volcengine.private_zone.PrivateZoneVpcArgs(
            vpc_id="vpc-rs4mi0jedipsv0x57pf****",
        ),
        volcengine.private_zone.PrivateZoneVpcArgs(
            region="cn-shanghai",
            vpc_id="vpc-3qdzk9xju6o747prml0jk****",
        ),
    ],
    zone_name="acc-test-pz.com")

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";

const foo = new volcengine.private_zone.PrivateZone("foo", {
    intelligentMode: true,
    loadBalanceMode: true,
    recursionMode: true,
    remark: "acc-test-new",
    vpcs: [
        {
            vpcId: "vpc-rs4mi0jedipsv0x57pf****",
        },
        {
            region: "cn-shanghai",
            vpcId: "vpc-3qdzk9xju6o747prml0jk****",
        },
    ],
    zoneName: "acc-test-pz.com",
});

    resources:
  foo:
    type: volcengine:private_zone:PrivateZone
    properties:
      intelligentMode: true
      loadBalanceMode: true
      recursionMode: true
      remark: acc-test-new
      vpcs:
        - vpcId: vpc-rs4mi0jedipsv0x57pf****
        - region: cn-shanghai
          vpcId: vpc-3qdzk9xju6o747prml0jk****
      zoneName: acc-test-pz.com

    Create PrivateZone Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivateZone(name: string, args: PrivateZoneArgs, opts?: CustomResourceOptions);
    @overload
def PrivateZone(resource_name: str,
                args: PrivateZoneArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def PrivateZone(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                vpcs: Optional[Sequence[PrivateZoneVpcArgs]] = None,
                zone_name: Optional[str] = None,
                intelligent_mode: Optional[bool] = None,
                load_balance_mode: Optional[bool] = None,
                recursion_mode: Optional[bool] = None,
                remark: Optional[str] = None)
    func NewPrivateZone(ctx *Context, name string, args PrivateZoneArgs, opts ...ResourceOption) (*PrivateZone, error)
    public PrivateZone(string name, PrivateZoneArgs args, CustomResourceOptions? opts = null)
    public PrivateZone(String name, PrivateZoneArgs args)
public PrivateZone(String name, PrivateZoneArgs args, CustomResourceOptions options)

    type: volcengine:private_zone:PrivateZone
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PrivateZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivateZoneArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivateZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateZoneArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var privateZoneResource = new Volcengine.Private_zone.PrivateZone("privateZoneResource", new()
{
    Vpcs = new[]
    {
        new Volcengine.Private_zone.Inputs.PrivateZoneVpcArgs
        {
            VpcId = "string",
            Region = "string",
        },
    },
    ZoneName = "string",
    IntelligentMode = false,
    LoadBalanceMode = false,
    RecursionMode = false,
    Remark = "string",
});

    example, err := private_zone.NewPrivateZone(ctx, "privateZoneResource", &private_zone.PrivateZoneArgs{
	Vpcs: private_zone.PrivateZoneVpcArray{
		&private_zone.PrivateZoneVpcArgs{
			VpcId:  pulumi.String("string"),
			Region: pulumi.String("string"),
		},
	},
	ZoneName:        pulumi.String("string"),
	IntelligentMode: pulumi.Bool(false),
	LoadBalanceMode: pulumi.Bool(false),
	RecursionMode:   pulumi.Bool(false),
	Remark:          pulumi.String("string"),
})

    var privateZoneResource = new PrivateZone("privateZoneResource", PrivateZoneArgs.builder()
    .vpcs(PrivateZoneVpcArgs.builder()
        .vpcId("string")
        .region("string")
        .build())
    .zoneName("string")
    .intelligentMode(false)
    .loadBalanceMode(false)
    .recursionMode(false)
    .remark("string")
    .build());

    private_zone_resource = volcengine.private_zone.PrivateZone("privateZoneResource",
    vpcs=[{
        "vpc_id": "string",
        "region": "string",
    }],
    zone_name="string",
    intelligent_mode=False,
    load_balance_mode=False,
    recursion_mode=False,
    remark="string")

    const privateZoneResource = new volcengine.private_zone.PrivateZone("privateZoneResource", {
    vpcs: [{
        vpcId: "string",
        region: "string",
    }],
    zoneName: "string",
    intelligentMode: false,
    loadBalanceMode: false,
    recursionMode: false,
    remark: "string",
});

    type: volcengine:private_zone:PrivateZone
properties:
    intelligentMode: false
    loadBalanceMode: false
    recursionMode: false
    remark: string
    vpcs:
        - region: string
          vpcId: string
    zoneName: string

    PrivateZone Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PrivateZone resource accepts the following input properties:

    Vpcs List<PrivateZoneVpc>
    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.
    ZoneName string
    The name of the private zone.
    IntelligentMode bool
    Whether to enable the intelligent mode of the private zone.
    LoadBalanceMode bool
    Whether to enable the load balance mode of the private zone.
    RecursionMode bool
    Whether to enable the recursion mode of the private zone.
    Remark string
    The remark of the private zone.
    Vpcs []PrivateZoneVpcArgs
    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.
    ZoneName string
    The name of the private zone.
    IntelligentMode bool
    Whether to enable the intelligent mode of the private zone.
    LoadBalanceMode bool
    Whether to enable the load balance mode of the private zone.
    RecursionMode bool
    Whether to enable the recursion mode of the private zone.
    Remark string
    The remark of the private zone.
    vpcs List<PrivateZoneVpc>
    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.
    zoneName String
    The name of the private zone.
    intelligentMode Boolean
    Whether to enable the intelligent mode of the private zone.
    loadBalanceMode Boolean
    Whether to enable the load balance mode of the private zone.
    recursionMode Boolean
    Whether to enable the recursion mode of the private zone.
    remark String
    The remark of the private zone.
    vpcs PrivateZoneVpc[]
    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.
    zoneName string
    The name of the private zone.
    intelligentMode boolean
    Whether to enable the intelligent mode of the private zone.
    loadBalanceMode boolean
    Whether to enable the load balance mode of the private zone.
    recursionMode boolean
    Whether to enable the recursion mode of the private zone.
    remark string
    The remark of the private zone.
    vpcs Sequence[PrivateZoneVpcArgs]
    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.
    zone_name str
    The name of the private zone.
    intelligent_mode bool
    Whether to enable the intelligent mode of the private zone.
    load_balance_mode bool
    Whether to enable the load balance mode of the private zone.
    recursion_mode bool
    Whether to enable the recursion mode of the private zone.
    remark str
    The remark of the private zone.
    vpcs List<Property Map>
    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.
    zoneName String
    The name of the private zone.
    intelligentMode Boolean
    Whether to enable the intelligent mode of the private zone.
    loadBalanceMode Boolean
    Whether to enable the load balance mode of the private zone.
    recursionMode Boolean
    Whether to enable the recursion mode of the private zone.
    remark String
    The remark of the private zone.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateZone resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PrivateZone Resource

    Get an existing PrivateZone resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PrivateZoneState, opts?: CustomResourceOptions): PrivateZone
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        intelligent_mode: Optional[bool] = None,
        load_balance_mode: Optional[bool] = None,
        recursion_mode: Optional[bool] = None,
        remark: Optional[str] = None,
        vpcs: Optional[Sequence[PrivateZoneVpcArgs]] = None,
        zone_name: Optional[str] = None) -> PrivateZone
    func GetPrivateZone(ctx *Context, name string, id IDInput, state *PrivateZoneState, opts ...ResourceOption) (*PrivateZone, error)
    public static PrivateZone Get(string name, Input<string> id, PrivateZoneState? state, CustomResourceOptions? opts = null)
    public static PrivateZone get(String name, Output<String> id, PrivateZoneState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    IntelligentMode bool
    Whether to enable the intelligent mode of the private zone.
    LoadBalanceMode bool
    Whether to enable the load balance mode of the private zone.
    RecursionMode bool
    Whether to enable the recursion mode of the private zone.
    Remark string
    The remark of the private zone.
    Vpcs List<PrivateZoneVpc>
    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.
    ZoneName string
    The name of the private zone.
    IntelligentMode bool
    Whether to enable the intelligent mode of the private zone.
    LoadBalanceMode bool
    Whether to enable the load balance mode of the private zone.
    RecursionMode bool
    Whether to enable the recursion mode of the private zone.
    Remark string
    The remark of the private zone.
    Vpcs []PrivateZoneVpcArgs
    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.
    ZoneName string
    The name of the private zone.
    intelligentMode Boolean
    Whether to enable the intelligent mode of the private zone.
    loadBalanceMode Boolean
    Whether to enable the load balance mode of the private zone.
    recursionMode Boolean
    Whether to enable the recursion mode of the private zone.
    remark String
    The remark of the private zone.
    vpcs List<PrivateZoneVpc>
    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.
    zoneName String
    The name of the private zone.
    intelligentMode boolean
    Whether to enable the intelligent mode of the private zone.
    loadBalanceMode boolean
    Whether to enable the load balance mode of the private zone.
    recursionMode boolean
    Whether to enable the recursion mode of the private zone.
    remark string
    The remark of the private zone.
    vpcs PrivateZoneVpc[]
    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.
    zoneName string
    The name of the private zone.
    intelligent_mode bool
    Whether to enable the intelligent mode of the private zone.
    load_balance_mode bool
    Whether to enable the load balance mode of the private zone.
    recursion_mode bool
    Whether to enable the recursion mode of the private zone.
    remark str
    The remark of the private zone.
    vpcs Sequence[PrivateZoneVpcArgs]
    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.
    zone_name str
    The name of the private zone.
    intelligentMode Boolean
    Whether to enable the intelligent mode of the private zone.
    loadBalanceMode Boolean
    Whether to enable the load balance mode of the private zone.
    recursionMode Boolean
    Whether to enable the recursion mode of the private zone.
    remark String
    The remark of the private zone.
    vpcs List<Property Map>
    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.
    zoneName String
    The name of the private zone.

    Supporting Types

    PrivateZoneVpc, PrivateZoneVpcArgs

    VpcId string
    The id of the bind vpc.
    Region string
    The region of the bind vpc. The default value is the region of the default provider config.
    VpcId string
    The id of the bind vpc.
    Region string
    The region of the bind vpc. The default value is the region of the default provider config.
    vpcId String
    The id of the bind vpc.
    region String
    The region of the bind vpc. The default value is the region of the default provider config.
    vpcId string
    The id of the bind vpc.
    region string
    The region of the bind vpc. The default value is the region of the default provider config.
    vpc_id str
    The id of the bind vpc.
    region str
    The region of the bind vpc. The default value is the region of the default provider config.
    vpcId String
    The id of the bind vpc.
    region String
    The region of the bind vpc. The default value is the region of the default provider config.

    Import

    PrivateZone can be imported using the id, e.g.

     $ pulumi import volcengine:private_zone/privateZone:PrivateZone default resource_id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
    volcengine/pulumi-volcengine