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.

apigateway¶

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.

class pulumi_alicloud.apigateway.Api(resource_name, opts=None, auth_type=None, constant_parameters=None, description=None, fc_service_config=None, group_id=None, http_service_config=None, http_vpc_service_config=None, mock_service_config=None, name=None, request_config=None, request_parameters=None, service_type=None, stage_names=None, system_parameters=None, __props__=None, __name__=None, __opts__=None)¶

Create a Api resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] auth_type: The authorization Type including APP and ANONYMOUS. Defaults to null. :param pulumi.Input[list] constant_parameters: constant_parameters defines the constant parameters of the api. :param pulumi.Input[str] description: The description of Constant parameter. :param pulumi.Input[dict] fc_service_config: fc_service_config defines the config when service_type selected ‘FunctionCompute’. :param pulumi.Input[str] group_id: The api gateway that the api belongs to. Defaults to null. :param pulumi.Input[dict] http_service_config: http_service_config defines the config when service_type selected ‘HTTP’. :param pulumi.Input[dict] http_vpc_service_config: http_vpc_service_config defines the config when service_type selected ‘HTTP-VPC’. :param pulumi.Input[dict] mock_service_config: http_service_config defines the config when service_type selected ‘MOCK’. :param pulumi.Input[str] name: System parameter name which supports values including in system parameter list :param pulumi.Input[dict] request_config: Request_config defines how users can send requests to your API. :param pulumi.Input[list] request_parameters: request_parameters defines the request parameters of the api. :param pulumi.Input[str] service_type: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null. :param pulumi.Input[list] stage_names: Stages that the api need to be deployed. Valid value: RELEASE | PRE | TEST. :param pulumi.Input[list] system_parameters: system_parameters defines the system parameters of the api.

The constant_parameters object supports the following:

description (pulumi.Input[str]) - The description of Constant parameter.
in (pulumi.Input[str]) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
name (pulumi.Input[str]) - System parameter name which supports values including in system parameter list
value (pulumi.Input[str]) - Constant parameter value.

The fc_service_config object supports the following:

arnRole (pulumi.Input[str]) - RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
function_name (pulumi.Input[str]) - The function name of function compute service.
region (pulumi.Input[str]) - The region that the function compute service belongs to.
serviceName (pulumi.Input[str]) - The service name of function compute service.
timeout (pulumi.Input[float]) - Backend service time-out time; unit: millisecond.

The http_service_config object supports the following:

address (pulumi.Input[str]) - The address of backend service.
aoneName (pulumi.Input[str])
method (pulumi.Input[str]) - The http method of backend service.
path (pulumi.Input[str]) - The path of backend service.
timeout (pulumi.Input[float]) - Backend service time-out time; unit: millisecond.

The http_vpc_service_config object supports the following:

aoneName (pulumi.Input[str])
method (pulumi.Input[str]) - The http method of backend service.
name (pulumi.Input[str]) - System parameter name which supports values including in system parameter list
path (pulumi.Input[str]) - The path of backend service.
timeout (pulumi.Input[float]) - Backend service time-out time; unit: millisecond.

The mock_service_config object supports the following:

aoneName (pulumi.Input[str])
result (pulumi.Input[str]) - The result of the mock service.

The request_config object supports the following:

bodyFormat (pulumi.Input[str]) - The body format of the api, which support the values of ‘STREAM’ and ‘FORM’
method (pulumi.Input[str]) - The http method of backend service.
mode (pulumi.Input[str]) - The mode of the parameters between request parameters and service parameters, which support the values of ‘MAPPING’ and ‘PASSTHROUGH’
path (pulumi.Input[str]) - The path of backend service.
protocol (pulumi.Input[str]) - The protocol of api which supports values of ‘HTTP’,’HTTPS’ or ‘HTTP,HTTPS’

The request_parameters object supports the following:

defaultValue (pulumi.Input[str]) - The default value of the parameter.
description (pulumi.Input[str]) - The description of Constant parameter.
in (pulumi.Input[str]) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
inService (pulumi.Input[str]) - Backend service’s parameter location; values: BODY, HEAD, QUERY, and PATH.
name (pulumi.Input[str]) - System parameter name which supports values including in system parameter list
nameService (pulumi.Input[str]) - Backend service’s parameter name.
required (pulumi.Input[str]) - Parameter required or not; values: REQUIRED and OPTIONAL.
type (pulumi.Input[str]) - Parameter type which supports values of ‘STRING’,’INT’,’BOOLEAN’,’LONG’,”FLOAT” and “DOUBLE”

The system_parameters object supports the following:

in (pulumi.Input[str]) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
name (pulumi.Input[str]) - System parameter name which supports values including in system parameter list
nameService (pulumi.Input[str]) - Backend service’s parameter name.

api_id: pulumi.Output[str] = None¶: The ID of the api of api gateway.

auth_type: pulumi.Output[str] = None¶: The authorization Type including APP and ANONYMOUS. Defaults to null.

constant_parameters: pulumi.Output[list] = None¶

constant_parameters defines the constant parameters of the api.

description (str) - The description of Constant parameter.
in (str) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
name (str) - System parameter name which supports values including in system parameter list
value (str) - Constant parameter value.

description: pulumi.Output[str] = None¶: The description of Constant parameter.

fc_service_config: pulumi.Output[dict] = None¶

fc_service_config defines the config when service_type selected ‘FunctionCompute’.

arnRole (str) - RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
function_name (str) - The function name of function compute service.
region (str) - The region that the function compute service belongs to.
serviceName (str) - The service name of function compute service.
timeout (float) - Backend service time-out time; unit: millisecond.

group_id: pulumi.Output[str] = None¶: The api gateway that the api belongs to. Defaults to null.

http_service_config: pulumi.Output[dict] = None¶

http_service_config defines the config when service_type selected ‘HTTP’.

address (str) - The address of backend service.
aoneName (str)
method (str) - The http method of backend service.
path (str) - The path of backend service.
timeout (float) - Backend service time-out time; unit: millisecond.

http_vpc_service_config: pulumi.Output[dict] = None¶

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

aoneName (str)
method (str) - The http method of backend service.
name (str) - System parameter name which supports values including in system parameter list
path (str) - The path of backend service.
timeout (float) - Backend service time-out time; unit: millisecond.

mock_service_config: pulumi.Output[dict] = None¶

http_service_config defines the config when service_type selected ‘MOCK’.

aoneName (str)
result (str) - The result of the mock service.

name: pulumi.Output[str] = None¶: System parameter name which supports values including in system parameter list

request_config: pulumi.Output[dict] = None¶

Request_config defines how users can send requests to your API.

bodyFormat (str) - The body format of the api, which support the values of ‘STREAM’ and ‘FORM’
method (str) - The http method of backend service.
mode (str) - The mode of the parameters between request parameters and service parameters, which support the values of ‘MAPPING’ and ‘PASSTHROUGH’
path (str) - The path of backend service.
protocol (str) - The protocol of api which supports values of ‘HTTP’,’HTTPS’ or ‘HTTP,HTTPS’

request_parameters: pulumi.Output[list] = None¶

request_parameters defines the request parameters of the api.

defaultValue (str) - The default value of the parameter.
description (str) - The description of Constant parameter.
in (str) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
inService (str) - Backend service’s parameter location; values: BODY, HEAD, QUERY, and PATH.
name (str) - System parameter name which supports values including in system parameter list
nameService (str) - Backend service’s parameter name.
required (str) - Parameter required or not; values: REQUIRED and OPTIONAL.
type (str) - Parameter type which supports values of ‘STRING’,’INT’,’BOOLEAN’,’LONG’,”FLOAT” and “DOUBLE”

service_type: pulumi.Output[str] = None¶: The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

stage_names: pulumi.Output[list] = None¶: Stages that the api need to be deployed. Valid value: RELEASE | PRE | TEST.

system_parameters: pulumi.Output[list] = None¶

system_parameters defines the system parameters of the api.

in (str) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
name (str) - System parameter name which supports values including in system parameter list
nameService (str) - Backend service’s parameter name.

static get(resource_name, id, opts=None, api_id=None, auth_type=None, constant_parameters=None, description=None, fc_service_config=None, group_id=None, http_service_config=None, http_vpc_service_config=None, mock_service_config=None, name=None, request_config=None, request_parameters=None, service_type=None, stage_names=None, system_parameters=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
api_id (pulumi.Input[str]) – The ID of the api of api gateway.
auth_type (pulumi.Input[str]) – The authorization Type including APP and ANONYMOUS. Defaults to null.
constant_parameters (pulumi.Input[list]) – constant_parameters defines the constant parameters of the api.
description (pulumi.Input[str]) – The description of Constant parameter.
fc_service_config (pulumi.Input[dict]) – fc_service_config defines the config when service_type selected ‘FunctionCompute’.
group_id (pulumi.Input[str]) – The api gateway that the api belongs to. Defaults to null.
http_service_config (pulumi.Input[dict]) – http_service_config defines the config when service_type selected ‘HTTP’.
http_vpc_service_config (pulumi.Input[dict]) – http_vpc_service_config defines the config when service_type selected ‘HTTP-VPC’.
mock_service_config (pulumi.Input[dict]) – http_service_config defines the config when service_type selected ‘MOCK’.
name (pulumi.Input[str]) –
System parameter name which supports values including in system parameter list
request_config (pulumi.Input[dict]) – Request_config defines how users can send requests to your API.
request_parameters (pulumi.Input[list]) – request_parameters defines the request parameters of the api.
service_type (pulumi.Input[str]) – The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.
stage_names (pulumi.Input[list]) – Stages that the api need to be deployed. Valid value: RELEASE | PRE | TEST.
system_parameters (pulumi.Input[list]) – system_parameters defines the system parameters of the api.

The constant_parameters object supports the following:

description (pulumi.Input[str]) - The description of Constant parameter.
in (pulumi.Input[str]) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
name (pulumi.Input[str]) - System parameter name which supports values including in system parameter list
value (pulumi.Input[str]) - Constant parameter value.

The fc_service_config object supports the following:

arnRole (pulumi.Input[str]) - RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.
function_name (pulumi.Input[str]) - The function name of function compute service.
region (pulumi.Input[str]) - The region that the function compute service belongs to.
serviceName (pulumi.Input[str]) - The service name of function compute service.
timeout (pulumi.Input[float]) - Backend service time-out time; unit: millisecond.

The http_service_config object supports the following:

address (pulumi.Input[str]) - The address of backend service.
aoneName (pulumi.Input[str])
method (pulumi.Input[str]) - The http method of backend service.
path (pulumi.Input[str]) - The path of backend service.
timeout (pulumi.Input[float]) - Backend service time-out time; unit: millisecond.

The http_vpc_service_config object supports the following:

aoneName (pulumi.Input[str])
method (pulumi.Input[str]) - The http method of backend service.
name (pulumi.Input[str]) - System parameter name which supports values including in system parameter list
path (pulumi.Input[str]) - The path of backend service.
timeout (pulumi.Input[float]) - Backend service time-out time; unit: millisecond.

The mock_service_config object supports the following:

aoneName (pulumi.Input[str])
result (pulumi.Input[str]) - The result of the mock service.

The request_config object supports the following:

bodyFormat (pulumi.Input[str]) - The body format of the api, which support the values of ‘STREAM’ and ‘FORM’
method (pulumi.Input[str]) - The http method of backend service.
mode (pulumi.Input[str]) - The mode of the parameters between request parameters and service parameters, which support the values of ‘MAPPING’ and ‘PASSTHROUGH’
path (pulumi.Input[str]) - The path of backend service.
protocol (pulumi.Input[str]) - The protocol of api which supports values of ‘HTTP’,’HTTPS’ or ‘HTTP,HTTPS’

The request_parameters object supports the following:

defaultValue (pulumi.Input[str]) - The default value of the parameter.
description (pulumi.Input[str]) - The description of Constant parameter.
in (pulumi.Input[str]) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
inService (pulumi.Input[str]) - Backend service’s parameter location; values: BODY, HEAD, QUERY, and PATH.
name (pulumi.Input[str]) - System parameter name which supports values including in system parameter list
nameService (pulumi.Input[str]) - Backend service’s parameter name.
required (pulumi.Input[str]) - Parameter required or not; values: REQUIRED and OPTIONAL.
type (pulumi.Input[str]) - Parameter type which supports values of ‘STRING’,’INT’,’BOOLEAN’,’LONG’,”FLOAT” and “DOUBLE”

The system_parameters object supports the following:

in (pulumi.Input[str]) - System parameter location; values: ‘HEAD’ and ‘QUERY’.
name (pulumi.Input[str]) - System parameter name which supports values including in system parameter list
nameService (pulumi.Input[str]) - Backend service’s parameter name.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.apigateway.App(resource_name, opts=None, description=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Create a App resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: The description of the app. Defaults to null. :param pulumi.Input[str] name: The name of the app. :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource.

description: pulumi.Output[str] = None¶: The description of the app. Defaults to null.

name: pulumi.Output[str] = None¶: The name of the app.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, description=None, name=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the app. Defaults to null.
name (pulumi.Input[str]) – The name of the app.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.apigateway.AppAttachment(resource_name, opts=None, api_id=None, app_id=None, group_id=None, stage_name=None, __props__=None, __name__=None, __opts__=None)¶

Create a AppAttachment resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] api_id: The api_id that app apply to access. :param pulumi.Input[str] app_id: The app that apply to the authorization. :param pulumi.Input[str] group_id: The group that the api belongs to. :param pulumi.Input[str] stage_name: Stage that the app apply to access.

api_id: pulumi.Output[str] = None¶: The api_id that app apply to access.

app_id: pulumi.Output[str] = None¶: The app that apply to the authorization.

group_id: pulumi.Output[str] = None¶: The group that the api belongs to.

stage_name: pulumi.Output[str] = None¶: Stage that the app apply to access.

static get(resource_name, id, opts=None, api_id=None, app_id=None, group_id=None, stage_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
api_id (pulumi.Input[str]) – The api_id that app apply to access.
app_id (pulumi.Input[str]) – The app that apply to the authorization.
group_id (pulumi.Input[str]) – The group that the api belongs to.
stage_name (pulumi.Input[str]) – Stage that the app apply to access.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.apigateway.AwaitableGetApisResult(api_id=None, apis=None, group_id=None, id=None, ids=None, name_regex=None, names=None, output_file=None)¶

class pulumi_alicloud.apigateway.AwaitableGetAppsResult(apps=None, id=None, ids=None, name_regex=None, names=None, output_file=None, tags=None)¶

class pulumi_alicloud.apigateway.AwaitableGetGroupsResult(groups=None, id=None, ids=None, name_regex=None, names=None, output_file=None)¶

class pulumi_alicloud.apigateway.GetApisResult(api_id=None, apis=None, group_id=None, id=None, ids=None, name_regex=None, names=None, output_file=None)¶

A collection of values returned by getApis.

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

group_id = None¶: The group id that the apis belong to.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of api IDs.

names = None¶: A list of api names.

class pulumi_alicloud.apigateway.GetAppsResult(apps=None, id=None, ids=None, name_regex=None, names=None, output_file=None, tags=None)¶

A collection of values returned by getApps.

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

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of app IDs.

names = None¶: A list of app names.

class pulumi_alicloud.apigateway.GetGroupsResult(groups=None, id=None, ids=None, name_regex=None, names=None, output_file=None)¶

A collection of values returned by getGroups.

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

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of api group IDs.

names = None¶: A list of api group names.

class pulumi_alicloud.apigateway.Group(resource_name, opts=None, description=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Create a Group resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: The description of the api gateway group. Defaults to null. :param pulumi.Input[str] name: The name of the api gateway group. Defaults to null.

description: pulumi.Output[str] = None¶: The description of the api gateway group. Defaults to null.

name: pulumi.Output[str] = None¶: The name of the api gateway group. Defaults to null.

sub_domain: pulumi.Output[str] = None¶: (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.

vpc_domain: pulumi.Output[str] = None¶: (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

static get(resource_name, id, opts=None, description=None, name=None, sub_domain=None, vpc_domain=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the api gateway group. Defaults to null.
name (pulumi.Input[str]) – The name of the api gateway group. Defaults to null.
sub_domain (pulumi.Input[str]) – (Available in 1.69.0+) Second-level domain name automatically assigned to the API group.
vpc_domain (pulumi.Input[str]) – (Available in 1.69.0+) Second-level VPC domain name automatically assigned to the API group.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.apigateway.VpcAccess(resource_name, opts=None, instance_id=None, name=None, port=None, vpc_id=None, __props__=None, __name__=None, __opts__=None)¶

Create a VpcAccess resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] instance_id: ID of the instance in VPC (ECS/Server Load Balance). :param pulumi.Input[str] name: The name of the vpc authorization. :param pulumi.Input[float] port: ID of the port corresponding to the instance. :param pulumi.Input[str] vpc_id: The vpc id of the vpc authorization.

instance_id: pulumi.Output[str] = None¶: ID of the instance in VPC (ECS/Server Load Balance).

name: pulumi.Output[str] = None¶: The name of the vpc authorization.

port: pulumi.Output[float] = None¶: ID of the port corresponding to the instance.

vpc_id: pulumi.Output[str] = None¶: The vpc id of the vpc authorization.

static get(resource_name, id, opts=None, instance_id=None, name=None, port=None, vpc_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_id (pulumi.Input[str]) – ID of the instance in VPC (ECS/Server Load Balance).
name (pulumi.Input[str]) – The name of the vpc authorization.
port (pulumi.Input[float]) – ID of the port corresponding to the instance.
vpc_id (pulumi.Input[str]) – The vpc id of the vpc authorization.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.apigateway.get_apis(api_id=None, group_id=None, ids=None, name_regex=None, output_file=None, opts=None)¶

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

import pulumi
import pulumi_alicloud as alicloud

data_apigatway_apis = alicloud.apigateway.get_apis(output_file="output_ApiGatawayApis")
pulumi.export("firstApiId", data["apigateway.getApis"]["data_apigatway"]["apis"][0]["id"])

Parameters

api_id (str) – (It has been deprecated from version 1.52.2, and use field ‘ids’ to replace.) ID of the specified API.
group_id (str) – ID of the specified group.
ids (list) – A list of api IDs.
name_regex (str) – A regex string to filter api gateway apis by name.

pulumi_alicloud.apigateway.get_apps(ids=None, name_regex=None, output_file=None, tags=None, opts=None)¶

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

import pulumi
import pulumi_alicloud as alicloud

data_apigatway = alicloud.apigateway.get_apps(output_file="outapps")
pulumi.export("firstAppId", data_apigatway.apps[0]["id"])

Parameters

ids (list) – A list of app IDs.
name_regex (str) – A regex string to filter apps by name.
tags (dict) – A mapping of tags to assign to the resource.

pulumi_alicloud.apigateway.get_groups(ids=None, name_regex=None, output_file=None, opts=None)¶

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

import pulumi
import pulumi_alicloud as alicloud

data_apigatway = alicloud.apigateway.get_groups(output_file="outgroups")
pulumi.export("firstGroupId", data_apigatway.groups[0]["id"])

Parameters

ids (list) – A list of api group IDs.
name_regex (str) – A regex string to filter api gateway groups by name.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

apigateway¶

On This Page