flexibleengine 1.46.0, Apr 14 25

flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.getApigEnvironments

Start a Neo task

Explain and create a flexibleengine.getApigEnvironments resource

flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleenginecloud/terraform-provider-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 test = flexibleengine.getApigEnvironments({
    instanceId: instanceId,
    name: environmentName,
});

import pulumi
import pulumi_flexibleengine as flexibleengine

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

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")
		_, err := flexibleengine.GetApigEnvironments(ctx, &flexibleengine.GetApigEnvironmentsArgs{
			InstanceId: instanceId,
			Name:       pulumi.StringRef(environmentName),
		}, nil)
		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 test = Flexibleengine.GetApigEnvironments.Invoke(new()
    {
        InstanceId = instanceId,
        Name = environmentName,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.FlexibleengineFunctions;
import com.pulumi.flexibleengine.inputs.GetApigEnvironmentsArgs;
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 test = FlexibleengineFunctions.getApigEnvironments(GetApigEnvironmentsArgs.builder()
            .instanceId(instanceId)
            .name(environmentName)
            .build());

    }
}

configuration:
  instanceId:
    type: dynamic
  environmentName:
    type: dynamic
variables:
  test:
    fn::invoke:
      function: flexibleengine:getApigEnvironments
      arguments:
        instanceId: ${instanceId}
        name: ${environmentName}

Using getApigEnvironments

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApigEnvironments(args: GetApigEnvironmentsArgs, opts?: InvokeOptions): Promise<GetApigEnvironmentsResult>
function getApigEnvironmentsOutput(args: GetApigEnvironmentsOutputArgs, opts?: InvokeOptions): Output<GetApigEnvironmentsResult>

def get_apig_environments(id: Optional[str] = None,
                          instance_id: Optional[str] = None,
                          name: Optional[str] = None,
                          region: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetApigEnvironmentsResult
def get_apig_environments_output(id: Optional[pulumi.Input[str]] = None,
                          instance_id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          region: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetApigEnvironmentsResult]

func GetApigEnvironments(ctx *Context, args *GetApigEnvironmentsArgs, opts ...InvokeOption) (*GetApigEnvironmentsResult, error)
func GetApigEnvironmentsOutput(ctx *Context, args *GetApigEnvironmentsOutputArgs, opts ...InvokeOption) GetApigEnvironmentsResultOutput

> Note: This function is named GetApigEnvironments in the Go SDK.

public static class GetApigEnvironments 
{
    public static Task<GetApigEnvironmentsResult> InvokeAsync(GetApigEnvironmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetApigEnvironmentsResult> Invoke(GetApigEnvironmentsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApigEnvironmentsResult> getApigEnvironments(GetApigEnvironmentsArgs args, InvokeOptions options)
public static Output<GetApigEnvironmentsResult> getApigEnvironments(GetApigEnvironmentsArgs args, InvokeOptions options)

fn::invoke:
  function: flexibleengine:index/getApigEnvironments:getApigEnvironments
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: Specifies an ID of the APIG dedicated instance to which the API environment belongs.
Id string: ID of the APIG environment.
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 query the APIG environment list. If omitted, the provider-level region will be used.

InstanceId string: Specifies an ID of the APIG dedicated instance to which the API environment belongs.
Id string: ID of the APIG environment.
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 query the APIG environment list. If omitted, the provider-level region will be used.

instanceId String: Specifies an ID of the APIG dedicated instance to which the API environment belongs.
id String: ID of the APIG environment.
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 query the APIG environment list. If omitted, the provider-level region will be used.

instanceId string: Specifies an ID of the APIG dedicated instance to which the API environment belongs.
id string: ID of the APIG environment.
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 query the APIG environment list. If omitted, the provider-level region will be used.

instance_id str: Specifies an ID of the APIG dedicated instance to which the API environment belongs.
id str: ID of the APIG environment.
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 query the APIG environment list. If omitted, the provider-level region will be used.

instanceId String: Specifies an ID of the APIG dedicated instance to which the API environment belongs.
id String: ID of the APIG environment.
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 query the APIG environment list. If omitted, the provider-level region will be used.

getApigEnvironments Result

The following output properties are available:

Environments List<GetApigEnvironmentsEnvironment>: List of APIG environment details. The structure is documented below.
Id string: ID of the APIG environment.
InstanceId string
Name string: The environment name.
Region string

Environments []GetApigEnvironmentsEnvironment: List of APIG environment details. The structure is documented below.
Id string: ID of the APIG environment.
InstanceId string
Name string: The environment name.
Region string

environments List<GetApigEnvironmentsEnvironment>: List of APIG environment details. The structure is documented below.
id String: ID of the APIG environment.
instanceId String
name String: The environment name.
region String

environments GetApigEnvironmentsEnvironment[]: List of APIG environment details. The structure is documented below.
id string: ID of the APIG environment.
instanceId string
name string: The environment name.
region string

environments Sequence[GetApigEnvironmentsEnvironment]: List of APIG environment details. The structure is documented below.
id str: ID of the APIG environment.
instance_id str
name str: The environment name.
region str

environments List<Property Map>: List of APIG environment details. The structure is documented below.
id String: ID of the APIG environment.
instanceId String
name String: The environment name.
region String

Supporting Types

GetApigEnvironmentsEnvironment

CreateTime string: Time when the APIG environment was created, in RFC-3339 format.
Description string: The description about the API environment.
Id string: ID of the APIG environment.
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.

CreateTime string: Time when the APIG environment was created, in RFC-3339 format.
Description string: The description about the API environment.
Id string: ID of the APIG environment.
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.

createTime String: Time when the APIG environment was created, in RFC-3339 format.
description String: The description about the API environment.
id String: ID of the APIG environment.
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.

createTime string: Time when the APIG environment was created, in RFC-3339 format.
description string: The description about the API environment.
id string: ID of the APIG environment.
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.

create_time str: Time when the APIG environment was created, in RFC-3339 format.
description str: The description about the API environment.
id str: ID of the APIG environment.
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.

createTime String: Time when the APIG environment was created, in RFC-3339 format.
description String: The description about the API environment.
id String: ID of the APIG environment.
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.

Package Details

Repository: flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
License
Notes: This Pulumi package is based on the flexibleengine Terraform Provider.

flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.getApigEnvironments

On this page

On this page

Example Usage

Using getApigEnvironments

getApigEnvironments Result

Supporting Types

GetApigEnvironmentsEnvironment

Package Details

On this page

On this page