Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. apigateway
  5. Group
Alibaba Cloud v3.77.0 published on Friday, May 2, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.apigateway.Group

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.77.0 published on Friday, May 2, 2025 by Pulumi
pulumi/pulumi-alicloud

    Example Usage

    Basic Usage

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

const _default = new alicloud.apigateway.Group("default", {
    name: "tf_example",
    description: "tf_example",
    basePath: "/",
    userLogConfig: {
        requestBody: true,
        responseBody: true,
        queryString: "*",
        requestHeaders: "*",
        responseHeaders: "*",
        jwtClaims: "*",
    },
});

    import pulumi
import pulumi_alicloud as alicloud

default = alicloud.apigateway.Group("default",
    name="tf_example",
    description="tf_example",
    base_path="/",
    user_log_config={
        "request_body": True,
        "response_body": True,
        "query_string": "*",
        "request_headers": "*",
        "response_headers": "*",
        "jwt_claims": "*",
    })

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewGroup(ctx, "default", &apigateway.GroupArgs{
			Name:        pulumi.String("tf_example"),
			Description: pulumi.String("tf_example"),
			BasePath:    pulumi.String("/"),
			UserLogConfig: &apigateway.GroupUserLogConfigArgs{
				RequestBody:     pulumi.Bool(true),
				ResponseBody:    pulumi.Bool(true),
				QueryString:     pulumi.String("*"),
				RequestHeaders:  pulumi.String("*"),
				ResponseHeaders: pulumi.String("*"),
				JwtClaims:       pulumi.String("*"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var @default = new AliCloud.ApiGateway.Group("default", new()
    {
        Name = "tf_example",
        Description = "tf_example",
        BasePath = "/",
        UserLogConfig = new AliCloud.ApiGateway.Inputs.GroupUserLogConfigArgs
        {
            RequestBody = true,
            ResponseBody = true,
            QueryString = "*",
            RequestHeaders = "*",
            ResponseHeaders = "*",
            JwtClaims = "*",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.Group;
import com.pulumi.alicloud.apigateway.GroupArgs;
import com.pulumi.alicloud.apigateway.inputs.GroupUserLogConfigArgs;
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 default_ = new Group("default", GroupArgs.builder()
            .name("tf_example")
            .description("tf_example")
            .basePath("/")
            .userLogConfig(GroupUserLogConfigArgs.builder()
                .requestBody(true)
                .responseBody(true)
                .queryString("*")
                .requestHeaders("*")
                .responseHeaders("*")
                .jwtClaims("*")
                .build())
            .build());

    }
}

    resources:
  default:
    type: alicloud:apigateway:Group
    properties:
      name: tf_example
      description: tf_example
      basePath: /
      userLogConfig:
        requestBody: true
        responseBody: true
        queryString: '*'
        requestHeaders: '*'
        responseHeaders: '*'
        jwtClaims: '*'

    Create Group Resource

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

    Constructor syntax

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          base_path: Optional[str] = None,
          description: Optional[str] = None,
          instance_id: Optional[str] = None,
          name: Optional[str] = None,
          user_log_config: Optional[GroupUserLogConfigArgs] = None,
          vpc_intranet_enable: Optional[bool] = None)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: alicloud:apigateway:Group
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 GroupArgs
    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 GroupArgs
    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 GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    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 groupResource = new AliCloud.ApiGateway.Group("groupResource", new()
{
    BasePath = "string",
    Description = "string",
    InstanceId = "string",
    Name = "string",
    UserLogConfig = new AliCloud.ApiGateway.Inputs.GroupUserLogConfigArgs
    {
        JwtClaims = "string",
        QueryString = "string",
        RequestBody = false,
        RequestHeaders = "string",
        ResponseBody = false,
        ResponseHeaders = "string",
    },
    VpcIntranetEnable = false,
});

    example, err := apigateway.NewGroup(ctx, "groupResource", &apigateway.GroupArgs{
	BasePath:    pulumi.String("string"),
	Description: pulumi.String("string"),
	InstanceId:  pulumi.String("string"),
	Name:        pulumi.String("string"),
	UserLogConfig: &apigateway.GroupUserLogConfigArgs{
		JwtClaims:       pulumi.String("string"),
		QueryString:     pulumi.String("string"),
		RequestBody:     pulumi.Bool(false),
		RequestHeaders:  pulumi.String("string"),
		ResponseBody:    pulumi.Bool(false),
		ResponseHeaders: pulumi.String("string"),
	},
	VpcIntranetEnable: pulumi.Bool(false),
})

    var groupResource = new com.pulumi.alicloud.apigateway.Group("groupResource", com.pulumi.alicloud.apigateway.GroupArgs.builder()
    .basePath("string")
    .description("string")
    .instanceId("string")
    .name("string")
    .userLogConfig(GroupUserLogConfigArgs.builder()
        .jwtClaims("string")
        .queryString("string")
        .requestBody(false)
        .requestHeaders("string")
        .responseBody(false)
        .responseHeaders("string")
        .build())
    .vpcIntranetEnable(false)
    .build());

    group_resource = alicloud.apigateway.Group("groupResource",
    base_path="string",
    description="string",
    instance_id="string",
    name="string",
    user_log_config={
        "jwt_claims": "string",
        "query_string": "string",
        "request_body": False,
        "request_headers": "string",
        "response_body": False,
        "response_headers": "string",
    },
    vpc_intranet_enable=False)

    const groupResource = new alicloud.apigateway.Group("groupResource", {
    basePath: "string",
    description: "string",
    instanceId: "string",
    name: "string",
    userLogConfig: {
        jwtClaims: "string",
        queryString: "string",
        requestBody: false,
        requestHeaders: "string",
        responseBody: false,
        responseHeaders: "string",
    },
    vpcIntranetEnable: false,
});

    type: alicloud:apigateway:Group
properties:
    basePath: string
    description: string
    instanceId: string
    name: string
    userLogConfig:
        jwtClaims: string
        queryString: string
        requestBody: false
        requestHeaders: string
        responseBody: false
        responseHeaders: string
    vpcIntranetEnable: false

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

    BasePath string
    The base path of the api gateway group. Defaults to /.
    Description string
    The description of the api gateway group. Defaults to null.
    InstanceId string
    The id of the api gateway.
    Name string
    The name of the api gateway group. Defaults to null.
    UserLogConfig Pulumi.AliCloud.ApiGateway.Inputs.GroupUserLogConfig
    user_log_config defines the config of user log of the group. See user_log_config below.
    VpcIntranetEnable bool
    Whether to enable vpc_domain. Defaults to false.
    BasePath string
    The base path of the api gateway group. Defaults to /.
    Description string
    The description of the api gateway group. Defaults to null.
    InstanceId string
    The id of the api gateway.
    Name string
    The name of the api gateway group. Defaults to null.
    UserLogConfig GroupUserLogConfigArgs
    user_log_config defines the config of user log of the group. See user_log_config below.
    VpcIntranetEnable bool
    Whether to enable vpc_domain. Defaults to false.
    basePath String
    The base path of the api gateway group. Defaults to /.
    description String
    The description of the api gateway group. Defaults to null.
    instanceId String
    The id of the api gateway.
    name String
    The name of the api gateway group. Defaults to null.
    userLogConfig GroupUserLogConfig
    user_log_config defines the config of user log of the group. See user_log_config below.
    vpcIntranetEnable Boolean
    Whether to enable vpc_domain. Defaults to false.
    basePath string
    The base path of the api gateway group. Defaults to /.
    description string
    The description of the api gateway group. Defaults to null.
    instanceId string
    The id of the api gateway.
    name string
    The name of the api gateway group. Defaults to null.
    userLogConfig GroupUserLogConfig
    user_log_config defines the config of user log of the group. See user_log_config below.
    vpcIntranetEnable boolean
    Whether to enable vpc_domain. Defaults to false.
    base_path str
    The base path of the api gateway group. Defaults to /.
    description str
    The description of the api gateway group. Defaults to null.
    instance_id str
    The id of the api gateway.
    name str
    The name of the api gateway group. Defaults to null.
    user_log_config GroupUserLogConfigArgs
    user_log_config defines the config of user log of the group. See user_log_config below.
    vpc_intranet_enable bool
    Whether to enable vpc_domain. Defaults to false.
    basePath String
    The base path of the api gateway group. Defaults to /.
    description String
    The description of the api gateway group. Defaults to null.
    instanceId String
    The id of the api gateway.
    name String
    The name of the api gateway group. Defaults to null.
    userLogConfig Property Map
    user_log_config defines the config of user log of the group. See user_log_config below.
    vpcIntranetEnable Boolean
    Whether to enable vpc_domain. Defaults to false.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SubDomain string
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    VpcDomain string
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubDomain string
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    VpcDomain string
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    id String
    The provider-assigned unique ID for this managed resource.
    subDomain String
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    vpcDomain String
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    id string
    The provider-assigned unique ID for this managed resource.
    subDomain string
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    vpcDomain string
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    id str
    The provider-assigned unique ID for this managed resource.
    sub_domain str
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    vpc_domain str
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    id String
    The provider-assigned unique ID for this managed resource.
    subDomain String
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    vpcDomain String
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

    Look up Existing Group Resource

    Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        base_path: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        sub_domain: Optional[str] = None,
        user_log_config: Optional[GroupUserLogConfigArgs] = None,
        vpc_domain: Optional[str] = None,
        vpc_intranet_enable: Optional[bool] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:apigateway:Group    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:
    BasePath string
    The base path of the api gateway group. Defaults to /.
    Description string
    The description of the api gateway group. Defaults to null.
    InstanceId string
    The id of the api gateway.
    Name string
    The name of the api gateway group. Defaults to null.
    SubDomain string
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    UserLogConfig Pulumi.AliCloud.ApiGateway.Inputs.GroupUserLogConfig
    user_log_config defines the config of user log of the group. See user_log_config below.
    VpcDomain string
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    VpcIntranetEnable bool
    Whether to enable vpc_domain. Defaults to false.
    BasePath string
    The base path of the api gateway group. Defaults to /.
    Description string
    The description of the api gateway group. Defaults to null.
    InstanceId string
    The id of the api gateway.
    Name string
    The name of the api gateway group. Defaults to null.
    SubDomain string
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    UserLogConfig GroupUserLogConfigArgs
    user_log_config defines the config of user log of the group. See user_log_config below.
    VpcDomain string
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    VpcIntranetEnable bool
    Whether to enable vpc_domain. Defaults to false.
    basePath String
    The base path of the api gateway group. Defaults to /.
    description String
    The description of the api gateway group. Defaults to null.
    instanceId String
    The id of the api gateway.
    name String
    The name of the api gateway group. Defaults to null.
    subDomain String
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    userLogConfig GroupUserLogConfig
    user_log_config defines the config of user log of the group. See user_log_config below.
    vpcDomain String
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    vpcIntranetEnable Boolean
    Whether to enable vpc_domain. Defaults to false.
    basePath string
    The base path of the api gateway group. Defaults to /.
    description string
    The description of the api gateway group. Defaults to null.
    instanceId string
    The id of the api gateway.
    name string
    The name of the api gateway group. Defaults to null.
    subDomain string
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    userLogConfig GroupUserLogConfig
    user_log_config defines the config of user log of the group. See user_log_config below.
    vpcDomain string
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    vpcIntranetEnable boolean
    Whether to enable vpc_domain. Defaults to false.
    base_path str
    The base path of the api gateway group. Defaults to /.
    description str
    The description of the api gateway group. Defaults to null.
    instance_id str
    The id of the api gateway.
    name str
    The name of the api gateway group. Defaults to null.
    sub_domain str
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    user_log_config GroupUserLogConfigArgs
    user_log_config defines the config of user log of the group. See user_log_config below.
    vpc_domain str
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    vpc_intranet_enable bool
    Whether to enable vpc_domain. Defaults to false.
    basePath String
    The base path of the api gateway group. Defaults to /.
    description String
    The description of the api gateway group. Defaults to null.
    instanceId String
    The id of the api gateway.
    name String
    The name of the api gateway group. Defaults to null.
    subDomain String
    (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
    userLogConfig Property Map
    user_log_config defines the config of user log of the group. See user_log_config below.
    vpcDomain String
    (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.
    vpcIntranetEnable Boolean
    Whether to enable vpc_domain. Defaults to false.

    Supporting Types

    GroupUserLogConfig, GroupUserLogConfigArgs

    JwtClaims string
    The jwt claims to be record, support multi jwt claims split by ,. Set * to record all.
    QueryString string
    The query params to be record, support multi query params split by ,. Set * to record all.
    RequestBody bool
    Whether to record the request body.
    RequestHeaders string
    The request headers to be record, support multi request headers split by ,. Set * to record all.
    ResponseBody bool
    Whether to record the response body.
    ResponseHeaders string
    The response headers to be record, support multi response headers split by ,. Set * to record all.
    JwtClaims string
    The jwt claims to be record, support multi jwt claims split by ,. Set * to record all.
    QueryString string
    The query params to be record, support multi query params split by ,. Set * to record all.
    RequestBody bool
    Whether to record the request body.
    RequestHeaders string
    The request headers to be record, support multi request headers split by ,. Set * to record all.
    ResponseBody bool
    Whether to record the response body.
    ResponseHeaders string
    The response headers to be record, support multi response headers split by ,. Set * to record all.
    jwtClaims String
    The jwt claims to be record, support multi jwt claims split by ,. Set * to record all.
    queryString String
    The query params to be record, support multi query params split by ,. Set * to record all.
    requestBody Boolean
    Whether to record the request body.
    requestHeaders String
    The request headers to be record, support multi request headers split by ,. Set * to record all.
    responseBody Boolean
    Whether to record the response body.
    responseHeaders String
    The response headers to be record, support multi response headers split by ,. Set * to record all.
    jwtClaims string
    The jwt claims to be record, support multi jwt claims split by ,. Set * to record all.
    queryString string
    The query params to be record, support multi query params split by ,. Set * to record all.
    requestBody boolean
    Whether to record the request body.
    requestHeaders string
    The request headers to be record, support multi request headers split by ,. Set * to record all.
    responseBody boolean
    Whether to record the response body.
    responseHeaders string
    The response headers to be record, support multi response headers split by ,. Set * to record all.
    jwt_claims str
    The jwt claims to be record, support multi jwt claims split by ,. Set * to record all.
    query_string str
    The query params to be record, support multi query params split by ,. Set * to record all.
    request_body bool
    Whether to record the request body.
    request_headers str
    The request headers to be record, support multi request headers split by ,. Set * to record all.
    response_body bool
    Whether to record the response body.
    response_headers str
    The response headers to be record, support multi response headers split by ,. Set * to record all.
    jwtClaims String
    The jwt claims to be record, support multi jwt claims split by ,. Set * to record all.
    queryString String
    The query params to be record, support multi query params split by ,. Set * to record all.
    requestBody Boolean
    Whether to record the request body.
    requestHeaders String
    The request headers to be record, support multi request headers split by ,. Set * to record all.
    responseBody Boolean
    Whether to record the response body.
    responseHeaders String
    The response headers to be record, support multi response headers split by ,. Set * to record all.

    Import

    Api gateway group can be imported using the id, e.g.

    $ pulumi import alicloud:apigateway/group:Group example "ab2351f2ce904edaa8d92a0510832b91"

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.77.0 published on Friday, May 2, 2025 by Pulumi
    pulumi/pulumi-alicloud