Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigEnvironment
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.ApigEnvironment

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manages an APIG environment resource within FlexibleEngine.

    Example Usage

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

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

    import pulumi
import pulumi_flexibleengine as flexibleengine

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

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"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 := flexibleengine.NewApigEnvironment(ctx, "test", &flexibleengine.ApigEnvironmentArgs{
			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 Flexibleengine = Pulumi.Flexibleengine;

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 Flexibleengine.ApigEnvironment("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.flexibleengine.ApigEnvironment;
import com.pulumi.flexibleengine.ApigEnvironmentArgs;
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 ApigEnvironment("test", ApigEnvironmentArgs.builder()
            .instanceId(instanceId)
            .description(description)
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
  environmentName:
    type: dynamic
  description:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigEnvironment
    properties:
      instanceId: ${instanceId}
      description: ${description}

    Create ApigEnvironment Resource

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

    Constructor syntax

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

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

    type: flexibleengine:ApigEnvironment
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 ApigEnvironmentArgs
    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 ApigEnvironmentArgs
    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 ApigEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigEnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigEnvironmentArgs
    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 apigEnvironmentResource = new Flexibleengine.ApigEnvironment("apigEnvironmentResource", new()
{
    InstanceId = "string",
    ApigEnvironmentId = "string",
    Description = "string",
    Name = "string",
    Region = "string",
});

    example, err := flexibleengine.NewApigEnvironment(ctx, "apigEnvironmentResource", &flexibleengine.ApigEnvironmentArgs{
	InstanceId:        pulumi.String("string"),
	ApigEnvironmentId: pulumi.String("string"),
	Description:       pulumi.String("string"),
	Name:              pulumi.String("string"),
	Region:            pulumi.String("string"),
})

    var apigEnvironmentResource = new ApigEnvironment("apigEnvironmentResource", ApigEnvironmentArgs.builder()
    .instanceId("string")
    .apigEnvironmentId("string")
    .description("string")
    .name("string")
    .region("string")
    .build());

    apig_environment_resource = flexibleengine.ApigEnvironment("apigEnvironmentResource",
    instance_id="string",
    apig_environment_id="string",
    description="string",
    name="string",
    region="string")

    const apigEnvironmentResource = new flexibleengine.ApigEnvironment("apigEnvironmentResource", {
    instanceId: "string",
    apigEnvironmentId: "string",
    description: "string",
    name: "string",
    region: "string",
});

    type: flexibleengine:ApigEnvironment
properties:
    apigEnvironmentId: string
    description: string
    instanceId: string
    name: string
    region: string

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

    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    ApigEnvironmentId string
    ID of the APIG environment.
    Description string
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    Name string
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    ApigEnvironmentId string
    ID of the APIG environment.
    Description string
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    Name string
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    apigEnvironmentId String
    ID of the APIG environment.
    description String
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    name String
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region String
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    instanceId string
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    apigEnvironmentId string
    ID of the APIG environment.
    description string
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    name string
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region string
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    instance_id str
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    apig_environment_id str
    ID of the APIG environment.
    description str
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    name str
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region str
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    apigEnvironmentId String
    ID of the APIG environment.
    description String
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    name String
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region String
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.

    Outputs

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

    CreateTime string
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    CreatedAt string
    The time when the environment was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreateTime string
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    CreatedAt string
    The time when the environment was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    createTime String
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    createdAt String
    The time when the environment was created.
    id String
    The provider-assigned unique ID for this managed resource.
    createTime string
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    createdAt string
    The time when the environment was created.
    id string
    The provider-assigned unique ID for this managed resource.
    create_time str
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    created_at str
    The time when the environment was created.
    id str
    The provider-assigned unique ID for this managed resource.
    createTime String
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

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

    Look up Existing ApigEnvironment Resource

    Get an existing ApigEnvironment 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?: ApigEnvironmentState, opts?: CustomResourceOptions): ApigEnvironment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apig_environment_id: Optional[str] = None,
        create_time: 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) -> ApigEnvironment
    func GetApigEnvironment(ctx *Context, name string, id IDInput, state *ApigEnvironmentState, opts ...ResourceOption) (*ApigEnvironment, error)
    public static ApigEnvironment Get(string name, Input<string> id, ApigEnvironmentState? state, CustomResourceOptions? opts = null)
    public static ApigEnvironment get(String name, Output<String> id, ApigEnvironmentState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApigEnvironment    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:
    ApigEnvironmentId string
    ID of the APIG environment.
    CreateTime string
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    CreatedAt string
    The time when the environment was created.
    Description string
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    Name string
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    ApigEnvironmentId string
    ID of the APIG environment.
    CreateTime string
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    CreatedAt string
    The time when the environment was created.
    Description string
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    Name string
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    apigEnvironmentId String
    ID of the APIG environment.
    createTime String
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    createdAt String
    The time when the environment was created.
    description String
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    name String
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region String
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    apigEnvironmentId string
    ID of the APIG environment.
    createTime string
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    createdAt string
    The time when the environment was created.
    description string
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    instanceId string
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    name string
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region string
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    apig_environment_id str
    ID of the APIG environment.
    create_time str
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    created_at str
    The time when the environment was created.
    description str
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    instance_id str
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    name str
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region str
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.
    apigEnvironmentId String
    ID of the APIG environment.
    createTime String
    schema: Deprecated; The time when the environment was created.

    Deprecated: Deprecated

    createdAt String
    The time when the environment was created.
    description String
    Specifies the description about the API environment. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API environment belongs to. Changing this will create a new APIG environment resource.
    name String
    Specifies the name of the API environment. The API environment name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region String
    Specifies the region in which to create the APIG environment resource. If omitted, the provider-level region will be used. Changing this will create a new APIG environment resource.

    Import

    Environments can be imported using the ID of the APIG instance to which the environment belongs and environment ID,

    separated by a slash, e.g.

    $ pulumi import flexibleengine:index/apigEnvironment:ApigEnvironment test <instance_id>/<id>

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine