Module apigateway

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

Resources

Resource Api

class Api extends CustomResource

constructor

new Api(name: string, args: ApiArgs, opts?: pulumi.CustomResourceOptions)

Create a Api resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiState, opts?: pulumi.CustomResourceOptions): Api

Get an existing Api resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Api

Returns true if the given object is an instance of Api. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiId

public apiId: pulumi.Output<string>;

The ID of the api of api gateway.

property authType

public authType: pulumi.Output<string>;

The authorization Type including APP and ANONYMOUS. Defaults to null.

property constantParameters

public constantParameters: pulumi.Output<ApiConstantParameter[] | undefined>;

constant_parameters defines the constant parameters of the api.

property description

public description: pulumi.Output<string>;

The description of Constant parameter.

property fcServiceConfig

public fcServiceConfig: pulumi.Output<ApiFcServiceConfig | undefined>;

fc_service_config defines the config when serviceType selected ‘FunctionCompute’.

property groupId

public groupId: pulumi.Output<string>;

The api gateway that the api belongs to. Defaults to null.

property httpServiceConfig

public httpServiceConfig: pulumi.Output<ApiHttpServiceConfig | undefined>;

http_service_config defines the config when serviceType selected ‘HTTP’.

property httpVpcServiceConfig

public httpVpcServiceConfig: pulumi.Output<ApiHttpVpcServiceConfig | undefined>;

http_vpc_service_config defines the config when serviceType selected ‘HTTP-VPC’.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property mockServiceConfig

public mockServiceConfig: pulumi.Output<ApiMockServiceConfig | undefined>;

http_service_config defines the config when serviceType selected ‘MOCK’.

property name

public name: pulumi.Output<string>;

System parameter name which supports values including in system parameter list

property requestConfig

public requestConfig: pulumi.Output<ApiRequestConfig>;

Request_config defines how users can send requests to your API.

property requestParameters

public requestParameters: pulumi.Output<ApiRequestParameter[] | undefined>;

request_parameters defines the request parameters of the api.

property serviceType

public serviceType: pulumi.Output<string>;

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

property stageNames

public stageNames: pulumi.Output<string[] | undefined>;

Stages that the api need to be deployed. Valid value: RELEASE | PRE | TEST.

property systemParameters

public systemParameters: pulumi.Output<ApiSystemParameter[] | undefined>;

system_parameters defines the system parameters of the api.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource App

class App extends CustomResource

constructor

new App(name: string, args?: AppArgs, opts?: pulumi.CustomResourceOptions)

Create a App resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AppState, opts?: pulumi.CustomResourceOptions): App

Get an existing App resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is App

Returns true if the given object is an instance of App. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description of the app. Defaults to null.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the app.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AppAttachment

class AppAttachment extends CustomResource

constructor

new AppAttachment(name: string, args: AppAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a AppAttachment resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AppAttachmentState, opts?: pulumi.CustomResourceOptions): AppAttachment

Get an existing AppAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AppAttachment

Returns true if the given object is an instance of AppAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiId

public apiId: pulumi.Output<string>;

The apiId that app apply to access.

property appId

public appId: pulumi.Output<string>;

The app that apply to the authorization.

property groupId

public groupId: pulumi.Output<string>;

The group that the api belongs to.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property stageName

public stageName: pulumi.Output<string>;

Stage that the app apply to access.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Group

class Group extends CustomResource

constructor

new Group(name: string, args: GroupArgs, opts?: pulumi.CustomResourceOptions)

Create a Group resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Group

Returns true if the given object is an instance of Group. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string>;

The description of the api gateway group. Defaults to null.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the api gateway group. Defaults to null.

property subDomain

public subDomain: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcDomain

public vpcDomain: pulumi.Output<string>;

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

Resource VpcAccess

class VpcAccess extends CustomResource

constructor

new VpcAccess(name: string, args: VpcAccessArgs, opts?: pulumi.CustomResourceOptions)

Create a VpcAccess resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpcAccessState, opts?: pulumi.CustomResourceOptions): VpcAccess

Get an existing VpcAccess resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VpcAccess

Returns true if the given object is an instance of VpcAccess. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

ID of the instance in VPC (ECS/Server Load Balance).

property name

public name: pulumi.Output<string>;

The name of the vpc authorization.

property port

public port: pulumi.Output<number>;

ID of the port corresponding to the instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The vpc id of the vpc authorization.

Functions

Function getApis

getApis(args?: GetApisArgs, opts?: pulumi.InvokeOptions): Promise<GetApisResult>

This data source provides the apis of the current Alibaba Cloud user.

Example Usage

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

const dataApigatwayApis = pulumi.output(alicloud.apigateway.getApis({
    outputFile: "output_ApiGatawayApis",
}, { async: true }));

export const firstApiId = alicloud_api_gateway_apis_data_apigatway.apis.0.id;

Function getApps

getApps(args?: GetAppsArgs, opts?: pulumi.InvokeOptions): Promise<GetAppsResult>

This data source provides the apps of the current Alibaba Cloud user.

Example Usage

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

const dataApigatway = pulumi.output(alicloud.apigateway.getApps({
    outputFile: "outapps",
}, { async: true }));

export const firstAppId = dataApigatway.apps[0].id;

Function getGroups

getGroups(args?: GetGroupsArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupsResult>

This data source provides the api groups of the current Alibaba Cloud user.

Example Usage

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

const dataApigatway = pulumi.output(alicloud.apigateway.getGroups({
    outputFile: "outgroups",
}, { async: true }));

export const firstGroupId = dataApigatway.groups[0].id;

Others

interface ApiArgs

interface ApiArgs

The set of arguments for constructing a Api resource.

property authType

authType: pulumi.Input<string>;

The authorization Type including APP and ANONYMOUS. Defaults to null.

property constantParameters

constantParameters?: pulumi.Input<pulumi.Input<ApiConstantParameter>[]>;

constant_parameters defines the constant parameters of the api.

property description

description: pulumi.Input<string>;

The description of Constant parameter.

property fcServiceConfig

fcServiceConfig?: pulumi.Input<ApiFcServiceConfig>;

fc_service_config defines the config when serviceType selected ‘FunctionCompute’.

property groupId

groupId: pulumi.Input<string>;

The api gateway that the api belongs to. Defaults to null.

property httpServiceConfig

httpServiceConfig?: pulumi.Input<ApiHttpServiceConfig>;

http_service_config defines the config when serviceType selected ‘HTTP’.

property httpVpcServiceConfig

httpVpcServiceConfig?: pulumi.Input<ApiHttpVpcServiceConfig>;

http_vpc_service_config defines the config when serviceType selected ‘HTTP-VPC’.

property mockServiceConfig

mockServiceConfig?: pulumi.Input<ApiMockServiceConfig>;

http_service_config defines the config when serviceType selected ‘MOCK’.

property name

name?: pulumi.Input<string>;

System parameter name which supports values including in system parameter list

property requestConfig

requestConfig: pulumi.Input<ApiRequestConfig>;

Request_config defines how users can send requests to your API.

property requestParameters

requestParameters?: pulumi.Input<pulumi.Input<ApiRequestParameter>[]>;

request_parameters defines the request parameters of the api.

property serviceType

serviceType: pulumi.Input<string>;

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

property stageNames

stageNames?: pulumi.Input<pulumi.Input<string>[]>;

Stages that the api need to be deployed. Valid value: RELEASE | PRE | TEST.

property systemParameters

systemParameters?: pulumi.Input<pulumi.Input<ApiSystemParameter>[]>;

system_parameters defines the system parameters of the api.

interface ApiState

interface ApiState

Input properties used for looking up and filtering Api resources.

property apiId

apiId?: pulumi.Input<string>;

The ID of the api of api gateway.

property authType

authType?: pulumi.Input<string>;

The authorization Type including APP and ANONYMOUS. Defaults to null.

property constantParameters

constantParameters?: pulumi.Input<pulumi.Input<ApiConstantParameter>[]>;

constant_parameters defines the constant parameters of the api.

property description

description?: pulumi.Input<string>;

The description of Constant parameter.

property fcServiceConfig

fcServiceConfig?: pulumi.Input<ApiFcServiceConfig>;

fc_service_config defines the config when serviceType selected ‘FunctionCompute’.

property groupId

groupId?: pulumi.Input<string>;

The api gateway that the api belongs to. Defaults to null.

property httpServiceConfig

httpServiceConfig?: pulumi.Input<ApiHttpServiceConfig>;

http_service_config defines the config when serviceType selected ‘HTTP’.

property httpVpcServiceConfig

httpVpcServiceConfig?: pulumi.Input<ApiHttpVpcServiceConfig>;

http_vpc_service_config defines the config when serviceType selected ‘HTTP-VPC’.

property mockServiceConfig

mockServiceConfig?: pulumi.Input<ApiMockServiceConfig>;

http_service_config defines the config when serviceType selected ‘MOCK’.

property name

name?: pulumi.Input<string>;

System parameter name which supports values including in system parameter list

property requestConfig

requestConfig?: pulumi.Input<ApiRequestConfig>;

Request_config defines how users can send requests to your API.

property requestParameters

requestParameters?: pulumi.Input<pulumi.Input<ApiRequestParameter>[]>;

request_parameters defines the request parameters of the api.

property serviceType

serviceType?: pulumi.Input<string>;

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

property stageNames

stageNames?: pulumi.Input<pulumi.Input<string>[]>;

Stages that the api need to be deployed. Valid value: RELEASE | PRE | TEST.

property systemParameters

systemParameters?: pulumi.Input<pulumi.Input<ApiSystemParameter>[]>;

system_parameters defines the system parameters of the api.

interface AppArgs

interface AppArgs

The set of arguments for constructing a App resource.

property description

description?: pulumi.Input<string>;

The description of the app. Defaults to null.

property name

name?: pulumi.Input<string>;

The name of the app.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface AppAttachmentArgs

interface AppAttachmentArgs

The set of arguments for constructing a AppAttachment resource.

property apiId

apiId: pulumi.Input<string>;

The apiId that app apply to access.

property appId

appId: pulumi.Input<string>;

The app that apply to the authorization.

property groupId

groupId: pulumi.Input<string>;

The group that the api belongs to.

property stageName

stageName: pulumi.Input<string>;

Stage that the app apply to access.

interface AppAttachmentState

interface AppAttachmentState

Input properties used for looking up and filtering AppAttachment resources.

property apiId

apiId?: pulumi.Input<string>;

The apiId that app apply to access.

property appId

appId?: pulumi.Input<string>;

The app that apply to the authorization.

property groupId

groupId?: pulumi.Input<string>;

The group that the api belongs to.

property stageName

stageName?: pulumi.Input<string>;

Stage that the app apply to access.

interface AppState

interface AppState

Input properties used for looking up and filtering App resources.

property description

description?: pulumi.Input<string>;

The description of the app. Defaults to null.

property name

name?: pulumi.Input<string>;

The name of the app.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface GetApisArgs

interface GetApisArgs

A collection of arguments for invoking getApis.

property apiId

DEPRECATED Field 'api_id' has been deprecated from provider version 1.52.2. New field 'ids' replaces it.

apiId?: undefined | string;

(It has been deprecated from version 1.52.2, and use field ‘ids’ to replace.) ID of the specified API.

property groupId

groupId?: undefined | string;

ID of the specified group.

property ids

ids?: string[];

A list of api IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter api gateway apis by name.

property outputFile

outputFile?: undefined | string;

interface GetApisResult

interface GetApisResult

A collection of values returned by getApis.

property apiId

apiId?: undefined | string;

property apis

apis: GetApisApi[];

A list of apis. Each element contains the following attributes:

property groupId

groupId?: undefined | string;

The group id that the apis belong to.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of api IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of api names.

property outputFile

outputFile?: undefined | string;

interface GetAppsArgs

interface GetAppsArgs

A collection of arguments for invoking getApps.

property ids

ids?: string[];

A list of app IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter apps by name.

property outputFile

outputFile?: undefined | string;

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetAppsResult

interface GetAppsResult

A collection of values returned by getApps.

property apps

apps: GetAppsApp[];

A list of apps. Each element contains the following attributes:

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of app IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of app names.

property outputFile

outputFile?: undefined | string;

property tags

tags?: undefined | {[key: string]: any};

interface GetGroupsArgs

interface GetGroupsArgs

A collection of arguments for invoking getGroups.

property ids

ids?: string[];

A list of api group IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter api gateway groups by name.

property outputFile

outputFile?: undefined | string;

interface GetGroupsResult

interface GetGroupsResult

A collection of values returned by getGroups.

property groups

groups: GetGroupsGroup[];

A list of api groups. Each element contains the following attributes:

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of api group IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of api group names.

property outputFile

outputFile?: undefined | string;

interface GroupArgs

interface GroupArgs

The set of arguments for constructing a Group resource.

property description

description: pulumi.Input<string>;

The description of the api gateway group. Defaults to null.

property name

name?: pulumi.Input<string>;

The name of the api gateway group. Defaults to null.

interface GroupState

interface GroupState

Input properties used for looking up and filtering Group resources.

property description

description?: pulumi.Input<string>;

The description of the api gateway group. Defaults to null.

property name

name?: pulumi.Input<string>;

The name of the api gateway group. Defaults to null.

property subDomain

subDomain?: pulumi.Input<string>;

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

property vpcDomain

vpcDomain?: pulumi.Input<string>;

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

interface VpcAccessArgs

interface VpcAccessArgs

The set of arguments for constructing a VpcAccess resource.

property instanceId

instanceId: pulumi.Input<string>;

ID of the instance in VPC (ECS/Server Load Balance).

property name

name?: pulumi.Input<string>;

The name of the vpc authorization.

property port

port: pulumi.Input<number>;

ID of the port corresponding to the instance.

property vpcId

vpcId: pulumi.Input<string>;

The vpc id of the vpc authorization.

interface VpcAccessState

interface VpcAccessState

Input properties used for looking up and filtering VpcAccess resources.

property instanceId

instanceId?: pulumi.Input<string>;

ID of the instance in VPC (ECS/Server Load Balance).

property name

name?: pulumi.Input<string>;

The name of the vpc authorization.

property port

port?: pulumi.Input<number>;

ID of the port corresponding to the instance.

property vpcId

vpcId?: pulumi.Input<string>;

The vpc id of the vpc authorization.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module apigateway

Resources

Functions

Others

Resources

Functions

Example Usage

Example Usage

Example Usage

Others