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

flexibleengine.getApigGroups

Explore with Pulumi AI

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

Use this data source to query and filter the group list under the APIG instance 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 groupName = config.requireObject("groupName");
const test = flexibleengine.getApigGroups({
    instanceId: instanceId,
    name: groupName,
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
group_name = config.require_object("groupName")
test = flexibleengine.get_apig_groups(instance_id=instance_id,
    name=group_name)
Copy
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")
		groupName := cfg.RequireObject("groupName")
		_, err := flexibleengine.GetApigGroups(ctx, &flexibleengine.GetApigGroupsArgs{
			InstanceId: instanceId,
			Name:       pulumi.StringRef(groupName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 groupName = config.RequireObject<dynamic>("groupName");
    var test = Flexibleengine.GetApigGroups.Invoke(new()
    {
        InstanceId = instanceId,
        Name = groupName,
    });

});
Copy
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.GetApigGroupsArgs;
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 groupName = config.get("groupName");
        final var test = FlexibleengineFunctions.getApigGroups(GetApigGroupsArgs.builder()
            .instanceId(instanceId)
            .name(groupName)
            .build());

    }
}
Copy
configuration:
  instanceId:
    type: dynamic
  groupName:
    type: dynamic
variables:
  test:
    fn::invoke:
      function: flexibleengine:getApigGroups
      arguments:
        instanceId: ${instanceId}
        name: ${groupName}
Copy

Using getApigGroups

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 getApigGroups(args: GetApigGroupsArgs, opts?: InvokeOptions): Promise<GetApigGroupsResult>
function getApigGroupsOutput(args: GetApigGroupsOutputArgs, opts?: InvokeOptions): Output<GetApigGroupsResult>
Copy
def get_apig_groups(group_id: Optional[str] = None,
                    id: Optional[str] = None,
                    instance_id: Optional[str] = None,
                    name: Optional[str] = None,
                    region: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApigGroupsResult
def get_apig_groups_output(group_id: Optional[pulumi.Input[str]] = None,
                    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[GetApigGroupsResult]
Copy
func GetApigGroups(ctx *Context, args *GetApigGroupsArgs, opts ...InvokeOption) (*GetApigGroupsResult, error)
func GetApigGroupsOutput(ctx *Context, args *GetApigGroupsOutputArgs, opts ...InvokeOption) GetApigGroupsResultOutput
Copy

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

public static class GetApigGroups 
{
    public static Task<GetApigGroupsResult> InvokeAsync(GetApigGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetApigGroupsResult> Invoke(GetApigGroupsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApigGroupsResult> getApigGroups(GetApigGroupsArgs args, InvokeOptions options)
public static Output<GetApigGroupsResult> getApigGroups(GetApigGroupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: flexibleengine:index/getApigGroups:getApigGroups
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
Specifies an ID of the APIG dedicated instance to which the API group belongs.
GroupId string
Specifies the API group ID used to query.
Id string
The variable ID.
Name string
Specifies the API group name used to query.
Region string
Specifies the region in which to query the API group list. If omitted, the provider-level region will be used.
InstanceId This property is required. string
Specifies an ID of the APIG dedicated instance to which the API group belongs.
GroupId string
Specifies the API group ID used to query.
Id string
The variable ID.
Name string
Specifies the API group name used to query.
Region string
Specifies the region in which to query the API group list. If omitted, the provider-level region will be used.
instanceId This property is required. String
Specifies an ID of the APIG dedicated instance to which the API group belongs.
groupId String
Specifies the API group ID used to query.
id String
The variable ID.
name String
Specifies the API group name used to query.
region String
Specifies the region in which to query the API group list. If omitted, the provider-level region will be used.
instanceId This property is required. string
Specifies an ID of the APIG dedicated instance to which the API group belongs.
groupId string
Specifies the API group ID used to query.
id string
The variable ID.
name string
Specifies the API group name used to query.
region string
Specifies the region in which to query the API group list. If omitted, the provider-level region will be used.
instance_id This property is required. str
Specifies an ID of the APIG dedicated instance to which the API group belongs.
group_id str
Specifies the API group ID used to query.
id str
The variable ID.
name str
Specifies the API group name used to query.
region str
Specifies the region in which to query the API group list. If omitted, the provider-level region will be used.
instanceId This property is required. String
Specifies an ID of the APIG dedicated instance to which the API group belongs.
groupId String
Specifies the API group ID used to query.
id String
The variable ID.
name String
Specifies the API group name used to query.
region String
Specifies the region in which to query the API group list. If omitted, the provider-level region will be used.

getApigGroups Result

The following output properties are available:

Groups List<GetApigGroupsGroup>
All groups that match the filter parameters. The groups structure is documented below.
Id string
The variable ID.
InstanceId string
Region string
GroupId string
Name string
The variable name.
Groups []GetApigGroupsGroup
All groups that match the filter parameters. The groups structure is documented below.
Id string
The variable ID.
InstanceId string
Region string
GroupId string
Name string
The variable name.
groups List<GetApigGroupsGroup>
All groups that match the filter parameters. The groups structure is documented below.
id String
The variable ID.
instanceId String
region String
groupId String
name String
The variable name.
groups GetApigGroupsGroup[]
All groups that match the filter parameters. The groups structure is documented below.
id string
The variable ID.
instanceId string
region string
groupId string
name string
The variable name.
groups Sequence[GetApigGroupsGroup]
All groups that match the filter parameters. The groups structure is documented below.
id str
The variable ID.
instance_id str
region str
group_id str
name str
The variable name.
groups List<Property Map>
All groups that match the filter parameters. The groups structure is documented below.
id String
The variable ID.
instanceId String
region String
groupId String
name String
The variable name.

Supporting Types

GetApigGroupsGroup

CreatedAt This property is required. string
The creation time of the API group.
Description This property is required. string
The description of the API group.
Environments This property is required. List<GetApigGroupsGroupEnvironment>
The array of one or more environments of the API group. The environment structure is documented below.
Id This property is required. string
The variable ID.
IsDefault This property is required. double
Indicates whether the API group is the default group.
Name This property is required. string
Specifies the API group name used to query.
OnSellStatus This property is required. double
Whether it has been listed on the cloud store. The valid values are as follows:

  • 1: Listed.
  • 2: Not listed.
  • 3: Under review.
SlDomain This property is required. string
The subdomain name assigned by the system by default.
SlDomains This property is required. List<string>
List of subdomain names assigned by the system by default.
Status This property is required. double
The current status of the API group. The valid values are as follows:

  • 1: Normal.
UpdatedAt This property is required. string
The latest update time of the API group.
UrlDomains This property is required. List<GetApigGroupsGroupUrlDomain>
List of independent domains bound on the API group. The url_domains structure is documented below.
CreatedAt This property is required. string
The creation time of the API group.
Description This property is required. string
The description of the API group.
Environments This property is required. []GetApigGroupsGroupEnvironment
The array of one or more environments of the API group. The environment structure is documented below.
Id This property is required. string
The variable ID.
IsDefault This property is required. float64
Indicates whether the API group is the default group.
Name This property is required. string
Specifies the API group name used to query.
OnSellStatus This property is required. float64
Whether it has been listed on the cloud store. The valid values are as follows:

  • 1: Listed.
  • 2: Not listed.
  • 3: Under review.
SlDomain This property is required. string
The subdomain name assigned by the system by default.
SlDomains This property is required. []string
List of subdomain names assigned by the system by default.
Status This property is required. float64
The current status of the API group. The valid values are as follows:

  • 1: Normal.
UpdatedAt This property is required. string
The latest update time of the API group.
UrlDomains This property is required. []GetApigGroupsGroupUrlDomain
List of independent domains bound on the API group. The url_domains structure is documented below.
createdAt This property is required. String
The creation time of the API group.
description This property is required. String
The description of the API group.
environments This property is required. List<GetApigGroupsGroupEnvironment>
The array of one or more environments of the API group. The environment structure is documented below.
id This property is required. String
The variable ID.
isDefault This property is required. Double
Indicates whether the API group is the default group.
name This property is required. String
Specifies the API group name used to query.
onSellStatus This property is required. Double
Whether it has been listed on the cloud store. The valid values are as follows:

  • 1: Listed.
  • 2: Not listed.
  • 3: Under review.
slDomain This property is required. String
The subdomain name assigned by the system by default.
slDomains This property is required. List<String>
List of subdomain names assigned by the system by default.
status This property is required. Double
The current status of the API group. The valid values are as follows:

  • 1: Normal.
updatedAt This property is required. String
The latest update time of the API group.
urlDomains This property is required. List<GetApigGroupsGroupUrlDomain>
List of independent domains bound on the API group. The url_domains structure is documented below.
createdAt This property is required. string
The creation time of the API group.
description This property is required. string
The description of the API group.
environments This property is required. GetApigGroupsGroupEnvironment[]
The array of one or more environments of the API group. The environment structure is documented below.
id This property is required. string
The variable ID.
isDefault This property is required. number
Indicates whether the API group is the default group.
name This property is required. string
Specifies the API group name used to query.
onSellStatus This property is required. number
Whether it has been listed on the cloud store. The valid values are as follows:

  • 1: Listed.
  • 2: Not listed.
  • 3: Under review.
slDomain This property is required. string
The subdomain name assigned by the system by default.
slDomains This property is required. string[]
List of subdomain names assigned by the system by default.
status This property is required. number
The current status of the API group. The valid values are as follows:

  • 1: Normal.
updatedAt This property is required. string
The latest update time of the API group.
urlDomains This property is required. GetApigGroupsGroupUrlDomain[]
List of independent domains bound on the API group. The url_domains structure is documented below.
created_at This property is required. str
The creation time of the API group.
description This property is required. str
The description of the API group.
environments This property is required. Sequence[GetApigGroupsGroupEnvironment]
The array of one or more environments of the API group. The environment structure is documented below.
id This property is required. str
The variable ID.
is_default This property is required. float
Indicates whether the API group is the default group.
name This property is required. str
Specifies the API group name used to query.
on_sell_status This property is required. float
Whether it has been listed on the cloud store. The valid values are as follows:

  • 1: Listed.
  • 2: Not listed.
  • 3: Under review.
sl_domain This property is required. str
The subdomain name assigned by the system by default.
sl_domains This property is required. Sequence[str]
List of subdomain names assigned by the system by default.
status This property is required. float
The current status of the API group. The valid values are as follows:

  • 1: Normal.
updated_at This property is required. str
The latest update time of the API group.
url_domains This property is required. Sequence[GetApigGroupsGroupUrlDomain]
List of independent domains bound on the API group. The url_domains structure is documented below.
createdAt This property is required. String
The creation time of the API group.
description This property is required. String
The description of the API group.
environments This property is required. List<Property Map>
The array of one or more environments of the API group. The environment structure is documented below.
id This property is required. String
The variable ID.
isDefault This property is required. Number
Indicates whether the API group is the default group.
name This property is required. String
Specifies the API group name used to query.
onSellStatus This property is required. Number
Whether it has been listed on the cloud store. The valid values are as follows:

  • 1: Listed.
  • 2: Not listed.
  • 3: Under review.
slDomain This property is required. String
The subdomain name assigned by the system by default.
slDomains This property is required. List<String>
List of subdomain names assigned by the system by default.
status This property is required. Number
The current status of the API group. The valid values are as follows:

  • 1: Normal.
updatedAt This property is required. String
The latest update time of the API group.
urlDomains This property is required. List<Property Map>
List of independent domains bound on the API group. The url_domains structure is documented below.

GetApigGroupsGroupEnvironment

EnvironmentId This property is required. string
The ID of the environment to which the variables belong.
Variables This property is required. List<GetApigGroupsGroupEnvironmentVariable>
The array of one or more environment variables.
The variable structure is documented below.
EnvironmentId This property is required. string
The ID of the environment to which the variables belong.
Variables This property is required. []GetApigGroupsGroupEnvironmentVariable
The array of one or more environment variables.
The variable structure is documented below.
environmentId This property is required. String
The ID of the environment to which the variables belong.
variables This property is required. List<GetApigGroupsGroupEnvironmentVariable>
The array of one or more environment variables.
The variable structure is documented below.
environmentId This property is required. string
The ID of the environment to which the variables belong.
variables This property is required. GetApigGroupsGroupEnvironmentVariable[]
The array of one or more environment variables.
The variable structure is documented below.
environment_id This property is required. str
The ID of the environment to which the variables belong.
variables This property is required. Sequence[GetApigGroupsGroupEnvironmentVariable]
The array of one or more environment variables.
The variable structure is documented below.
environmentId This property is required. String
The ID of the environment to which the variables belong.
variables This property is required. List<Property Map>
The array of one or more environment variables.
The variable structure is documented below.

GetApigGroupsGroupEnvironmentVariable

Id This property is required. string
The variable ID.
Name This property is required. string
Specifies the API group name used to query.
Value This property is required. string
The variable value.
Id This property is required. string
The variable ID.
Name This property is required. string
Specifies the API group name used to query.
Value This property is required. string
The variable value.
id This property is required. String
The variable ID.
name This property is required. String
Specifies the API group name used to query.
value This property is required. String
The variable value.
id This property is required. string
The variable ID.
name This property is required. string
Specifies the API group name used to query.
value This property is required. string
The variable value.
id This property is required. str
The variable ID.
name This property is required. str
Specifies the API group name used to query.
value This property is required. str
The variable value.
id This property is required. String
The variable ID.
name This property is required. String
Specifies the API group name used to query.
value This property is required. String
The variable value.

GetApigGroupsGroupUrlDomain

CnameStatus This property is required. double
CNAME resolution status of the domain name. The valid values are as follows:

  • 1: Not resolved.
  • 2: Resolving.
  • 3: Resolved.
  • 4: Resolution failed.
Id This property is required. string
The variable ID.
IsHasTrustedRootCa This property is required. bool
Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
MinSslVersion This property is required. string
Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

  • TLSv1.1
  • TLSv1.2
Name This property is required. string
Specifies the API group name used to query.
SslId This property is required. string
The SSL certificate ID.
SslName This property is required. string
The SSL certificate name.
VerifiedClientCertificateEnabled This property is required. bool
Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
CnameStatus This property is required. float64
CNAME resolution status of the domain name. The valid values are as follows:

  • 1: Not resolved.
  • 2: Resolving.
  • 3: Resolved.
  • 4: Resolution failed.
Id This property is required. string
The variable ID.
IsHasTrustedRootCa This property is required. bool
Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
MinSslVersion This property is required. string
Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

  • TLSv1.1
  • TLSv1.2
Name This property is required. string
Specifies the API group name used to query.
SslId This property is required. string
The SSL certificate ID.
SslName This property is required. string
The SSL certificate name.
VerifiedClientCertificateEnabled This property is required. bool
Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
cnameStatus This property is required. Double
CNAME resolution status of the domain name. The valid values are as follows:

  • 1: Not resolved.
  • 2: Resolving.
  • 3: Resolved.
  • 4: Resolution failed.
id This property is required. String
The variable ID.
isHasTrustedRootCa This property is required. Boolean
Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
minSslVersion This property is required. String
Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

  • TLSv1.1
  • TLSv1.2
name This property is required. String
Specifies the API group name used to query.
sslId This property is required. String
The SSL certificate ID.
sslName This property is required. String
The SSL certificate name.
verifiedClientCertificateEnabled This property is required. Boolean
Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
cnameStatus This property is required. number
CNAME resolution status of the domain name. The valid values are as follows:

  • 1: Not resolved.
  • 2: Resolving.
  • 3: Resolved.
  • 4: Resolution failed.
id This property is required. string
The variable ID.
isHasTrustedRootCa This property is required. boolean
Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
minSslVersion This property is required. string
Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

  • TLSv1.1
  • TLSv1.2
name This property is required. string
Specifies the API group name used to query.
sslId This property is required. string
The SSL certificate ID.
sslName This property is required. string
The SSL certificate name.
verifiedClientCertificateEnabled This property is required. boolean
Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
cname_status This property is required. float
CNAME resolution status of the domain name. The valid values are as follows:

  • 1: Not resolved.
  • 2: Resolving.
  • 3: Resolved.
  • 4: Resolution failed.
id This property is required. str
The variable ID.
is_has_trusted_root_ca This property is required. bool
Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
min_ssl_version This property is required. str
Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

  • TLSv1.1
  • TLSv1.2
name This property is required. str
Specifies the API group name used to query.
ssl_id This property is required. str
The SSL certificate ID.
ssl_name This property is required. str
The SSL certificate name.
verified_client_certificate_enabled This property is required. bool
Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.
cnameStatus This property is required. Number
CNAME resolution status of the domain name. The valid values are as follows:

  • 1: Not resolved.
  • 2: Resolving.
  • 3: Resolved.
  • 4: Resolution failed.
id This property is required. String
The variable ID.
isHasTrustedRootCa This property is required. Boolean
Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. The default is false.
minSslVersion This property is required. String
Minimum SSL version. The default is TLSv1.1. The valid values are as follows:

  • TLSv1.1
  • TLSv1.2
name This property is required. String
Specifies the API group name used to query.
sslId This property is required. String
The SSL certificate ID.
sslName This property is required. String
The SSL certificate name.
verifiedClientCertificateEnabled This property is required. Boolean
Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. The default is false.

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