sharedapig

package
v0.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 28, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PkgVersion added in v0.0.2 

func PkgVersion() (semver.Version, error)

PkgVersion uses reflection to determine the version of the current package. If a version cannot be determined, v1 will be assumed. The second return value is always nil.

Types

type Api 

type Api struct {
	pulumi.CustomResourceState

	// Specifies the security authentication mode. The value can be 'APP', 'IAM', and '
	// NONE'.
	AuthType pulumi.StringOutput `pulumi:"authType"`
	// the backend parameter list (documented below).
	BackendParameters ApiBackendParameterArrayOutput `pulumi:"backendParameters"`
	// Specifies the service backend type. The value can be:
	// + 'HTTP': the web service backend
	// + 'FUNCTION': the FunctionGraph service backend
	// + 'MOCK': the Mock service backend
	BackendType pulumi.StringOutput `pulumi:"backendType"`
	// Specifies whether CORS is supported or not.
	Cors pulumi.BoolPtrOutput `pulumi:"cors"`
	// Specifies the description of the API. The description cannot exceed 255 characters.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies the example response for a failed request The length cannot
	// exceed 20,480 characters.
	ExampleFailureResponse pulumi.StringPtrOutput `pulumi:"exampleFailureResponse"`
	// Specifies the example response for a successful request. The length
	// cannot exceed 20,480 characters.
	ExampleSuccessResponse pulumi.StringOutput `pulumi:"exampleSuccessResponse"`
	// Specifies the configuration when backendType selected 'FUNCTION' (documented
	// below).
	FunctionBackend ApiFunctionBackendPtrOutput `pulumi:"functionBackend"`
	// Specifies the ID of the API group. Changing this creates a new resource.
	GroupId pulumi.StringOutput `pulumi:"groupId"`
	// The name of the API group to which the API belongs.
	GroupName pulumi.StringOutput `pulumi:"groupName"`
	// Specifies the configuration when backendType selected 'HTTP' (documented below).
	HttpBackend ApiHttpBackendPtrOutput `pulumi:"httpBackend"`
	// Specifies the configuration when backendType selected 'MOCK' (documented below).
	MockBackend ApiMockBackendPtrOutput `pulumi:"mockBackend"`
	// Specifies the name of the API. An API name consists of 3–64 characters, starting with a
	// letter. Only letters, digits, and underscores (_) are allowed.
	Name pulumi.StringOutput `pulumi:"name"`
	// The region in which to create the API resource. If omitted, the provider-level
	// region will be used. Changing this creates a new API resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// Specifies the request method, including 'GET','POST','PUT' and etc..
	RequestMethod pulumi.StringOutput `pulumi:"requestMethod"`
	// the request parameter list (documented below).
	RequestParameters ApiRequestParameterArrayOutput `pulumi:"requestParameters"`
	// Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH'
	// which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
	RequestProtocol pulumi.StringPtrOutput `pulumi:"requestProtocol"`
	// Specifies the request path of the API. The value must comply with URI
	// specifications.
	RequestUri pulumi.StringOutput `pulumi:"requestUri"`
	// the tags of API in format of string list.
	Tags pulumi.StringArrayOutput `pulumi:"tags"`
	// Specifies the version of the API. A maximum of 16 characters are allowed.
	Version pulumi.StringOutput `pulumi:"version"`
	// Specifies whether the API is available to the public. The value can be 1 (public) and
	// 2 (private). Defaults to 2.
	Visibility pulumi.IntPtrOutput `pulumi:"visibility"`
}

Provides an API gateway API resource.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/SharedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud/SharedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tfApigwGroup, err := SharedApig.NewGroup(ctx, "tfApigwGroup", &SharedApig.GroupArgs{
			Description: pulumi.String("your descpiption"),
		})
		if err != nil {
			return err
		}
		_, err = SharedApig.NewApi(ctx, "tfApigwApi", &SharedApig.ApiArgs{
			GroupId:     tfApigwGroup.ID(),
			Description: pulumi.String("your descpiption"),
			Tags: pulumi.StringArray{
				pulumi.String("tag1"),
				pulumi.String("tag2"),
			},
			Visibility:             pulumi.Int(2),
			AuthType:               pulumi.String("IAM"),
			BackendType:            pulumi.String("HTTP"),
			RequestProtocol:        pulumi.String("HTTPS"),
			RequestMethod:          pulumi.String("GET"),
			RequestUri:             pulumi.String("/test/path1"),
			ExampleSuccessResponse: pulumi.String("example response"),
			HttpBackend: &sharedapig.ApiHttpBackendArgs{
				Protocol:  pulumi.String("HTTPS"),
				Method:    pulumi.String("GET"),
				Uri:       pulumi.String("/web/openapi"),
				UrlDomain: pulumi.String("myhuaweicloud.com"),
				Timeout:   pulumi.Int(10000),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

API can be imported using the `id`, e.g.

```sh 

$ pulumi import huaweicloud:SharedApig/api:Api api "774438a28a574ac8a496325d1bf51807"

```

func GetApi 

func GetApi(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApiState, opts ...pulumi.ResourceOption) (*Api, error)

GetApi gets an existing Api resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApi 

func NewApi(ctx *pulumi.Context,
	name string, args *ApiArgs, opts ...pulumi.ResourceOption) (*Api, error)

NewApi registers a new resource with the given unique name, arguments, and options.

func (*Api) ElementType 

func (*Api) ElementType() reflect.Type

func (*Api) ToApiOutput 

func (i *Api) ToApiOutput() ApiOutput

func (*Api) ToApiOutputWithContext 

func (i *Api) ToApiOutputWithContext(ctx context.Context) ApiOutput

type ApiArgs 

type ApiArgs struct {
	// Specifies the security authentication mode. The value can be 'APP', 'IAM', and '
	// NONE'.
	AuthType pulumi.StringInput
	// the backend parameter list (documented below).
	BackendParameters ApiBackendParameterArrayInput
	// Specifies the service backend type. The value can be:
	// + 'HTTP': the web service backend
	// + 'FUNCTION': the FunctionGraph service backend
	// + 'MOCK': the Mock service backend
	BackendType pulumi.StringInput
	// Specifies whether CORS is supported or not.
	Cors pulumi.BoolPtrInput
	// Specifies the description of the API. The description cannot exceed 255 characters.
	Description pulumi.StringPtrInput
	// Specifies the example response for a failed request The length cannot
	// exceed 20,480 characters.
	ExampleFailureResponse pulumi.StringPtrInput
	// Specifies the example response for a successful request. The length
	// cannot exceed 20,480 characters.
	ExampleSuccessResponse pulumi.StringInput
	// Specifies the configuration when backendType selected 'FUNCTION' (documented
	// below).
	FunctionBackend ApiFunctionBackendPtrInput
	// Specifies the ID of the API group. Changing this creates a new resource.
	GroupId pulumi.StringInput
	// Specifies the configuration when backendType selected 'HTTP' (documented below).
	HttpBackend ApiHttpBackendPtrInput
	// Specifies the configuration when backendType selected 'MOCK' (documented below).
	MockBackend ApiMockBackendPtrInput
	// Specifies the name of the API. An API name consists of 3–64 characters, starting with a
	// letter. Only letters, digits, and underscores (_) are allowed.
	Name pulumi.StringPtrInput
	// The region in which to create the API resource. If omitted, the provider-level
	// region will be used. Changing this creates a new API resource.
	Region pulumi.StringPtrInput
	// Specifies the request method, including 'GET','POST','PUT' and etc..
	RequestMethod pulumi.StringInput
	// the request parameter list (documented below).
	RequestParameters ApiRequestParameterArrayInput
	// Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH'
	// which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
	RequestProtocol pulumi.StringPtrInput
	// Specifies the request path of the API. The value must comply with URI
	// specifications.
	RequestUri pulumi.StringInput
	// the tags of API in format of string list.
	Tags pulumi.StringArrayInput
	// Specifies the version of the API. A maximum of 16 characters are allowed.
	Version pulumi.StringPtrInput
	// Specifies whether the API is available to the public. The value can be 1 (public) and
	// 2 (private). Defaults to 2.
	Visibility pulumi.IntPtrInput
}

The set of arguments for constructing a Api resource.

func (ApiArgs) ElementType 

func (ApiArgs) ElementType() reflect.Type

type ApiArray 

type ApiArray []ApiInput

func (ApiArray) ElementType 

func (ApiArray) ElementType() reflect.Type

func (ApiArray) ToApiArrayOutput 

func (i ApiArray) ToApiArrayOutput() ApiArrayOutput

func (ApiArray) ToApiArrayOutputWithContext 

func (i ApiArray) ToApiArrayOutputWithContext(ctx context.Context) ApiArrayOutput

type ApiArrayInput 

type ApiArrayInput interface {
	pulumi.Input

	ToApiArrayOutput() ApiArrayOutput
	ToApiArrayOutputWithContext(context.Context) ApiArrayOutput
}

ApiArrayInput is an input type that accepts ApiArray and ApiArrayOutput values. You can construct a concrete instance of `ApiArrayInput` via: 

ApiArray{ ApiArgs{...} }

type ApiArrayOutput 

type ApiArrayOutput struct{ *pulumi.OutputState }

func (ApiArrayOutput) ElementType 

func (ApiArrayOutput) ElementType() reflect.Type

func (ApiArrayOutput) Index 

func (o ApiArrayOutput) Index(i pulumi.IntInput) ApiOutput

func (ApiArrayOutput) ToApiArrayOutput 

func (o ApiArrayOutput) ToApiArrayOutput() ApiArrayOutput

func (ApiArrayOutput) ToApiArrayOutputWithContext 

func (o ApiArrayOutput) ToApiArrayOutputWithContext(ctx context.Context) ApiArrayOutput

type ApiBackendParameter 

type ApiBackendParameter struct {
	// Specifies the description of the parameter. The description cannot exceed 255
	// characters.
	Description *string `pulumi:"description"`
	// Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
	Location string `pulumi:"location"`
	// Specifies the parameter name. A parameter name consists of 1–32 characters, starting with
	// a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.
	Type *string `pulumi:"type"`
	// Specifies the parameter value, which is a string of not more than 255 characters. The
	// value varies depending on the parameter type:
	// + 'REQUEST': parameter name in `requestParameter`
	// + 'CONSTANT': real value of the parameter
	// + 'SYSTEM': gateway parameter name
	Value string `pulumi:"value"`
}

type ApiBackendParameterArgs 

type ApiBackendParameterArgs struct {
	// Specifies the description of the parameter. The description cannot exceed 255
	// characters.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
	Location pulumi.StringInput `pulumi:"location"`
	// Specifies the parameter name. A parameter name consists of 1–32 characters, starting with
	// a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.
	Type pulumi.StringPtrInput `pulumi:"type"`
	// Specifies the parameter value, which is a string of not more than 255 characters. The
	// value varies depending on the parameter type:
	// + 'REQUEST': parameter name in `requestParameter`
	// + 'CONSTANT': real value of the parameter
	// + 'SYSTEM': gateway parameter name
	Value pulumi.StringInput `pulumi:"value"`
}

func (ApiBackendParameterArgs) ElementType 

func (ApiBackendParameterArgs) ElementType() reflect.Type

func (ApiBackendParameterArgs) ToApiBackendParameterOutput 

func (i ApiBackendParameterArgs) ToApiBackendParameterOutput() ApiBackendParameterOutput

func (ApiBackendParameterArgs) ToApiBackendParameterOutputWithContext 

func (i ApiBackendParameterArgs) ToApiBackendParameterOutputWithContext(ctx context.Context) ApiBackendParameterOutput

type ApiBackendParameterArray 

type ApiBackendParameterArray []ApiBackendParameterInput

func (ApiBackendParameterArray) ElementType 

func (ApiBackendParameterArray) ElementType() reflect.Type

func (ApiBackendParameterArray) ToApiBackendParameterArrayOutput 

func (i ApiBackendParameterArray) ToApiBackendParameterArrayOutput() ApiBackendParameterArrayOutput

func (ApiBackendParameterArray) ToApiBackendParameterArrayOutputWithContext 

func (i ApiBackendParameterArray) ToApiBackendParameterArrayOutputWithContext(ctx context.Context) ApiBackendParameterArrayOutput

type ApiBackendParameterArrayInput 

type ApiBackendParameterArrayInput interface {
	pulumi.Input

	ToApiBackendParameterArrayOutput() ApiBackendParameterArrayOutput
	ToApiBackendParameterArrayOutputWithContext(context.Context) ApiBackendParameterArrayOutput
}

ApiBackendParameterArrayInput is an input type that accepts ApiBackendParameterArray and ApiBackendParameterArrayOutput values. You can construct a concrete instance of `ApiBackendParameterArrayInput` via: 

ApiBackendParameterArray{ ApiBackendParameterArgs{...} }

type ApiBackendParameterArrayOutput 

type ApiBackendParameterArrayOutput struct{ *pulumi.OutputState }

func (ApiBackendParameterArrayOutput) ElementType 

func (ApiBackendParameterArrayOutput) ElementType() reflect.Type

func (ApiBackendParameterArrayOutput) Index 

func (o ApiBackendParameterArrayOutput) Index(i pulumi.IntInput) ApiBackendParameterOutput

func (ApiBackendParameterArrayOutput) ToApiBackendParameterArrayOutput 

func (o ApiBackendParameterArrayOutput) ToApiBackendParameterArrayOutput() ApiBackendParameterArrayOutput

func (ApiBackendParameterArrayOutput) ToApiBackendParameterArrayOutputWithContext 

func (o ApiBackendParameterArrayOutput) ToApiBackendParameterArrayOutputWithContext(ctx context.Context) ApiBackendParameterArrayOutput

type ApiBackendParameterInput 

type ApiBackendParameterInput interface {
	pulumi.Input

	ToApiBackendParameterOutput() ApiBackendParameterOutput
	ToApiBackendParameterOutputWithContext(context.Context) ApiBackendParameterOutput
}

ApiBackendParameterInput is an input type that accepts ApiBackendParameterArgs and ApiBackendParameterOutput values. You can construct a concrete instance of `ApiBackendParameterInput` via: 

ApiBackendParameterArgs{...}

type ApiBackendParameterOutput 

type ApiBackendParameterOutput struct{ *pulumi.OutputState }

func (ApiBackendParameterOutput) Description 

func (o ApiBackendParameterOutput) Description() pulumi.StringPtrOutput

Specifies the description of the parameter. The description cannot exceed 255 characters.

func (ApiBackendParameterOutput) ElementType 

func (ApiBackendParameterOutput) ElementType() reflect.Type

func (ApiBackendParameterOutput) Location 

func (o ApiBackendParameterOutput) Location() pulumi.StringOutput

Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.

func (ApiBackendParameterOutput) Name 

func (o ApiBackendParameterOutput) Name() pulumi.StringOutput

Specifies the parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

func (ApiBackendParameterOutput) ToApiBackendParameterOutput 

func (o ApiBackendParameterOutput) ToApiBackendParameterOutput() ApiBackendParameterOutput

func (ApiBackendParameterOutput) ToApiBackendParameterOutputWithContext 

func (o ApiBackendParameterOutput) ToApiBackendParameterOutputWithContext(ctx context.Context) ApiBackendParameterOutput

func (ApiBackendParameterOutput) Type 

func (o ApiBackendParameterOutput) Type() pulumi.StringPtrOutput

Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.

func (ApiBackendParameterOutput) Value 

func (o ApiBackendParameterOutput) Value() pulumi.StringOutput

Specifies the parameter value, which is a string of not more than 255 characters. The value varies depending on the parameter type: + 'REQUEST': parameter name in `requestParameter` + 'CONSTANT': real value of the parameter + 'SYSTEM': gateway parameter name

type ApiFunctionBackend 

type ApiFunctionBackend struct {
	// Specifies the function URN.
	FunctionUrn string `pulumi:"functionUrn"`
	// Specifies the invocation mode, which can be 'async' or 'sync'.
	InvocationType string `pulumi:"invocationType"`
	// Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.
	Timeout *int `pulumi:"timeout"`
	// Specifies the function version.
	Version string `pulumi:"version"`
}

type ApiFunctionBackendArgs 

type ApiFunctionBackendArgs struct {
	// Specifies the function URN.
	FunctionUrn pulumi.StringInput `pulumi:"functionUrn"`
	// Specifies the invocation mode, which can be 'async' or 'sync'.
	InvocationType pulumi.StringInput `pulumi:"invocationType"`
	// Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// Specifies the function version.
	Version pulumi.StringInput `pulumi:"version"`
}

func (ApiFunctionBackendArgs) ElementType 

func (ApiFunctionBackendArgs) ElementType() reflect.Type

func (ApiFunctionBackendArgs) ToApiFunctionBackendOutput 

func (i ApiFunctionBackendArgs) ToApiFunctionBackendOutput() ApiFunctionBackendOutput

func (ApiFunctionBackendArgs) ToApiFunctionBackendOutputWithContext 

func (i ApiFunctionBackendArgs) ToApiFunctionBackendOutputWithContext(ctx context.Context) ApiFunctionBackendOutput

func (ApiFunctionBackendArgs) ToApiFunctionBackendPtrOutput 

func (i ApiFunctionBackendArgs) ToApiFunctionBackendPtrOutput() ApiFunctionBackendPtrOutput

func (ApiFunctionBackendArgs) ToApiFunctionBackendPtrOutputWithContext 

func (i ApiFunctionBackendArgs) ToApiFunctionBackendPtrOutputWithContext(ctx context.Context) ApiFunctionBackendPtrOutput

type ApiFunctionBackendInput 

type ApiFunctionBackendInput interface {
	pulumi.Input

	ToApiFunctionBackendOutput() ApiFunctionBackendOutput
	ToApiFunctionBackendOutputWithContext(context.Context) ApiFunctionBackendOutput
}

ApiFunctionBackendInput is an input type that accepts ApiFunctionBackendArgs and ApiFunctionBackendOutput values. You can construct a concrete instance of `ApiFunctionBackendInput` via: 

ApiFunctionBackendArgs{...}

type ApiFunctionBackendOutput 

type ApiFunctionBackendOutput struct{ *pulumi.OutputState }

func (ApiFunctionBackendOutput) ElementType 

func (ApiFunctionBackendOutput) ElementType() reflect.Type

func (ApiFunctionBackendOutput) FunctionUrn 

func (o ApiFunctionBackendOutput) FunctionUrn() pulumi.StringOutput

Specifies the function URN.

func (ApiFunctionBackendOutput) InvocationType 

func (o ApiFunctionBackendOutput) InvocationType() pulumi.StringOutput

Specifies the invocation mode, which can be 'async' or 'sync'.

func (ApiFunctionBackendOutput) Timeout 

func (o ApiFunctionBackendOutput) Timeout() pulumi.IntPtrOutput

Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.

func (ApiFunctionBackendOutput) ToApiFunctionBackendOutput 

func (o ApiFunctionBackendOutput) ToApiFunctionBackendOutput() ApiFunctionBackendOutput

func (ApiFunctionBackendOutput) ToApiFunctionBackendOutputWithContext 

func (o ApiFunctionBackendOutput) ToApiFunctionBackendOutputWithContext(ctx context.Context) ApiFunctionBackendOutput

func (ApiFunctionBackendOutput) ToApiFunctionBackendPtrOutput 

func (o ApiFunctionBackendOutput) ToApiFunctionBackendPtrOutput() ApiFunctionBackendPtrOutput

func (ApiFunctionBackendOutput) ToApiFunctionBackendPtrOutputWithContext 

func (o ApiFunctionBackendOutput) ToApiFunctionBackendPtrOutputWithContext(ctx context.Context) ApiFunctionBackendPtrOutput

func (ApiFunctionBackendOutput) Version 

func (o ApiFunctionBackendOutput) Version() pulumi.StringOutput

Specifies the function version.

type ApiFunctionBackendPtrInput 

type ApiFunctionBackendPtrInput interface {
	pulumi.Input

	ToApiFunctionBackendPtrOutput() ApiFunctionBackendPtrOutput
	ToApiFunctionBackendPtrOutputWithContext(context.Context) ApiFunctionBackendPtrOutput
}

ApiFunctionBackendPtrInput is an input type that accepts ApiFunctionBackendArgs, ApiFunctionBackendPtr and ApiFunctionBackendPtrOutput values. You can construct a concrete instance of `ApiFunctionBackendPtrInput` via: 

        ApiFunctionBackendArgs{...}

or:

        nil

func ApiFunctionBackendPtr 

func ApiFunctionBackendPtr(v *ApiFunctionBackendArgs) ApiFunctionBackendPtrInput

type ApiFunctionBackendPtrOutput 

type ApiFunctionBackendPtrOutput struct{ *pulumi.OutputState }

func (ApiFunctionBackendPtrOutput) Elem 

func (o ApiFunctionBackendPtrOutput) Elem() ApiFunctionBackendOutput

func (ApiFunctionBackendPtrOutput) ElementType 

func (ApiFunctionBackendPtrOutput) ElementType() reflect.Type

func (ApiFunctionBackendPtrOutput) FunctionUrn 

func (o ApiFunctionBackendPtrOutput) FunctionUrn() pulumi.StringPtrOutput

Specifies the function URN.

func (ApiFunctionBackendPtrOutput) InvocationType 

func (o ApiFunctionBackendPtrOutput) InvocationType() pulumi.StringPtrOutput

Specifies the invocation mode, which can be 'async' or 'sync'.

func (ApiFunctionBackendPtrOutput) Timeout 

func (o ApiFunctionBackendPtrOutput) Timeout() pulumi.IntPtrOutput

Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.

func (ApiFunctionBackendPtrOutput) ToApiFunctionBackendPtrOutput 

func (o ApiFunctionBackendPtrOutput) ToApiFunctionBackendPtrOutput() ApiFunctionBackendPtrOutput

func (ApiFunctionBackendPtrOutput) ToApiFunctionBackendPtrOutputWithContext 

func (o ApiFunctionBackendPtrOutput) ToApiFunctionBackendPtrOutputWithContext(ctx context.Context) ApiFunctionBackendPtrOutput

func (ApiFunctionBackendPtrOutput) Version 

func (o ApiFunctionBackendPtrOutput) Version() pulumi.StringPtrOutput

Specifies the function version.

type ApiHttpBackend 

type ApiHttpBackend struct {
	// Specifies the backend request method, including 'GET','POST','PUT' and etc..
	Method string `pulumi:"method"`
	// Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.
	Protocol string `pulumi:"protocol"`
	// Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to
	// 50000.
	Timeout *int `pulumi:"timeout"`
	// Specifies the backend request path. The value must comply with URI specifications.
	Uri string `pulumi:"uri"`
	// Specifies the backend service address. An endpoint URL is in the format of
	// "domain name (or IP address):port number", with up to 255 characters. This parameter and `vpcChannel` are
	// alternative.
	UrlDomain *string `pulumi:"urlDomain"`
	// Specifies the VPC channel ID. This parameter and `urlDomain` are alternative.
	VpcChannel *string `pulumi:"vpcChannel"`
}

type ApiHttpBackendArgs 

type ApiHttpBackendArgs struct {
	// Specifies the backend request method, including 'GET','POST','PUT' and etc..
	Method pulumi.StringInput `pulumi:"method"`
	// Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.
	Protocol pulumi.StringInput `pulumi:"protocol"`
	// Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to
	// 50000.
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// Specifies the backend request path. The value must comply with URI specifications.
	Uri pulumi.StringInput `pulumi:"uri"`
	// Specifies the backend service address. An endpoint URL is in the format of
	// "domain name (or IP address):port number", with up to 255 characters. This parameter and `vpcChannel` are
	// alternative.
	UrlDomain pulumi.StringPtrInput `pulumi:"urlDomain"`
	// Specifies the VPC channel ID. This parameter and `urlDomain` are alternative.
	VpcChannel pulumi.StringPtrInput `pulumi:"vpcChannel"`
}

func (ApiHttpBackendArgs) ElementType 

func (ApiHttpBackendArgs) ElementType() reflect.Type

func (ApiHttpBackendArgs) ToApiHttpBackendOutput 

func (i ApiHttpBackendArgs) ToApiHttpBackendOutput() ApiHttpBackendOutput

func (ApiHttpBackendArgs) ToApiHttpBackendOutputWithContext 

func (i ApiHttpBackendArgs) ToApiHttpBackendOutputWithContext(ctx context.Context) ApiHttpBackendOutput

func (ApiHttpBackendArgs) ToApiHttpBackendPtrOutput 

func (i ApiHttpBackendArgs) ToApiHttpBackendPtrOutput() ApiHttpBackendPtrOutput

func (ApiHttpBackendArgs) ToApiHttpBackendPtrOutputWithContext 

func (i ApiHttpBackendArgs) ToApiHttpBackendPtrOutputWithContext(ctx context.Context) ApiHttpBackendPtrOutput

type ApiHttpBackendInput 

type ApiHttpBackendInput interface {
	pulumi.Input

	ToApiHttpBackendOutput() ApiHttpBackendOutput
	ToApiHttpBackendOutputWithContext(context.Context) ApiHttpBackendOutput
}

ApiHttpBackendInput is an input type that accepts ApiHttpBackendArgs and ApiHttpBackendOutput values. You can construct a concrete instance of `ApiHttpBackendInput` via: 

ApiHttpBackendArgs{...}

type ApiHttpBackendOutput 

type ApiHttpBackendOutput struct{ *pulumi.OutputState }

func (ApiHttpBackendOutput) ElementType 

func (ApiHttpBackendOutput) ElementType() reflect.Type

func (ApiHttpBackendOutput) Method 

func (o ApiHttpBackendOutput) Method() pulumi.StringOutput

Specifies the backend request method, including 'GET','POST','PUT' and etc..

func (ApiHttpBackendOutput) Protocol 

func (o ApiHttpBackendOutput) Protocol() pulumi.StringOutput

Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.

func (ApiHttpBackendOutput) Timeout 

func (o ApiHttpBackendOutput) Timeout() pulumi.IntPtrOutput

Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to 50000.

func (ApiHttpBackendOutput) ToApiHttpBackendOutput 

func (o ApiHttpBackendOutput) ToApiHttpBackendOutput() ApiHttpBackendOutput

func (ApiHttpBackendOutput) ToApiHttpBackendOutputWithContext 

func (o ApiHttpBackendOutput) ToApiHttpBackendOutputWithContext(ctx context.Context) ApiHttpBackendOutput

func (ApiHttpBackendOutput) ToApiHttpBackendPtrOutput 

func (o ApiHttpBackendOutput) ToApiHttpBackendPtrOutput() ApiHttpBackendPtrOutput

func (ApiHttpBackendOutput) ToApiHttpBackendPtrOutputWithContext 

func (o ApiHttpBackendOutput) ToApiHttpBackendPtrOutputWithContext(ctx context.Context) ApiHttpBackendPtrOutput

func (ApiHttpBackendOutput) Uri 

func (o ApiHttpBackendOutput) Uri() pulumi.StringOutput

Specifies the backend request path. The value must comply with URI specifications.

func (ApiHttpBackendOutput) UrlDomain 

func (o ApiHttpBackendOutput) UrlDomain() pulumi.StringPtrOutput

Specifies the backend service address. An endpoint URL is in the format of "domain name (or IP address):port number", with up to 255 characters. This parameter and `vpcChannel` are alternative.

func (ApiHttpBackendOutput) VpcChannel 

func (o ApiHttpBackendOutput) VpcChannel() pulumi.StringPtrOutput

Specifies the VPC channel ID. This parameter and `urlDomain` are alternative.

type ApiHttpBackendPtrInput 

type ApiHttpBackendPtrInput interface {
	pulumi.Input

	ToApiHttpBackendPtrOutput() ApiHttpBackendPtrOutput
	ToApiHttpBackendPtrOutputWithContext(context.Context) ApiHttpBackendPtrOutput
}

ApiHttpBackendPtrInput is an input type that accepts ApiHttpBackendArgs, ApiHttpBackendPtr and ApiHttpBackendPtrOutput values. You can construct a concrete instance of `ApiHttpBackendPtrInput` via: 

        ApiHttpBackendArgs{...}

or:

        nil

func ApiHttpBackendPtr 

func ApiHttpBackendPtr(v *ApiHttpBackendArgs) ApiHttpBackendPtrInput

type ApiHttpBackendPtrOutput 

type ApiHttpBackendPtrOutput struct{ *pulumi.OutputState }

func (ApiHttpBackendPtrOutput) Elem 

func (o ApiHttpBackendPtrOutput) Elem() ApiHttpBackendOutput

func (ApiHttpBackendPtrOutput) ElementType 

func (ApiHttpBackendPtrOutput) ElementType() reflect.Type

func (ApiHttpBackendPtrOutput) Method 

func (o ApiHttpBackendPtrOutput) Method() pulumi.StringPtrOutput

Specifies the backend request method, including 'GET','POST','PUT' and etc..

func (ApiHttpBackendPtrOutput) Protocol 

func (o ApiHttpBackendPtrOutput) Protocol() pulumi.StringPtrOutput

Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.

func (ApiHttpBackendPtrOutput) Timeout 

func (o ApiHttpBackendPtrOutput) Timeout() pulumi.IntPtrOutput

Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to 50000.

func (ApiHttpBackendPtrOutput) ToApiHttpBackendPtrOutput 

func (o ApiHttpBackendPtrOutput) ToApiHttpBackendPtrOutput() ApiHttpBackendPtrOutput

func (ApiHttpBackendPtrOutput) ToApiHttpBackendPtrOutputWithContext 

func (o ApiHttpBackendPtrOutput) ToApiHttpBackendPtrOutputWithContext(ctx context.Context) ApiHttpBackendPtrOutput

func (ApiHttpBackendPtrOutput) Uri 

func (o ApiHttpBackendPtrOutput) Uri() pulumi.StringPtrOutput

Specifies the backend request path. The value must comply with URI specifications.

func (ApiHttpBackendPtrOutput) UrlDomain 

func (o ApiHttpBackendPtrOutput) UrlDomain() pulumi.StringPtrOutput

Specifies the backend service address. An endpoint URL is in the format of "domain name (or IP address):port number", with up to 255 characters. This parameter and `vpcChannel` are alternative.

func (ApiHttpBackendPtrOutput) VpcChannel 

func (o ApiHttpBackendPtrOutput) VpcChannel() pulumi.StringPtrOutput

Specifies the VPC channel ID. This parameter and `urlDomain` are alternative.

type ApiInput 

type ApiInput interface {
	pulumi.Input

	ToApiOutput() ApiOutput
	ToApiOutputWithContext(ctx context.Context) ApiOutput
}

type ApiMap 

type ApiMap map[string]ApiInput

func (ApiMap) ElementType 

func (ApiMap) ElementType() reflect.Type

func (ApiMap) ToApiMapOutput 

func (i ApiMap) ToApiMapOutput() ApiMapOutput

func (ApiMap) ToApiMapOutputWithContext 

func (i ApiMap) ToApiMapOutputWithContext(ctx context.Context) ApiMapOutput

type ApiMapInput 

type ApiMapInput interface {
	pulumi.Input

	ToApiMapOutput() ApiMapOutput
	ToApiMapOutputWithContext(context.Context) ApiMapOutput
}

ApiMapInput is an input type that accepts ApiMap and ApiMapOutput values. You can construct a concrete instance of `ApiMapInput` via: 

ApiMap{ "key": ApiArgs{...} }

type ApiMapOutput 

type ApiMapOutput struct{ *pulumi.OutputState }

func (ApiMapOutput) ElementType 

func (ApiMapOutput) ElementType() reflect.Type

func (ApiMapOutput) MapIndex 

func (o ApiMapOutput) MapIndex(k pulumi.StringInput) ApiOutput

func (ApiMapOutput) ToApiMapOutput 

func (o ApiMapOutput) ToApiMapOutput() ApiMapOutput

func (ApiMapOutput) ToApiMapOutputWithContext 

func (o ApiMapOutput) ToApiMapOutputWithContext(ctx context.Context) ApiMapOutput

type ApiMockBackend 

type ApiMockBackend struct {
	// Specifies the description of the Mock backend. The description cannot exceed 255
	// characters.
	Description *string `pulumi:"description"`
	// Specifies the return result.
	ResultContent *string `pulumi:"resultContent"`
	// Specifies the version of the Mock backend.
	Version *string `pulumi:"version"`
}

type ApiMockBackendArgs 

type ApiMockBackendArgs struct {
	// Specifies the description of the Mock backend. The description cannot exceed 255
	// characters.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the return result.
	ResultContent pulumi.StringPtrInput `pulumi:"resultContent"`
	// Specifies the version of the Mock backend.
	Version pulumi.StringPtrInput `pulumi:"version"`
}

func (ApiMockBackendArgs) ElementType 

func (ApiMockBackendArgs) ElementType() reflect.Type

func (ApiMockBackendArgs) ToApiMockBackendOutput 

func (i ApiMockBackendArgs) ToApiMockBackendOutput() ApiMockBackendOutput

func (ApiMockBackendArgs) ToApiMockBackendOutputWithContext 

func (i ApiMockBackendArgs) ToApiMockBackendOutputWithContext(ctx context.Context) ApiMockBackendOutput

func (ApiMockBackendArgs) ToApiMockBackendPtrOutput 

func (i ApiMockBackendArgs) ToApiMockBackendPtrOutput() ApiMockBackendPtrOutput

func (ApiMockBackendArgs) ToApiMockBackendPtrOutputWithContext 

func (i ApiMockBackendArgs) ToApiMockBackendPtrOutputWithContext(ctx context.Context) ApiMockBackendPtrOutput

type ApiMockBackendInput 

type ApiMockBackendInput interface {
	pulumi.Input

	ToApiMockBackendOutput() ApiMockBackendOutput
	ToApiMockBackendOutputWithContext(context.Context) ApiMockBackendOutput
}

ApiMockBackendInput is an input type that accepts ApiMockBackendArgs and ApiMockBackendOutput values. You can construct a concrete instance of `ApiMockBackendInput` via: 

ApiMockBackendArgs{...}

type ApiMockBackendOutput 

type ApiMockBackendOutput struct{ *pulumi.OutputState }

func (ApiMockBackendOutput) Description 

func (o ApiMockBackendOutput) Description() pulumi.StringPtrOutput

Specifies the description of the Mock backend. The description cannot exceed 255 characters.

func (ApiMockBackendOutput) ElementType 

func (ApiMockBackendOutput) ElementType() reflect.Type

func (ApiMockBackendOutput) ResultContent 

func (o ApiMockBackendOutput) ResultContent() pulumi.StringPtrOutput

Specifies the return result.

func (ApiMockBackendOutput) ToApiMockBackendOutput 

func (o ApiMockBackendOutput) ToApiMockBackendOutput() ApiMockBackendOutput

func (ApiMockBackendOutput) ToApiMockBackendOutputWithContext 

func (o ApiMockBackendOutput) ToApiMockBackendOutputWithContext(ctx context.Context) ApiMockBackendOutput

func (ApiMockBackendOutput) ToApiMockBackendPtrOutput 

func (o ApiMockBackendOutput) ToApiMockBackendPtrOutput() ApiMockBackendPtrOutput

func (ApiMockBackendOutput) ToApiMockBackendPtrOutputWithContext 

func (o ApiMockBackendOutput) ToApiMockBackendPtrOutputWithContext(ctx context.Context) ApiMockBackendPtrOutput

func (ApiMockBackendOutput) Version 

func (o ApiMockBackendOutput) Version() pulumi.StringPtrOutput

Specifies the version of the Mock backend.

type ApiMockBackendPtrInput 

type ApiMockBackendPtrInput interface {
	pulumi.Input

	ToApiMockBackendPtrOutput() ApiMockBackendPtrOutput
	ToApiMockBackendPtrOutputWithContext(context.Context) ApiMockBackendPtrOutput
}

ApiMockBackendPtrInput is an input type that accepts ApiMockBackendArgs, ApiMockBackendPtr and ApiMockBackendPtrOutput values. You can construct a concrete instance of `ApiMockBackendPtrInput` via: 

        ApiMockBackendArgs{...}

or:

        nil

func ApiMockBackendPtr 

func ApiMockBackendPtr(v *ApiMockBackendArgs) ApiMockBackendPtrInput

type ApiMockBackendPtrOutput 

type ApiMockBackendPtrOutput struct{ *pulumi.OutputState }

func (ApiMockBackendPtrOutput) Description 

func (o ApiMockBackendPtrOutput) Description() pulumi.StringPtrOutput

Specifies the description of the Mock backend. The description cannot exceed 255 characters.

func (ApiMockBackendPtrOutput) Elem 

func (o ApiMockBackendPtrOutput) Elem() ApiMockBackendOutput

func (ApiMockBackendPtrOutput) ElementType 

func (ApiMockBackendPtrOutput) ElementType() reflect.Type

func (ApiMockBackendPtrOutput) ResultContent 

func (o ApiMockBackendPtrOutput) ResultContent() pulumi.StringPtrOutput

Specifies the return result.

func (ApiMockBackendPtrOutput) ToApiMockBackendPtrOutput 

func (o ApiMockBackendPtrOutput) ToApiMockBackendPtrOutput() ApiMockBackendPtrOutput

func (ApiMockBackendPtrOutput) ToApiMockBackendPtrOutputWithContext 

func (o ApiMockBackendPtrOutput) ToApiMockBackendPtrOutputWithContext(ctx context.Context) ApiMockBackendPtrOutput

func (ApiMockBackendPtrOutput) Version 

func (o ApiMockBackendPtrOutput) Version() pulumi.StringPtrOutput

Specifies the version of the Mock backend.

type ApiOutput 

type ApiOutput struct{ *pulumi.OutputState }

func (ApiOutput) AuthType 

func (o ApiOutput) AuthType() pulumi.StringOutput

Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.

func (ApiOutput) BackendParameters 

func (o ApiOutput) BackendParameters() ApiBackendParameterArrayOutput

the backend parameter list (documented below).

func (ApiOutput) BackendType 

func (o ApiOutput) BackendType() pulumi.StringOutput

Specifies the service backend type. The value can be: + 'HTTP': the web service backend + 'FUNCTION': the FunctionGraph service backend + 'MOCK': the Mock service backend

func (ApiOutput) Cors 

func (o ApiOutput) Cors() pulumi.BoolPtrOutput

Specifies whether CORS is supported or not.

func (ApiOutput) Description 

func (o ApiOutput) Description() pulumi.StringPtrOutput

Specifies the description of the API. The description cannot exceed 255 characters.

func (ApiOutput) ElementType 

func (ApiOutput) ElementType() reflect.Type

func (ApiOutput) ExampleFailureResponse 

func (o ApiOutput) ExampleFailureResponse() pulumi.StringPtrOutput

Specifies the example response for a failed request The length cannot exceed 20,480 characters.

func (ApiOutput) ExampleSuccessResponse 

func (o ApiOutput) ExampleSuccessResponse() pulumi.StringOutput

Specifies the example response for a successful request. The length cannot exceed 20,480 characters.

func (ApiOutput) FunctionBackend 

func (o ApiOutput) FunctionBackend() ApiFunctionBackendPtrOutput

Specifies the configuration when backendType selected 'FUNCTION' (documented below).

func (ApiOutput) GroupId 

func (o ApiOutput) GroupId() pulumi.StringOutput

Specifies the ID of the API group. Changing this creates a new resource.

func (ApiOutput) GroupName 

func (o ApiOutput) GroupName() pulumi.StringOutput

The name of the API group to which the API belongs.

func (ApiOutput) HttpBackend 

func (o ApiOutput) HttpBackend() ApiHttpBackendPtrOutput

Specifies the configuration when backendType selected 'HTTP' (documented below).

func (ApiOutput) MockBackend 

func (o ApiOutput) MockBackend() ApiMockBackendPtrOutput

Specifies the configuration when backendType selected 'MOCK' (documented below).

func (ApiOutput) Name 

func (o ApiOutput) Name() pulumi.StringOutput

Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.

func (ApiOutput) Region 

func (o ApiOutput) Region() pulumi.StringOutput

The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.

func (ApiOutput) RequestMethod 

func (o ApiOutput) RequestMethod() pulumi.StringOutput

Specifies the request method, including 'GET','POST','PUT' and etc..

func (ApiOutput) RequestParameters 

func (o ApiOutput) RequestParameters() ApiRequestParameterArrayOutput

the request parameter list (documented below).

func (ApiOutput) RequestProtocol 

func (o ApiOutput) RequestProtocol() pulumi.StringPtrOutput

Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.

func (ApiOutput) RequestUri 

func (o ApiOutput) RequestUri() pulumi.StringOutput

Specifies the request path of the API. The value must comply with URI specifications.

func (ApiOutput) Tags 

func (o ApiOutput) Tags() pulumi.StringArrayOutput

the tags of API in format of string list.

func (ApiOutput) ToApiOutput 

func (o ApiOutput) ToApiOutput() ApiOutput

func (ApiOutput) ToApiOutputWithContext 

func (o ApiOutput) ToApiOutputWithContext(ctx context.Context) ApiOutput

func (ApiOutput) Version 

func (o ApiOutput) Version() pulumi.StringOutput

Specifies the version of the API. A maximum of 16 characters are allowed.

func (ApiOutput) Visibility 

func (o ApiOutput) Visibility() pulumi.IntPtrOutput

Specifies whether the API is available to the public. The value can be 1 (public) and 2 (private). Defaults to 2.

type ApiRequestParameter 

type ApiRequestParameter struct {
	// Specifies the default value when the parameter is optional.
	Default *string `pulumi:"default"`
	// Specifies the description of the parameter. The description cannot exceed 255
	// characters.
	Description *string `pulumi:"description"`
	// Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
	Location string `pulumi:"location"`
	// Specifies the input parameter name. A parameter name consists of 1–32 characters, starting
	// with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies whether the parameter is mandatory or not.
	Required bool `pulumi:"required"`
	// Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.
	Type string `pulumi:"type"`
}

type ApiRequestParameterArgs 

type ApiRequestParameterArgs struct {
	// Specifies the default value when the parameter is optional.
	Default pulumi.StringPtrInput `pulumi:"default"`
	// Specifies the description of the parameter. The description cannot exceed 255
	// characters.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
	Location pulumi.StringInput `pulumi:"location"`
	// Specifies the input parameter name. A parameter name consists of 1–32 characters, starting
	// with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies whether the parameter is mandatory or not.
	Required pulumi.BoolInput `pulumi:"required"`
	// Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.
	Type pulumi.StringInput `pulumi:"type"`
}

func (ApiRequestParameterArgs) ElementType 

func (ApiRequestParameterArgs) ElementType() reflect.Type

func (ApiRequestParameterArgs) ToApiRequestParameterOutput 

func (i ApiRequestParameterArgs) ToApiRequestParameterOutput() ApiRequestParameterOutput

func (ApiRequestParameterArgs) ToApiRequestParameterOutputWithContext 

func (i ApiRequestParameterArgs) ToApiRequestParameterOutputWithContext(ctx context.Context) ApiRequestParameterOutput

type ApiRequestParameterArray 

type ApiRequestParameterArray []ApiRequestParameterInput

func (ApiRequestParameterArray) ElementType 

func (ApiRequestParameterArray) ElementType() reflect.Type

func (ApiRequestParameterArray) ToApiRequestParameterArrayOutput 

func (i ApiRequestParameterArray) ToApiRequestParameterArrayOutput() ApiRequestParameterArrayOutput

func (ApiRequestParameterArray) ToApiRequestParameterArrayOutputWithContext 

func (i ApiRequestParameterArray) ToApiRequestParameterArrayOutputWithContext(ctx context.Context) ApiRequestParameterArrayOutput

type ApiRequestParameterArrayInput 

type ApiRequestParameterArrayInput interface {
	pulumi.Input

	ToApiRequestParameterArrayOutput() ApiRequestParameterArrayOutput
	ToApiRequestParameterArrayOutputWithContext(context.Context) ApiRequestParameterArrayOutput
}

ApiRequestParameterArrayInput is an input type that accepts ApiRequestParameterArray and ApiRequestParameterArrayOutput values. You can construct a concrete instance of `ApiRequestParameterArrayInput` via: 

ApiRequestParameterArray{ ApiRequestParameterArgs{...} }

type ApiRequestParameterArrayOutput 

type ApiRequestParameterArrayOutput struct{ *pulumi.OutputState }

func (ApiRequestParameterArrayOutput) ElementType 

func (ApiRequestParameterArrayOutput) ElementType() reflect.Type

func (ApiRequestParameterArrayOutput) Index 

func (o ApiRequestParameterArrayOutput) Index(i pulumi.IntInput) ApiRequestParameterOutput

func (ApiRequestParameterArrayOutput) ToApiRequestParameterArrayOutput 

func (o ApiRequestParameterArrayOutput) ToApiRequestParameterArrayOutput() ApiRequestParameterArrayOutput

func (ApiRequestParameterArrayOutput) ToApiRequestParameterArrayOutputWithContext 

func (o ApiRequestParameterArrayOutput) ToApiRequestParameterArrayOutputWithContext(ctx context.Context) ApiRequestParameterArrayOutput

type ApiRequestParameterInput 

type ApiRequestParameterInput interface {
	pulumi.Input

	ToApiRequestParameterOutput() ApiRequestParameterOutput
	ToApiRequestParameterOutputWithContext(context.Context) ApiRequestParameterOutput
}

ApiRequestParameterInput is an input type that accepts ApiRequestParameterArgs and ApiRequestParameterOutput values. You can construct a concrete instance of `ApiRequestParameterInput` via: 

ApiRequestParameterArgs{...}

type ApiRequestParameterOutput 

type ApiRequestParameterOutput struct{ *pulumi.OutputState }

func (ApiRequestParameterOutput) Default 

func (o ApiRequestParameterOutput) Default() pulumi.StringPtrOutput

Specifies the default value when the parameter is optional.

func (ApiRequestParameterOutput) Description 

func (o ApiRequestParameterOutput) Description() pulumi.StringPtrOutput

Specifies the description of the parameter. The description cannot exceed 255 characters.

func (ApiRequestParameterOutput) ElementType 

func (ApiRequestParameterOutput) ElementType() reflect.Type

func (ApiRequestParameterOutput) Location 

func (o ApiRequestParameterOutput) Location() pulumi.StringOutput

Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.

func (ApiRequestParameterOutput) Name 

func (o ApiRequestParameterOutput) Name() pulumi.StringOutput

Specifies the input parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

func (ApiRequestParameterOutput) Required 

func (o ApiRequestParameterOutput) Required() pulumi.BoolOutput

Specifies whether the parameter is mandatory or not.

func (ApiRequestParameterOutput) ToApiRequestParameterOutput 

func (o ApiRequestParameterOutput) ToApiRequestParameterOutput() ApiRequestParameterOutput

func (ApiRequestParameterOutput) ToApiRequestParameterOutputWithContext 

func (o ApiRequestParameterOutput) ToApiRequestParameterOutputWithContext(ctx context.Context) ApiRequestParameterOutput

func (ApiRequestParameterOutput) Type 

func (o ApiRequestParameterOutput) Type() pulumi.StringOutput

Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.

type ApiState 

type ApiState struct {
	// Specifies the security authentication mode. The value can be 'APP', 'IAM', and '
	// NONE'.
	AuthType pulumi.StringPtrInput
	// the backend parameter list (documented below).
	BackendParameters ApiBackendParameterArrayInput
	// Specifies the service backend type. The value can be:
	// + 'HTTP': the web service backend
	// + 'FUNCTION': the FunctionGraph service backend
	// + 'MOCK': the Mock service backend
	BackendType pulumi.StringPtrInput
	// Specifies whether CORS is supported or not.
	Cors pulumi.BoolPtrInput
	// Specifies the description of the API. The description cannot exceed 255 characters.
	Description pulumi.StringPtrInput
	// Specifies the example response for a failed request The length cannot
	// exceed 20,480 characters.
	ExampleFailureResponse pulumi.StringPtrInput
	// Specifies the example response for a successful request. The length
	// cannot exceed 20,480 characters.
	ExampleSuccessResponse pulumi.StringPtrInput
	// Specifies the configuration when backendType selected 'FUNCTION' (documented
	// below).
	FunctionBackend ApiFunctionBackendPtrInput
	// Specifies the ID of the API group. Changing this creates a new resource.
	GroupId pulumi.StringPtrInput
	// The name of the API group to which the API belongs.
	GroupName pulumi.StringPtrInput
	// Specifies the configuration when backendType selected 'HTTP' (documented below).
	HttpBackend ApiHttpBackendPtrInput
	// Specifies the configuration when backendType selected 'MOCK' (documented below).
	MockBackend ApiMockBackendPtrInput
	// Specifies the name of the API. An API name consists of 3–64 characters, starting with a
	// letter. Only letters, digits, and underscores (_) are allowed.
	Name pulumi.StringPtrInput
	// The region in which to create the API resource. If omitted, the provider-level
	// region will be used. Changing this creates a new API resource.
	Region pulumi.StringPtrInput
	// Specifies the request method, including 'GET','POST','PUT' and etc..
	RequestMethod pulumi.StringPtrInput
	// the request parameter list (documented below).
	RequestParameters ApiRequestParameterArrayInput
	// Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH'
	// which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
	RequestProtocol pulumi.StringPtrInput
	// Specifies the request path of the API. The value must comply with URI
	// specifications.
	RequestUri pulumi.StringPtrInput
	// the tags of API in format of string list.
	Tags pulumi.StringArrayInput
	// Specifies the version of the API. A maximum of 16 characters are allowed.
	Version pulumi.StringPtrInput
	// Specifies whether the API is available to the public. The value can be 1 (public) and
	// 2 (private). Defaults to 2.
	Visibility pulumi.IntPtrInput
}

func (ApiState) ElementType 

func (ApiState) ElementType() reflect.Type

type Group 

type Group struct {
	pulumi.CustomResourceState

	// Specifies the description of the API group. The description cannot exceed 255
	// characters.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies the name of the API group. An API group name consists of 3–64 characters,
	// starting with a letter. Only letters, digits, and underscores (_) are allowed.
	Name pulumi.StringOutput `pulumi:"name"`
	// The region in which to create the API gateway group resource. If omitted, the
	// provider-level region will be used. Changing this creates a new gateway group resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// Status of the API group.
	Status pulumi.IntOutput `pulumi:"status"`
}

Provides an API gateway group resource.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/SharedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := SharedApig.NewGroup(ctx, "apigwGroup", &SharedApig.GroupArgs{
			Description: pulumi.String("your descpiption"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetGroup 

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)

GetGroup gets an existing Group resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGroup 

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)

NewGroup registers a new resource with the given unique name, arguments, and options.

func (*Group) ElementType 

func (*Group) ElementType() reflect.Type

func (*Group) ToGroupOutput 

func (i *Group) ToGroupOutput() GroupOutput

func (*Group) ToGroupOutputWithContext 

func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupArgs 

type GroupArgs struct {
	// Specifies the description of the API group. The description cannot exceed 255
	// characters.
	Description pulumi.StringPtrInput
	// Specifies the name of the API group. An API group name consists of 3–64 characters,
	// starting with a letter. Only letters, digits, and underscores (_) are allowed.
	Name pulumi.StringPtrInput
	// The region in which to create the API gateway group resource. If omitted, the
	// provider-level region will be used. Changing this creates a new gateway group resource.
	Region pulumi.StringPtrInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType 

func (GroupArgs) ElementType() reflect.Type

type GroupArray 

type GroupArray []GroupInput

func (GroupArray) ElementType 

func (GroupArray) ElementType() reflect.Type

func (GroupArray) ToGroupArrayOutput 

func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput

func (GroupArray) ToGroupArrayOutputWithContext 

func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupArrayInput 

type GroupArrayInput interface {
	pulumi.Input

	ToGroupArrayOutput() GroupArrayOutput
	ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput
}

GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via: 

GroupArray{ GroupArgs{...} }

type GroupArrayOutput 

type GroupArrayOutput struct{ *pulumi.OutputState }

func (GroupArrayOutput) ElementType 

func (GroupArrayOutput) ElementType() reflect.Type

func (GroupArrayOutput) Index 

func (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput

func (GroupArrayOutput) ToGroupArrayOutput 

func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput

func (GroupArrayOutput) ToGroupArrayOutputWithContext 

func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput

type GroupInput 

type GroupInput interface {
	pulumi.Input

	ToGroupOutput() GroupOutput
	ToGroupOutputWithContext(ctx context.Context) GroupOutput
}

type GroupMap 

type GroupMap map[string]GroupInput

func (GroupMap) ElementType 

func (GroupMap) ElementType() reflect.Type

func (GroupMap) ToGroupMapOutput 

func (i GroupMap) ToGroupMapOutput() GroupMapOutput

func (GroupMap) ToGroupMapOutputWithContext 

func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupMapInput 

type GroupMapInput interface {
	pulumi.Input

	ToGroupMapOutput() GroupMapOutput
	ToGroupMapOutputWithContext(context.Context) GroupMapOutput
}

GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via: 

GroupMap{ "key": GroupArgs{...} }

type GroupMapOutput 

type GroupMapOutput struct{ *pulumi.OutputState }

func (GroupMapOutput) ElementType 

func (GroupMapOutput) ElementType() reflect.Type

func (GroupMapOutput) MapIndex 

func (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput

func (GroupMapOutput) ToGroupMapOutput 

func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput

func (GroupMapOutput) ToGroupMapOutputWithContext 

func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput

type GroupOutput 

type GroupOutput struct{ *pulumi.OutputState }

func (GroupOutput) Description 

func (o GroupOutput) Description() pulumi.StringPtrOutput

Specifies the description of the API group. The description cannot exceed 255 characters.

func (GroupOutput) ElementType 

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) Name 

func (o GroupOutput) Name() pulumi.StringOutput

Specifies the name of the API group. An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.

func (GroupOutput) Region 

func (o GroupOutput) Region() pulumi.StringOutput

The region in which to create the API gateway group resource. If omitted, the provider-level region will be used. Changing this creates a new gateway group resource.

func (GroupOutput) Status 

func (o GroupOutput) Status() pulumi.IntOutput

Status of the API group.

func (GroupOutput) ToGroupOutput 

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext 

func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput

type GroupState 

type GroupState struct {
	// Specifies the description of the API group. The description cannot exceed 255
	// characters.
	Description pulumi.StringPtrInput
	// Specifies the name of the API group. An API group name consists of 3–64 characters,
	// starting with a letter. Only letters, digits, and underscores (_) are allowed.
	Name pulumi.StringPtrInput
	// The region in which to create the API gateway group resource. If omitted, the
	// provider-level region will be used. Changing this creates a new gateway group resource.
	Region pulumi.StringPtrInput
	// Status of the API group.
	Status pulumi.IntPtrInput
}

func (GroupState) ElementType 

func (GroupState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.