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

flexibleengine.ApiGatewayGroup

Explore with Pulumi AI

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

    Provides an API gateway group resource within FlexibleEngine.

    Example Usage

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

const apigwGroup = new flexibleengine.ApiGatewayGroup("apigwGroup", {description: "your descpiption"});

    import pulumi
import pulumi_flexibleengine as flexibleengine

apigw_group = flexibleengine.ApiGatewayGroup("apigwGroup", description="your descpiption")

    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.NewApiGatewayGroup(ctx, "apigwGroup", &flexibleengine.ApiGatewayGroupArgs{
			Description: pulumi.String("your descpiption"),
		})
		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 apigwGroup = new Flexibleengine.ApiGatewayGroup("apigwGroup", new()
    {
        Description = "your descpiption",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApiGatewayGroup;
import com.pulumi.flexibleengine.ApiGatewayGroupArgs;
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 apigwGroup = new ApiGatewayGroup("apigwGroup", ApiGatewayGroupArgs.builder()
            .description("your descpiption")
            .build());

    }
}

    resources:
  apigwGroup:
    type: flexibleengine:ApiGatewayGroup
    properties:
      description: your descpiption

    Create ApiGatewayGroup Resource

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

    Constructor syntax

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

@overload
def ApiGatewayGroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    api_gateway_group_id: Optional[str] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    region: Optional[str] = None,
                    timeouts: Optional[ApiGatewayGroupTimeoutsArgs] = None)
    func NewApiGatewayGroup(ctx *Context, name string, args *ApiGatewayGroupArgs, opts ...ResourceOption) (*ApiGatewayGroup, error)
    public ApiGatewayGroup(string name, ApiGatewayGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ApiGatewayGroup(String name, ApiGatewayGroupArgs args)
public ApiGatewayGroup(String name, ApiGatewayGroupArgs args, CustomResourceOptions options)

    type: flexibleengine:ApiGatewayGroup
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 ApiGatewayGroupArgs
    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 ApiGatewayGroupArgs
    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 ApiGatewayGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiGatewayGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiGatewayGroupArgs
    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 apiGatewayGroupResource = new Flexibleengine.ApiGatewayGroup("apiGatewayGroupResource", new()
{
    ApiGatewayGroupId = "string",
    Description = "string",
    Name = "string",
    Region = "string",
    Timeouts = new Flexibleengine.Inputs.ApiGatewayGroupTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := flexibleengine.NewApiGatewayGroup(ctx, "apiGatewayGroupResource", &flexibleengine.ApiGatewayGroupArgs{
	ApiGatewayGroupId: pulumi.String("string"),
	Description:       pulumi.String("string"),
	Name:              pulumi.String("string"),
	Region:            pulumi.String("string"),
	Timeouts: &flexibleengine.ApiGatewayGroupTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    var apiGatewayGroupResource = new ApiGatewayGroup("apiGatewayGroupResource", ApiGatewayGroupArgs.builder()
    .apiGatewayGroupId("string")
    .description("string")
    .name("string")
    .region("string")
    .timeouts(ApiGatewayGroupTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    api_gateway_group_resource = flexibleengine.ApiGatewayGroup("apiGatewayGroupResource",
    api_gateway_group_id="string",
    description="string",
    name="string",
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const apiGatewayGroupResource = new flexibleengine.ApiGatewayGroup("apiGatewayGroupResource", {
    apiGatewayGroupId: "string",
    description: "string",
    name: "string",
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: flexibleengine:ApiGatewayGroup
properties:
    apiGatewayGroupId: string
    description: string
    name: string
    region: string
    timeouts:
        create: string
        delete: string

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

    ApiGatewayGroupId string
    ID of the API group.
    Description string
    Specifies the description of the API group. The description cannot exceed 255 characters.
    Name string
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    Timeouts ApiGatewayGroupTimeouts
    ApiGatewayGroupId string
    ID of the API group.
    Description string
    Specifies the description of the API group. The description cannot exceed 255 characters.
    Name string
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    Timeouts ApiGatewayGroupTimeoutsArgs
    apiGatewayGroupId String
    ID of the API group.
    description String
    Specifies the description of the API group. The description cannot exceed 255 characters.
    name String
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    timeouts ApiGatewayGroupTimeouts
    apiGatewayGroupId string
    ID of the API group.
    description string
    Specifies the description of the API group. The description cannot exceed 255 characters.
    name string
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region string
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    timeouts ApiGatewayGroupTimeouts
    api_gateway_group_id str
    ID of the API group.
    description str
    Specifies the description of the API group. The description cannot exceed 255 characters.
    name str
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region str
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    timeouts ApiGatewayGroupTimeoutsArgs
    apiGatewayGroupId String
    ID of the API group.
    description String
    Specifies the description of the API group. The description cannot exceed 255 characters.
    name String
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status double
    Status of the API group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status float64
    Status of the API group.
    id String
    The provider-assigned unique ID for this managed resource.
    status Double
    Status of the API group.
    id string
    The provider-assigned unique ID for this managed resource.
    status number
    Status of the API group.
    id str
    The provider-assigned unique ID for this managed resource.
    status float
    Status of the API group.
    id String
    The provider-assigned unique ID for this managed resource.
    status Number
    Status of the API group.

    Look up Existing ApiGatewayGroup Resource

    Get an existing ApiGatewayGroup 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?: ApiGatewayGroupState, opts?: CustomResourceOptions): ApiGatewayGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_gateway_group_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        status: Optional[float] = None,
        timeouts: Optional[ApiGatewayGroupTimeoutsArgs] = None) -> ApiGatewayGroup
    func GetApiGatewayGroup(ctx *Context, name string, id IDInput, state *ApiGatewayGroupState, opts ...ResourceOption) (*ApiGatewayGroup, error)
    public static ApiGatewayGroup Get(string name, Input<string> id, ApiGatewayGroupState? state, CustomResourceOptions? opts = null)
    public static ApiGatewayGroup get(String name, Output<String> id, ApiGatewayGroupState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApiGatewayGroup    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:
    ApiGatewayGroupId string
    ID of the API group.
    Description string
    Specifies the description of the API group. The description cannot exceed 255 characters.
    Name string
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    Status double
    Status of the API group.
    Timeouts ApiGatewayGroupTimeouts
    ApiGatewayGroupId string
    ID of the API group.
    Description string
    Specifies the description of the API group. The description cannot exceed 255 characters.
    Name string
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    Status float64
    Status of the API group.
    Timeouts ApiGatewayGroupTimeoutsArgs
    apiGatewayGroupId String
    ID of the API group.
    description String
    Specifies the description of the API group. The description cannot exceed 255 characters.
    name String
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    status Double
    Status of the API group.
    timeouts ApiGatewayGroupTimeouts
    apiGatewayGroupId string
    ID of the API group.
    description string
    Specifies the description of the API group. The description cannot exceed 255 characters.
    name string
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region string
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    status number
    Status of the API group.
    timeouts ApiGatewayGroupTimeouts
    api_gateway_group_id str
    ID of the API group.
    description str
    Specifies the description of the API group. The description cannot exceed 255 characters.
    name str
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region str
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    status float
    Status of the API group.
    timeouts ApiGatewayGroupTimeoutsArgs
    apiGatewayGroupId String
    ID of the API group.
    description String
    Specifies the description of the API group. The description cannot exceed 255 characters.
    name String
    Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.
    status Number
    Status of the API group.
    timeouts Property Map

    Supporting Types

    ApiGatewayGroupTimeouts, ApiGatewayGroupTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    Import

    API groups can be imported using the id, e.g.

    $ pulumi import flexibleengine:index/apiGatewayGroup:ApiGatewayGroup apigw_group c8738f7c-a4b0-4c5f-a202-bda7dc4018a4

    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