1. Pulumi Registry
  2. Alibaba Cloud
  3. API Docs
  4. apigateway
  5. Group
alicloud logo
Alibaba Cloud v3.34.0, Mar 17 23

alicloud.apigateway.Group

Import

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

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

Example Usage

Basic Usage

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

return await Deployment.RunAsync(() => 
{
    var apiGroup = new AliCloud.ApiGateway.Group("apiGroup", new()
    {
        Description = "description of the api group",
    });

});

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, "apiGroup", &apigateway.GroupArgs{
			Description: pulumi.String("description of the api group"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 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 apiGroup = new Group("apiGroup", GroupArgs.builder()        
            .description("description of the api group")
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

api_group = alicloud.apigateway.Group("apiGroup", description="description of the api group")

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

const apiGroup = new alicloud.apigateway.Group("apiGroup", {description: "description of the api group"});

resources:
  apiGroup:
    type: alicloud:apigateway:Group
    properties:
      description: description of the api group

Create Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          instance_id: Optional[str] = None,
          name: Optional[str] = None)
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, 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.
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.

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

The Group resource accepts the following input properties:

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.

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.

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.

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.

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.

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.

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,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        sub_domain: Optional[str] = None,
        vpc_domain: Optional[str] = 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)
Resource lookup is not supported in YAML
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:
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.

VpcDomain string

(Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

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.

VpcDomain string

(Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

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.

vpcDomain String

(Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

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.

vpcDomain string

(Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

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.

vpc_domain str

(Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

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.

vpcDomain String

(Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.