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

flexibleengine.ApiGatewayEnvironment

Explore with Pulumi AI

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

    Manages a shared APIG environment resource within FlexibleEngine.

    Example Usage

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

const testEnv = new flexibleengine.ApiGatewayEnvironment("testEnv", {description: "test env"});

    import pulumi
import pulumi_flexibleengine as flexibleengine

test_env = flexibleengine.ApiGatewayEnvironment("testEnv", description="test env")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := flexibleengine.NewApiGatewayEnvironment(ctx, "testEnv", &flexibleengine.ApiGatewayEnvironmentArgs{
			Description: pulumi.String("test env"),
		})
		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 testEnv = new Flexibleengine.ApiGatewayEnvironment("testEnv", new()
    {
        Description = "test env",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApiGatewayEnvironment;
import com.pulumi.flexibleengine.ApiGatewayEnvironmentArgs;
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 testEnv = new ApiGatewayEnvironment("testEnv", ApiGatewayEnvironmentArgs.builder()
            .description("test env")
            .build());

    }
}

    resources:
  testEnv:
    type: flexibleengine:ApiGatewayEnvironment
    properties:
      description: test env

    Create ApiGatewayEnvironment Resource

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

    Constructor syntax

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

@overload
def ApiGatewayEnvironment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          api_gateway_environment_id: Optional[str] = None,
                          description: Optional[str] = None,
                          name: Optional[str] = None,
                          region: Optional[str] = None)
    func NewApiGatewayEnvironment(ctx *Context, name string, args *ApiGatewayEnvironmentArgs, opts ...ResourceOption) (*ApiGatewayEnvironment, error)
    public ApiGatewayEnvironment(string name, ApiGatewayEnvironmentArgs? args = null, CustomResourceOptions? opts = null)
    public ApiGatewayEnvironment(String name, ApiGatewayEnvironmentArgs args)
public ApiGatewayEnvironment(String name, ApiGatewayEnvironmentArgs args, CustomResourceOptions options)

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

    example, err := flexibleengine.NewApiGatewayEnvironment(ctx, "apiGatewayEnvironmentResource", &flexibleengine.ApiGatewayEnvironmentArgs{
	ApiGatewayEnvironmentId: pulumi.String("string"),
	Description:             pulumi.String("string"),
	Name:                    pulumi.String("string"),
	Region:                  pulumi.String("string"),
})

    var apiGatewayEnvironmentResource = new ApiGatewayEnvironment("apiGatewayEnvironmentResource", ApiGatewayEnvironmentArgs.builder()
    .apiGatewayEnvironmentId("string")
    .description("string")
    .name("string")
    .region("string")
    .build());

    api_gateway_environment_resource = flexibleengine.ApiGatewayEnvironment("apiGatewayEnvironmentResource",
    api_gateway_environment_id="string",
    description="string",
    name="string",
    region="string")

    const apiGatewayEnvironmentResource = new flexibleengine.ApiGatewayEnvironment("apiGatewayEnvironmentResource", {
    apiGatewayEnvironmentId: "string",
    description: "string",
    name: "string",
    region: "string",
});

    type: flexibleengine:ApiGatewayEnvironment
properties:
    apiGatewayEnvironmentId: string
    description: string
    name: string
    region: string

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

    ApiGatewayEnvironmentId string
    The environment ID.
    Description string
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    ApiGatewayEnvironmentId string
    The environment ID.
    Description string
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apiGatewayEnvironmentId String
    The environment ID.
    description String
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apiGatewayEnvironmentId string
    The environment ID.
    description string
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    api_gateway_environment_id str
    The environment ID.
    description str
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apiGatewayEnvironmentId String
    The environment ID.
    description String
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment 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 ApiGatewayEnvironment resource produces the following output properties:

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

    Look up Existing ApiGatewayEnvironment Resource

    Get an existing ApiGatewayEnvironment 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?: ApiGatewayEnvironmentState, opts?: CustomResourceOptions): ApiGatewayEnvironment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_gateway_environment_id: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None) -> ApiGatewayEnvironment
    func GetApiGatewayEnvironment(ctx *Context, name string, id IDInput, state *ApiGatewayEnvironmentState, opts ...ResourceOption) (*ApiGatewayEnvironment, error)
    public static ApiGatewayEnvironment Get(string name, Input<string> id, ApiGatewayEnvironmentState? state, CustomResourceOptions? opts = null)
    public static ApiGatewayEnvironment get(String name, Output<String> id, ApiGatewayEnvironmentState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApiGatewayEnvironment    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:
    ApiGatewayEnvironmentId string
    The environment ID.
    CreatedAt string
    The time when the shared APIG environment was created.
    Description string
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    ApiGatewayEnvironmentId string
    The environment ID.
    CreatedAt string
    The time when the shared APIG environment was created.
    Description string
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apiGatewayEnvironmentId String
    The environment ID.
    createdAt String
    The time when the shared APIG environment was created.
    description String
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apiGatewayEnvironmentId string
    The environment ID.
    createdAt string
    The time when the shared APIG environment was created.
    description string
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    api_gateway_environment_id str
    The environment ID.
    created_at str
    The time when the shared APIG environment was created.
    description str
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.
    apiGatewayEnvironmentId String
    The environment ID.
    createdAt String
    The time when the shared APIG environment was created.
    description String
    Specifies the environment description. The value can contain a maximum of 255 characters. Chinese characters must be in UTF-8 or Unicode format.
    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 shared APIG environment is located. If omitted, the provider-level region will be used. Changing this will create a new resource.

    Import

    APIG environments can be imported using the id, e.g.

    bash

    $ pulumi import flexibleengine:index/apiGatewayEnvironment:ApiGatewayEnvironment test_env 774438a28a574ac8a496325d1bf51807

    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