Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. ApigwEnvironmentV2
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.ApigwEnvironmentV2

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

    Up-to-date reference of API arguments for API Gateway environment service you can get at documentation portal

    API Gateway (APIGW) is a high-performance, high-availability, and high-security API hosting service that helps you build, manage, and deploy APIs at any scale. With just a few clicks, you can integrate internal systems, and selectively expose capabilities with minimal costs and risks.

    Example Usage

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const environmentName = config.requireObject("environmentName");
const description = config.requireObject("description");
const test = new opentelekomcloud.ApigwEnvironmentV2("test", {
    instanceId: instanceId,
    description: description,
});

    import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

config = pulumi.Config()
instance_id = config.require_object("instanceId")
environment_name = config.require_object("environmentName")
description = config.require_object("description")
test = opentelekomcloud.ApigwEnvironmentV2("test",
    instance_id=instance_id,
    description=description)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		environmentName := cfg.RequireObject("environmentName")
		description := cfg.RequireObject("description")
		_, err := opentelekomcloud.NewApigwEnvironmentV2(ctx, "test", &opentelekomcloud.ApigwEnvironmentV2Args{
			InstanceId:  pulumi.Any(instanceId),
			Description: pulumi.Any(description),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var environmentName = config.RequireObject<dynamic>("environmentName");
    var description = config.RequireObject<dynamic>("description");
    var test = new Opentelekomcloud.ApigwEnvironmentV2("test", new()
    {
        InstanceId = instanceId,
        Description = description,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ApigwEnvironmentV2;
import com.pulumi.opentelekomcloud.ApigwEnvironmentV2Args;
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) {
        final var config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var environmentName = config.get("environmentName");
        final var description = config.get("description");
        var test = new ApigwEnvironmentV2("test", ApigwEnvironmentV2Args.builder()
            .instanceId(instanceId)
            .description(description)
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
  environmentName:
    type: dynamic
  description:
    type: dynamic
resources:
  test:
    type: opentelekomcloud:ApigwEnvironmentV2
    properties:
      instanceId: ${instanceId}
      description: ${description}

    Create ApigwEnvironmentV2 Resource

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

    Constructor syntax

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

@overload
def ApigwEnvironmentV2(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       instance_id: Optional[str] = None,
                       apigw_environment_v2_id: Optional[str] = None,
                       description: Optional[str] = None,
                       name: Optional[str] = None,
                       region: Optional[str] = None)
    func NewApigwEnvironmentV2(ctx *Context, name string, args ApigwEnvironmentV2Args, opts ...ResourceOption) (*ApigwEnvironmentV2, error)
    public ApigwEnvironmentV2(string name, ApigwEnvironmentV2Args args, CustomResourceOptions? opts = null)
    public ApigwEnvironmentV2(String name, ApigwEnvironmentV2Args args)
public ApigwEnvironmentV2(String name, ApigwEnvironmentV2Args args, CustomResourceOptions options)

    type: opentelekomcloud:ApigwEnvironmentV2
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 ApigwEnvironmentV2Args
    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 ApigwEnvironmentV2Args
    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 ApigwEnvironmentV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigwEnvironmentV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigwEnvironmentV2Args
    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 apigwEnvironmentV2Resource = new Opentelekomcloud.ApigwEnvironmentV2("apigwEnvironmentV2Resource", new()
{
    InstanceId = "string",
    ApigwEnvironmentV2Id = "string",
    Description = "string",
    Name = "string",
    Region = "string",
});

    example, err := opentelekomcloud.NewApigwEnvironmentV2(ctx, "apigwEnvironmentV2Resource", &opentelekomcloud.ApigwEnvironmentV2Args{
	InstanceId:           pulumi.String("string"),
	ApigwEnvironmentV2Id: pulumi.String("string"),
	Description:          pulumi.String("string"),
	Name:                 pulumi.String("string"),
	Region:               pulumi.String("string"),
})

    var apigwEnvironmentV2Resource = new ApigwEnvironmentV2("apigwEnvironmentV2Resource", ApigwEnvironmentV2Args.builder()
    .instanceId("string")
    .apigwEnvironmentV2Id("string")
    .description("string")
    .name("string")
    .region("string")
    .build());

    apigw_environment_v2_resource = opentelekomcloud.ApigwEnvironmentV2("apigwEnvironmentV2Resource",
    instance_id="string",
    apigw_environment_v2_id="string",
    description="string",
    name="string",
    region="string")

    const apigwEnvironmentV2Resource = new opentelekomcloud.ApigwEnvironmentV2("apigwEnvironmentV2Resource", {
    instanceId: "string",
    apigwEnvironmentV2Id: "string",
    description: "string",
    name: "string",
    region: "string",
});

    type: opentelekomcloud:ApigwEnvironmentV2
properties:
    apigwEnvironmentV2Id: string
    description: string
    instanceId: string
    name: string
    region: string

    ApigwEnvironmentV2 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 ApigwEnvironmentV2 resource accepts the following input properties:

    InstanceId string
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    ApigwEnvironmentV2Id string
    The ID of the dedicated environment.
    Description string
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    Name string
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    Region string
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    InstanceId string
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    ApigwEnvironmentV2Id string
    The ID of the dedicated environment.
    Description string
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    Name string
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    Region string
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    instanceId String
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    apigwEnvironmentV2Id String
    The ID of the dedicated environment.
    description String
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    name String
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    region String
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    instanceId string
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    apigwEnvironmentV2Id string
    The ID of the dedicated environment.
    description string
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    name string
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    region string
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    instance_id str
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    apigw_environment_v2_id str
    The ID of the dedicated environment.
    description str
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    name str
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    region str
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    instanceId String
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    apigwEnvironmentV2Id String
    The ID of the dedicated environment.
    description String
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    name String
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    region String
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.

    Outputs

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

    CreatedAt string
    The time when the environment was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt string
    The time when the environment was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The time when the environment was created.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt string
    The time when the environment was created.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at str
    The time when the environment was created.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The time when the environment was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApigwEnvironmentV2 Resource

    Get an existing ApigwEnvironmentV2 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?: ApigwEnvironmentV2State, opts?: CustomResourceOptions): ApigwEnvironmentV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apigw_environment_v2_id: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None) -> ApigwEnvironmentV2
    func GetApigwEnvironmentV2(ctx *Context, name string, id IDInput, state *ApigwEnvironmentV2State, opts ...ResourceOption) (*ApigwEnvironmentV2, error)
    public static ApigwEnvironmentV2 Get(string name, Input<string> id, ApigwEnvironmentV2State? state, CustomResourceOptions? opts = null)
    public static ApigwEnvironmentV2 get(String name, Output<String> id, ApigwEnvironmentV2State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:ApigwEnvironmentV2    get:      id: ${id}
    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:
    ApigwEnvironmentV2Id string
    The ID of the dedicated environment.
    CreatedAt string
    The time when the environment was created.
    Description string
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    InstanceId string
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    Name string
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    Region string
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    ApigwEnvironmentV2Id string
    The ID of the dedicated environment.
    CreatedAt string
    The time when the environment was created.
    Description string
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    InstanceId string
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    Name string
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    Region string
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apigwEnvironmentV2Id String
    The ID of the dedicated environment.
    createdAt String
    The time when the environment was created.
    description String
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    instanceId String
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    name String
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    region String
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apigwEnvironmentV2Id string
    The ID of the dedicated environment.
    createdAt string
    The time when the environment was created.
    description string
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    instanceId string
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    name string
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    region string
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apigw_environment_v2_id str
    The ID of the dedicated environment.
    created_at str
    The time when the environment was created.
    description str
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    instance_id str
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    name str
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    region str
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apigwEnvironmentV2Id String
    The ID of the dedicated environment.
    createdAt String
    The time when the environment was created.
    description String
    Specifies the environment description. The value can contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    instanceId String
    Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.
    name String
    Specifies the environment name. The valid length is limited from 3 to 64, only letters, digits and underscores (_) are allowed. The name must start with a letter.
    region String
    Specifies the region where the dedicated instance is located. If omitted, the provider-level region will be used. Changing this will create a new resource.

    Import

    Environments can be imported using their name and the ID of the related dedicated instance, separated by a slash, e.g.

    $ pulumi import opentelekomcloud:index/apigwEnvironmentV2:ApigwEnvironmentV2 test instance_id/name

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

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
    opentelekomcloud/terraform-provider-opentelekomcloud