Class Api

Inheritance

System.Object

Resource

CustomResource

Api

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.AliCloud.ApiGateway

Assembly: Pulumi.AliCloud.dll

Syntax

public class Api : CustomResource

Constructors

Api(String, ApiArgs, CustomResourceOptions)

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

Declaration

public Api(string name, ApiArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ApiArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiId

The ID of the api of api gateway.

Declaration

public Output<string> ApiId { get; }

Property Value

Type	Description
Output<System.String>

AuthType

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

Declaration

public Output<string> AuthType { get; }

Property Value

Type	Description
Output<System.String>

ConstantParameters

constant_parameters defines the constant parameters of the api.

Declaration

public Output<ImmutableArray<ApiConstantParameter>> ConstantParameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ApiConstantParameter>>

Description

The description of Constant parameter.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

FcServiceConfig

fc_service_config defines the config when service_type selected 'FunctionCompute'.

Declaration

public Output<ApiFcServiceConfig> FcServiceConfig { get; }

Property Value

Type	Description
Output<ApiFcServiceConfig>

GroupId

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

Declaration

public Output<string> GroupId { get; }

Property Value

Type	Description
Output<System.String>

HttpServiceConfig

http_service_config defines the config when service_type selected 'HTTP'.

Declaration

public Output<ApiHttpServiceConfig> HttpServiceConfig { get; }

Property Value

Type	Description
Output<ApiHttpServiceConfig>

HttpVpcServiceConfig

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

Declaration

public Output<ApiHttpVpcServiceConfig> HttpVpcServiceConfig { get; }

Property Value

Type	Description
Output<ApiHttpVpcServiceConfig>

MockServiceConfig

http_service_config defines the config when service_type selected 'MOCK'.

Declaration

public Output<ApiMockServiceConfig> MockServiceConfig { get; }

Property Value

Type	Description
Output<ApiMockServiceConfig>

Name

System parameter name which supports values including in system parameter list

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

RequestConfig

Request_config defines how users can send requests to your API.

Declaration

public Output<ApiRequestConfig> RequestConfig { get; }

Property Value

Type	Description
Output<ApiRequestConfig>

RequestParameters

request_parameters defines the request parameters of the api.

Declaration

public Output<ImmutableArray<ApiRequestParameter>> RequestParameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ApiRequestParameter>>

ServiceType

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

Declaration

public Output<string> ServiceType { get; }

Property Value

Type	Description
Output<System.String>

StageNames

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

Declaration

public Output<ImmutableArray<string>> StageNames { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

SystemParameters

system_parameters defines the system parameters of the api.

Declaration

public Output<ImmutableArray<ApiSystemParameter>> SystemParameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ApiSystemParameter>>

Methods

Get(String, Input<String>, ApiState, CustomResourceOptions)

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

Declaration

public static Api Get(string name, Input<string> id, ApiState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ApiState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Api