dedicatedapig

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 ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrOutput `pulumi:"authorizerId"`
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams ApiBackendParamArrayOutput `pulumi:"backendParams"`
	// Specifies the description of the API request body, which can be an example
	// request body, media type or parameters.
	// The request body does not exceed `20,480` characters.
	BodyDescription pulumi.StringPtrOutput `pulumi:"bodyDescription"`
	// Specifies whether CORS is supported, defaults to **false**.
	Cors pulumi.BoolPtrOutput `pulumi:"cors"`
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies the example response for a failure request.\
	// The response contains a maximum of `20,480` characters.
	FailureResponse pulumi.StringPtrOutput `pulumi:"failureResponse"`
	// Specifies the function graph backend details.\
	// The object structure is documented below.
	// Changing this will create a new API resource.
	FuncGraph ApiFuncGraphOutput `pulumi:"funcGraph"`
	// Specifies the Mock policy backends.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	FuncGraphPolicies ApiFuncGraphPolicyArrayOutput `pulumi:"funcGraphPolicies"`
	// Specifies an ID of the APIG group to which the API belongs to.
	GroupId pulumi.StringOutput `pulumi:"groupId"`
	// Specifies an ID of the APIG dedicated instance to which the API belongs
	// to. Changing this will create a new API resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the route matching mode.\
	// The valid values are **Exact** and **Prefix**, defaults to **Exact**.
	Matching pulumi.StringPtrOutput `pulumi:"matching"`
	// Specifies the mock backend details.\
	// The object structure is documented below.
	// Changing this will create a new API resource.
	Mock ApiMockOutput `pulumi:"mock"`
	// Specifies the Mock policy backends.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	MockPolicies ApiMockPolicyArrayOutput `pulumi:"mockPolicies"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the region where the API is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new API resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// The registered time of the API.
	RegisteredAt pulumi.StringOutput `pulumi:"registeredAt"`
	// Specifies the backend request method of the API.\
	// The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.
	RequestMethod pulumi.StringOutput `pulumi:"requestMethod"`
	// Specifies the configurations of the front-end parameters.\
	// The object structure is documented below.
	RequestParams ApiRequestParamArrayOutput `pulumi:"requestParams"`
	// Specifies the request address, which can contain a maximum of `512` characters,
	// the request parameters enclosed with brackets ({}).
	// + The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-), and
	//   underscores (_) and must comply with URI specifications.
	// + The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters.
	RequestPath pulumi.StringOutput `pulumi:"requestPath"`
	// Specifies the backend request protocol. The valid values are **HTTP** and
	// **HTTPS**, defaults to **HTTPS**.
	RequestProtocol pulumi.StringOutput `pulumi:"requestProtocol"`
	// Specifies the APIG group response ID.
	ResponseId pulumi.StringPtrOutput `pulumi:"responseId"`
	// Specifies the security authentication mode of the API request.\
	// The valid values are **NONE**, **APP** and **IAM**, defaults to **NONE**.
	SecurityAuthentication pulumi.StringPtrOutput `pulumi:"securityAuthentication"`
	// Specifies whether the authentication of the application code is enabled.\
	// The application code must located in the header when `simpleAuthentication` is true.
	SimpleAuthentication pulumi.BoolOutput `pulumi:"simpleAuthentication"`
	// Specifies the example response for a successful request.\
	// The response contains a maximum of `20,480` characters.
	SuccessResponse pulumi.StringPtrOutput `pulumi:"successResponse"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringOutput `pulumi:"type"`
	// The latest update time of the API.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
	// Specifies the web backend details.\
	// The object structure is documented below. Changing this will create a new API resource.
	Web ApiWebOutput `pulumi:"web"`
	// Specifies the example response for a failed request.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	WebPolicies ApiWebPolicyArrayOutput `pulumi:"webPolicies"`
}

Manages an APIG API resource within HuaweiCloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		groupId := cfg.RequireObject("groupId")
		apiName := cfg.RequireObject("apiName")
		customResponseId := cfg.RequireObject("customResponseId")
		customAuthId := cfg.RequireObject("customAuthId")
		vpcChannelId := cfg.RequireObject("vpcChannelId")
		_, err := DedicatedApig.NewApi(ctx, "test", &DedicatedApig.ApiArgs{
			InstanceId:             pulumi.Any(instanceId),
			GroupId:                pulumi.Any(groupId),
			Type:                   pulumi.String("Public"),
			RequestProtocol:        pulumi.String("HTTP"),
			RequestMethod:          pulumi.String("POST"),
			RequestPath:            pulumi.String("/terraform/users"),
			SecurityAuthentication: pulumi.String("AUTHORIZER"),
			Matching:               pulumi.String("Exact"),
			SuccessResponse:        pulumi.String("Successful"),
			ResponseId:             pulumi.Any(customResponseId),
			AuthorizerId:           pulumi.Any(customAuthId),
			BackendParams: dedicatedapig.ApiBackendParamArray{
				&dedicatedapig.ApiBackendParamArgs{
					Type:     pulumi.String("SYSTEM"),
					Name:     pulumi.String("X-User-Auth"),
					Location: pulumi.String("HEADER"),
					Value:    pulumi.String("user_name"),
				},
			},
			Web: &dedicatedapig.ApiWebArgs{
				Path:            pulumi.String("/backend/users"),
				VpcChannelId:    pulumi.Any(vpcChannelId),
				RequestMethod:   pulumi.String("POST"),
				RequestProtocol: pulumi.String("HTTP"),
				Timeout:         pulumi.Int(5000),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

APIs can be imported using their `name` and the related dedicated instance IDs, separated by a slash, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/api:Api test <instance_id>/<name>

```

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 ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrInput
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams ApiBackendParamArrayInput
	// Specifies the description of the API request body, which can be an example
	// request body, media type or parameters.
	// The request body does not exceed `20,480` characters.
	BodyDescription pulumi.StringPtrInput
	// Specifies whether CORS is supported, defaults to **false**.
	Cors pulumi.BoolPtrInput
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput
	// Specifies the example response for a failure request.\
	// The response contains a maximum of `20,480` characters.
	FailureResponse pulumi.StringPtrInput
	// Specifies the function graph backend details.\
	// The object structure is documented below.
	// Changing this will create a new API resource.
	FuncGraph ApiFuncGraphPtrInput
	// Specifies the Mock policy backends.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	FuncGraphPolicies ApiFuncGraphPolicyArrayInput
	// Specifies an ID of the APIG group to which the API belongs to.
	GroupId pulumi.StringInput
	// Specifies an ID of the APIG dedicated instance to which the API belongs
	// to. Changing this will create a new API resource.
	InstanceId pulumi.StringInput
	// Specifies the route matching mode.\
	// The valid values are **Exact** and **Prefix**, defaults to **Exact**.
	Matching pulumi.StringPtrInput
	// Specifies the mock backend details.\
	// The object structure is documented below.
	// Changing this will create a new API resource.
	Mock ApiMockPtrInput
	// Specifies the Mock policy backends.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	MockPolicies ApiMockPolicyArrayInput
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringPtrInput
	// Specifies the region where the API is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new API resource.
	Region pulumi.StringPtrInput
	// Specifies the backend request method of the API.\
	// The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.
	RequestMethod pulumi.StringInput
	// Specifies the configurations of the front-end parameters.\
	// The object structure is documented below.
	RequestParams ApiRequestParamArrayInput
	// Specifies the request address, which can contain a maximum of `512` characters,
	// the request parameters enclosed with brackets ({}).
	// + The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-), and
	//   underscores (_) and must comply with URI specifications.
	// + The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters.
	RequestPath pulumi.StringInput
	// Specifies the backend request protocol. The valid values are **HTTP** and
	// **HTTPS**, defaults to **HTTPS**.
	RequestProtocol pulumi.StringInput
	// Specifies the APIG group response ID.
	ResponseId pulumi.StringPtrInput
	// Specifies the security authentication mode of the API request.\
	// The valid values are **NONE**, **APP** and **IAM**, defaults to **NONE**.
	SecurityAuthentication pulumi.StringPtrInput
	// Specifies whether the authentication of the application code is enabled.\
	// The application code must located in the header when `simpleAuthentication` is true.
	SimpleAuthentication pulumi.BoolPtrInput
	// Specifies the example response for a successful request.\
	// The response contains a maximum of `20,480` characters.
	SuccessResponse pulumi.StringPtrInput
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringInput
	// Specifies the web backend details.\
	// The object structure is documented below. Changing this will create a new API resource.
	Web ApiWebPtrInput
	// Specifies the example response for a failed request.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	WebPolicies ApiWebPolicyArrayInput
}

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 ApiBackendParam 

type ApiBackendParam struct {
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description *string `pulumi:"description"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location string `pulumi:"location"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies the type of the system parameter.\
	// The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.
	SystemParamType *string `pulumi:"systemParamType"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type string `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value string `pulumi:"value"`
}

type ApiBackendParamArgs 

type ApiBackendParamArgs struct {
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location pulumi.StringInput `pulumi:"location"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the type of the system parameter.\
	// The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.
	SystemParamType pulumi.StringPtrInput `pulumi:"systemParamType"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringInput `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ApiBackendParamArgs) ElementType 

func (ApiBackendParamArgs) ElementType() reflect.Type

func (ApiBackendParamArgs) ToApiBackendParamOutput 

func (i ApiBackendParamArgs) ToApiBackendParamOutput() ApiBackendParamOutput

func (ApiBackendParamArgs) ToApiBackendParamOutputWithContext 

func (i ApiBackendParamArgs) ToApiBackendParamOutputWithContext(ctx context.Context) ApiBackendParamOutput

type ApiBackendParamArray 

type ApiBackendParamArray []ApiBackendParamInput

func (ApiBackendParamArray) ElementType 

func (ApiBackendParamArray) ElementType() reflect.Type

func (ApiBackendParamArray) ToApiBackendParamArrayOutput 

func (i ApiBackendParamArray) ToApiBackendParamArrayOutput() ApiBackendParamArrayOutput

func (ApiBackendParamArray) ToApiBackendParamArrayOutputWithContext 

func (i ApiBackendParamArray) ToApiBackendParamArrayOutputWithContext(ctx context.Context) ApiBackendParamArrayOutput

type ApiBackendParamArrayInput 

type ApiBackendParamArrayInput interface {
	pulumi.Input

	ToApiBackendParamArrayOutput() ApiBackendParamArrayOutput
	ToApiBackendParamArrayOutputWithContext(context.Context) ApiBackendParamArrayOutput
}

ApiBackendParamArrayInput is an input type that accepts ApiBackendParamArray and ApiBackendParamArrayOutput values. You can construct a concrete instance of `ApiBackendParamArrayInput` via: 

ApiBackendParamArray{ ApiBackendParamArgs{...} }

type ApiBackendParamArrayOutput 

type ApiBackendParamArrayOutput struct{ *pulumi.OutputState }

func (ApiBackendParamArrayOutput) ElementType 

func (ApiBackendParamArrayOutput) ElementType() reflect.Type

func (ApiBackendParamArrayOutput) Index 

func (o ApiBackendParamArrayOutput) Index(i pulumi.IntInput) ApiBackendParamOutput

func (ApiBackendParamArrayOutput) ToApiBackendParamArrayOutput 

func (o ApiBackendParamArrayOutput) ToApiBackendParamArrayOutput() ApiBackendParamArrayOutput

func (ApiBackendParamArrayOutput) ToApiBackendParamArrayOutputWithContext 

func (o ApiBackendParamArrayOutput) ToApiBackendParamArrayOutputWithContext(ctx context.Context) ApiBackendParamArrayOutput

type ApiBackendParamInput 

type ApiBackendParamInput interface {
	pulumi.Input

	ToApiBackendParamOutput() ApiBackendParamOutput
	ToApiBackendParamOutputWithContext(context.Context) ApiBackendParamOutput
}

ApiBackendParamInput is an input type that accepts ApiBackendParamArgs and ApiBackendParamOutput values. You can construct a concrete instance of `ApiBackendParamInput` via: 

ApiBackendParamArgs{...}

type ApiBackendParamOutput 

type ApiBackendParamOutput struct{ *pulumi.OutputState }

func (ApiBackendParamOutput) Description 

func (o ApiBackendParamOutput) Description() pulumi.StringPtrOutput

Specifies the description of the constant or system parameter.\ The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ApiBackendParamOutput) ElementType 

func (ApiBackendParamOutput) ElementType() reflect.Type

func (ApiBackendParamOutput) Location 

func (o ApiBackendParamOutput) Location() pulumi.StringOutput

Specifies the location of the backend parameter.\ The valid values are **PATH**, **QUERY** and **HEADER**.

func (ApiBackendParamOutput) Name 

func (o ApiBackendParamOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiBackendParamOutput) SystemParamType added in v0.0.8 

func (o ApiBackendParamOutput) SystemParamType() pulumi.StringPtrOutput

Specifies the type of the system parameter.\ The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.

func (ApiBackendParamOutput) ToApiBackendParamOutput 

func (o ApiBackendParamOutput) ToApiBackendParamOutput() ApiBackendParamOutput

func (ApiBackendParamOutput) ToApiBackendParamOutputWithContext 

func (o ApiBackendParamOutput) ToApiBackendParamOutputWithContext(ctx context.Context) ApiBackendParamOutput

func (ApiBackendParamOutput) Type 

func (o ApiBackendParamOutput) Type() pulumi.StringOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

func (ApiBackendParamOutput) Value 

func (o ApiBackendParamOutput) Value() pulumi.StringOutput

Specifies the value of the backend policy.\ For a condition with the input parameter source: + If the condition type is **Enumerated**, separate condition values with commas. + If the condition type is **Matching**, enter a regular expression compatible with PERL.

type ApiFuncGraph 

type ApiFuncGraph struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId *string `pulumi:"authorizerId"`
	// Specifies the URN of the FunctionGraph function.
	FunctionUrn string `pulumi:"functionUrn"`
	// Specifies the invocation type.\
	// The valid values are **async** and **sync**, defaults to **sync**.
	InvocationType *string `pulumi:"invocationType"`
	// Specifies the timeout, in ms, which allowed for APIG to request the backend service. The
	// valid value is range from `1` to `600,000`, defaults to `5,000`.
	Timeout *int `pulumi:"timeout"`
	// Specifies the version of the FunctionGraph function.
	Version *string `pulumi:"version"`
}

type ApiFuncGraphArgs 

type ApiFuncGraphArgs struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrInput `pulumi:"authorizerId"`
	// Specifies the URN of the FunctionGraph function.
	FunctionUrn pulumi.StringInput `pulumi:"functionUrn"`
	// Specifies the invocation type.\
	// The valid values are **async** and **sync**, defaults to **sync**.
	InvocationType pulumi.StringPtrInput `pulumi:"invocationType"`
	// Specifies the timeout, in ms, which allowed for APIG to request the backend service. The
	// valid value is range from `1` to `600,000`, defaults to `5,000`.
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// Specifies the version of the FunctionGraph function.
	Version pulumi.StringPtrInput `pulumi:"version"`
}

func (ApiFuncGraphArgs) ElementType 

func (ApiFuncGraphArgs) ElementType() reflect.Type

func (ApiFuncGraphArgs) ToApiFuncGraphOutput 

func (i ApiFuncGraphArgs) ToApiFuncGraphOutput() ApiFuncGraphOutput

func (ApiFuncGraphArgs) ToApiFuncGraphOutputWithContext 

func (i ApiFuncGraphArgs) ToApiFuncGraphOutputWithContext(ctx context.Context) ApiFuncGraphOutput

func (ApiFuncGraphArgs) ToApiFuncGraphPtrOutput 

func (i ApiFuncGraphArgs) ToApiFuncGraphPtrOutput() ApiFuncGraphPtrOutput

func (ApiFuncGraphArgs) ToApiFuncGraphPtrOutputWithContext 

func (i ApiFuncGraphArgs) ToApiFuncGraphPtrOutputWithContext(ctx context.Context) ApiFuncGraphPtrOutput

type ApiFuncGraphInput 

type ApiFuncGraphInput interface {
	pulumi.Input

	ToApiFuncGraphOutput() ApiFuncGraphOutput
	ToApiFuncGraphOutputWithContext(context.Context) ApiFuncGraphOutput
}

ApiFuncGraphInput is an input type that accepts ApiFuncGraphArgs and ApiFuncGraphOutput values. You can construct a concrete instance of `ApiFuncGraphInput` via: 

ApiFuncGraphArgs{...}

type ApiFuncGraphOutput 

type ApiFuncGraphOutput struct{ *pulumi.OutputState }

func (ApiFuncGraphOutput) AuthorizerId 

func (o ApiFuncGraphOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiFuncGraphOutput) ElementType 

func (ApiFuncGraphOutput) ElementType() reflect.Type

func (ApiFuncGraphOutput) FunctionUrn 

func (o ApiFuncGraphOutput) FunctionUrn() pulumi.StringOutput

Specifies the URN of the FunctionGraph function.

func (ApiFuncGraphOutput) InvocationType 

func (o ApiFuncGraphOutput) InvocationType() pulumi.StringPtrOutput

Specifies the invocation type.\ The valid values are **async** and **sync**, defaults to **sync**.

func (ApiFuncGraphOutput) Timeout 

func (o ApiFuncGraphOutput) Timeout() pulumi.IntPtrOutput

Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from `1` to `600,000`, defaults to `5,000`.

func (ApiFuncGraphOutput) ToApiFuncGraphOutput 

func (o ApiFuncGraphOutput) ToApiFuncGraphOutput() ApiFuncGraphOutput

func (ApiFuncGraphOutput) ToApiFuncGraphOutputWithContext 

func (o ApiFuncGraphOutput) ToApiFuncGraphOutputWithContext(ctx context.Context) ApiFuncGraphOutput

func (ApiFuncGraphOutput) ToApiFuncGraphPtrOutput 

func (o ApiFuncGraphOutput) ToApiFuncGraphPtrOutput() ApiFuncGraphPtrOutput

func (ApiFuncGraphOutput) ToApiFuncGraphPtrOutputWithContext 

func (o ApiFuncGraphOutput) ToApiFuncGraphPtrOutputWithContext(ctx context.Context) ApiFuncGraphPtrOutput

func (ApiFuncGraphOutput) Version 

func (o ApiFuncGraphOutput) Version() pulumi.StringPtrOutput

Specifies the version of the FunctionGraph function.

type ApiFuncGraphPolicy 

type ApiFuncGraphPolicy struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId *string `pulumi:"authorizerId"`
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams []ApiFuncGraphPolicyBackendParam `pulumi:"backendParams"`
	// Specifies an array of one or more policy conditions.\
	// Up to five conditions can be set.
	// The object structure is documented below.
	Conditions []ApiFuncGraphPolicyCondition `pulumi:"conditions"`
	// Specifies the effective mode of the backend policy. The valid values are **ALL**
	// and **ANY**, defaults to **ANY**.
	EffectiveMode *string `pulumi:"effectiveMode"`
	// Specifies the URN of the FunctionGraph function.
	FunctionUrn string `pulumi:"functionUrn"`
	// Specifies the invocation mode of the FunctionGraph function.\
	// The valid values are **async** and **sync**, defaults to **sync**.
	InvocationMode *string `pulumi:"invocationMode"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies the timeout, in ms, which allowed for APIG to request the backend service. The
	// valid value is range from `1` to `600,000`, defaults to `5,000`.
	Timeout *int `pulumi:"timeout"`
	// Specifies the version of the FunctionGraph function.
	Version *string `pulumi:"version"`
}

type ApiFuncGraphPolicyArgs 

type ApiFuncGraphPolicyArgs struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrInput `pulumi:"authorizerId"`
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams ApiFuncGraphPolicyBackendParamArrayInput `pulumi:"backendParams"`
	// Specifies an array of one or more policy conditions.\
	// Up to five conditions can be set.
	// The object structure is documented below.
	Conditions ApiFuncGraphPolicyConditionArrayInput `pulumi:"conditions"`
	// Specifies the effective mode of the backend policy. The valid values are **ALL**
	// and **ANY**, defaults to **ANY**.
	EffectiveMode pulumi.StringPtrInput `pulumi:"effectiveMode"`
	// Specifies the URN of the FunctionGraph function.
	FunctionUrn pulumi.StringInput `pulumi:"functionUrn"`
	// Specifies the invocation mode of the FunctionGraph function.\
	// The valid values are **async** and **sync**, defaults to **sync**.
	InvocationMode pulumi.StringPtrInput `pulumi:"invocationMode"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the timeout, in ms, which allowed for APIG to request the backend service. The
	// valid value is range from `1` to `600,000`, defaults to `5,000`.
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// Specifies the version of the FunctionGraph function.
	Version pulumi.StringPtrInput `pulumi:"version"`
}

func (ApiFuncGraphPolicyArgs) ElementType 

func (ApiFuncGraphPolicyArgs) ElementType() reflect.Type

func (ApiFuncGraphPolicyArgs) ToApiFuncGraphPolicyOutput 

func (i ApiFuncGraphPolicyArgs) ToApiFuncGraphPolicyOutput() ApiFuncGraphPolicyOutput

func (ApiFuncGraphPolicyArgs) ToApiFuncGraphPolicyOutputWithContext 

func (i ApiFuncGraphPolicyArgs) ToApiFuncGraphPolicyOutputWithContext(ctx context.Context) ApiFuncGraphPolicyOutput

type ApiFuncGraphPolicyArray 

type ApiFuncGraphPolicyArray []ApiFuncGraphPolicyInput

func (ApiFuncGraphPolicyArray) ElementType 

func (ApiFuncGraphPolicyArray) ElementType() reflect.Type

func (ApiFuncGraphPolicyArray) ToApiFuncGraphPolicyArrayOutput 

func (i ApiFuncGraphPolicyArray) ToApiFuncGraphPolicyArrayOutput() ApiFuncGraphPolicyArrayOutput

func (ApiFuncGraphPolicyArray) ToApiFuncGraphPolicyArrayOutputWithContext 

func (i ApiFuncGraphPolicyArray) ToApiFuncGraphPolicyArrayOutputWithContext(ctx context.Context) ApiFuncGraphPolicyArrayOutput

type ApiFuncGraphPolicyArrayInput 

type ApiFuncGraphPolicyArrayInput interface {
	pulumi.Input

	ToApiFuncGraphPolicyArrayOutput() ApiFuncGraphPolicyArrayOutput
	ToApiFuncGraphPolicyArrayOutputWithContext(context.Context) ApiFuncGraphPolicyArrayOutput
}

ApiFuncGraphPolicyArrayInput is an input type that accepts ApiFuncGraphPolicyArray and ApiFuncGraphPolicyArrayOutput values. You can construct a concrete instance of `ApiFuncGraphPolicyArrayInput` via: 

ApiFuncGraphPolicyArray{ ApiFuncGraphPolicyArgs{...} }

type ApiFuncGraphPolicyArrayOutput 

type ApiFuncGraphPolicyArrayOutput struct{ *pulumi.OutputState }

func (ApiFuncGraphPolicyArrayOutput) ElementType 

func (ApiFuncGraphPolicyArrayOutput) ElementType() reflect.Type

func (ApiFuncGraphPolicyArrayOutput) Index 

func (o ApiFuncGraphPolicyArrayOutput) Index(i pulumi.IntInput) ApiFuncGraphPolicyOutput

func (ApiFuncGraphPolicyArrayOutput) ToApiFuncGraphPolicyArrayOutput 

func (o ApiFuncGraphPolicyArrayOutput) ToApiFuncGraphPolicyArrayOutput() ApiFuncGraphPolicyArrayOutput

func (ApiFuncGraphPolicyArrayOutput) ToApiFuncGraphPolicyArrayOutputWithContext 

func (o ApiFuncGraphPolicyArrayOutput) ToApiFuncGraphPolicyArrayOutputWithContext(ctx context.Context) ApiFuncGraphPolicyArrayOutput

type ApiFuncGraphPolicyBackendParam 

type ApiFuncGraphPolicyBackendParam struct {
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description *string `pulumi:"description"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location string `pulumi:"location"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies the type of the system parameter.\
	// The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.
	SystemParamType *string `pulumi:"systemParamType"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type string `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value string `pulumi:"value"`
}

type ApiFuncGraphPolicyBackendParamArgs 

type ApiFuncGraphPolicyBackendParamArgs struct {
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location pulumi.StringInput `pulumi:"location"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the type of the system parameter.\
	// The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.
	SystemParamType pulumi.StringPtrInput `pulumi:"systemParamType"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringInput `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ApiFuncGraphPolicyBackendParamArgs) ElementType 

func (ApiFuncGraphPolicyBackendParamArgs) ElementType() reflect.Type

func (ApiFuncGraphPolicyBackendParamArgs) ToApiFuncGraphPolicyBackendParamOutput 

func (i ApiFuncGraphPolicyBackendParamArgs) ToApiFuncGraphPolicyBackendParamOutput() ApiFuncGraphPolicyBackendParamOutput

func (ApiFuncGraphPolicyBackendParamArgs) ToApiFuncGraphPolicyBackendParamOutputWithContext 

func (i ApiFuncGraphPolicyBackendParamArgs) ToApiFuncGraphPolicyBackendParamOutputWithContext(ctx context.Context) ApiFuncGraphPolicyBackendParamOutput

type ApiFuncGraphPolicyBackendParamArray 

type ApiFuncGraphPolicyBackendParamArray []ApiFuncGraphPolicyBackendParamInput

func (ApiFuncGraphPolicyBackendParamArray) ElementType 

func (ApiFuncGraphPolicyBackendParamArray) ElementType() reflect.Type

func (ApiFuncGraphPolicyBackendParamArray) ToApiFuncGraphPolicyBackendParamArrayOutput 

func (i ApiFuncGraphPolicyBackendParamArray) ToApiFuncGraphPolicyBackendParamArrayOutput() ApiFuncGraphPolicyBackendParamArrayOutput

func (ApiFuncGraphPolicyBackendParamArray) ToApiFuncGraphPolicyBackendParamArrayOutputWithContext 

func (i ApiFuncGraphPolicyBackendParamArray) ToApiFuncGraphPolicyBackendParamArrayOutputWithContext(ctx context.Context) ApiFuncGraphPolicyBackendParamArrayOutput

type ApiFuncGraphPolicyBackendParamArrayInput 

type ApiFuncGraphPolicyBackendParamArrayInput interface {
	pulumi.Input

	ToApiFuncGraphPolicyBackendParamArrayOutput() ApiFuncGraphPolicyBackendParamArrayOutput
	ToApiFuncGraphPolicyBackendParamArrayOutputWithContext(context.Context) ApiFuncGraphPolicyBackendParamArrayOutput
}

ApiFuncGraphPolicyBackendParamArrayInput is an input type that accepts ApiFuncGraphPolicyBackendParamArray and ApiFuncGraphPolicyBackendParamArrayOutput values. You can construct a concrete instance of `ApiFuncGraphPolicyBackendParamArrayInput` via: 

ApiFuncGraphPolicyBackendParamArray{ ApiFuncGraphPolicyBackendParamArgs{...} }

type ApiFuncGraphPolicyBackendParamArrayOutput 

type ApiFuncGraphPolicyBackendParamArrayOutput struct{ *pulumi.OutputState }

func (ApiFuncGraphPolicyBackendParamArrayOutput) ElementType 

func (ApiFuncGraphPolicyBackendParamArrayOutput) ElementType() reflect.Type

func (ApiFuncGraphPolicyBackendParamArrayOutput) Index 

func (o ApiFuncGraphPolicyBackendParamArrayOutput) Index(i pulumi.IntInput) ApiFuncGraphPolicyBackendParamOutput

func (ApiFuncGraphPolicyBackendParamArrayOutput) ToApiFuncGraphPolicyBackendParamArrayOutput 

func (o ApiFuncGraphPolicyBackendParamArrayOutput) ToApiFuncGraphPolicyBackendParamArrayOutput() ApiFuncGraphPolicyBackendParamArrayOutput

func (ApiFuncGraphPolicyBackendParamArrayOutput) ToApiFuncGraphPolicyBackendParamArrayOutputWithContext 

func (o ApiFuncGraphPolicyBackendParamArrayOutput) ToApiFuncGraphPolicyBackendParamArrayOutputWithContext(ctx context.Context) ApiFuncGraphPolicyBackendParamArrayOutput

type ApiFuncGraphPolicyBackendParamInput 

type ApiFuncGraphPolicyBackendParamInput interface {
	pulumi.Input

	ToApiFuncGraphPolicyBackendParamOutput() ApiFuncGraphPolicyBackendParamOutput
	ToApiFuncGraphPolicyBackendParamOutputWithContext(context.Context) ApiFuncGraphPolicyBackendParamOutput
}

ApiFuncGraphPolicyBackendParamInput is an input type that accepts ApiFuncGraphPolicyBackendParamArgs and ApiFuncGraphPolicyBackendParamOutput values. You can construct a concrete instance of `ApiFuncGraphPolicyBackendParamInput` via: 

ApiFuncGraphPolicyBackendParamArgs{...}

type ApiFuncGraphPolicyBackendParamOutput 

type ApiFuncGraphPolicyBackendParamOutput struct{ *pulumi.OutputState }

func (ApiFuncGraphPolicyBackendParamOutput) Description 

func (o ApiFuncGraphPolicyBackendParamOutput) Description() pulumi.StringPtrOutput

Specifies the description of the constant or system parameter.\ The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ApiFuncGraphPolicyBackendParamOutput) ElementType 

func (ApiFuncGraphPolicyBackendParamOutput) ElementType() reflect.Type

func (ApiFuncGraphPolicyBackendParamOutput) Location 

func (o ApiFuncGraphPolicyBackendParamOutput) Location() pulumi.StringOutput

Specifies the location of the backend parameter.\ The valid values are **PATH**, **QUERY** and **HEADER**.

func (ApiFuncGraphPolicyBackendParamOutput) Name 

func (o ApiFuncGraphPolicyBackendParamOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiFuncGraphPolicyBackendParamOutput) SystemParamType added in v0.0.8 

func (o ApiFuncGraphPolicyBackendParamOutput) SystemParamType() pulumi.StringPtrOutput

Specifies the type of the system parameter.\ The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.

func (ApiFuncGraphPolicyBackendParamOutput) ToApiFuncGraphPolicyBackendParamOutput 

func (o ApiFuncGraphPolicyBackendParamOutput) ToApiFuncGraphPolicyBackendParamOutput() ApiFuncGraphPolicyBackendParamOutput

func (ApiFuncGraphPolicyBackendParamOutput) ToApiFuncGraphPolicyBackendParamOutputWithContext 

func (o ApiFuncGraphPolicyBackendParamOutput) ToApiFuncGraphPolicyBackendParamOutputWithContext(ctx context.Context) ApiFuncGraphPolicyBackendParamOutput

func (ApiFuncGraphPolicyBackendParamOutput) Type 

func (o ApiFuncGraphPolicyBackendParamOutput) Type() pulumi.StringOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

func (ApiFuncGraphPolicyBackendParamOutput) Value 

func (o ApiFuncGraphPolicyBackendParamOutput) Value() pulumi.StringOutput

Specifies the value of the backend policy.\ For a condition with the input parameter source: + If the condition type is **Enumerated**, separate condition values with commas. + If the condition type is **Matching**, enter a regular expression compatible with PERL.

type ApiFuncGraphPolicyCondition 

type ApiFuncGraphPolicyCondition struct {
	// Specifies the request parameter name.
	// This parameter is required if the policy type is **param**.
	ParamName *string `pulumi:"paramName"`
	// Specifies the backend policy type.\
	// The valid values are **param** and **source**, defaults to **source**.
	Source *string `pulumi:"source"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type *string `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value string `pulumi:"value"`
}

type ApiFuncGraphPolicyConditionArgs 

type ApiFuncGraphPolicyConditionArgs struct {
	// Specifies the request parameter name.
	// This parameter is required if the policy type is **param**.
	ParamName pulumi.StringPtrInput `pulumi:"paramName"`
	// Specifies the backend policy type.\
	// The valid values are **param** and **source**, defaults to **source**.
	Source pulumi.StringPtrInput `pulumi:"source"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringPtrInput `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ApiFuncGraphPolicyConditionArgs) ElementType 

func (ApiFuncGraphPolicyConditionArgs) ElementType() reflect.Type

func (ApiFuncGraphPolicyConditionArgs) ToApiFuncGraphPolicyConditionOutput 

func (i ApiFuncGraphPolicyConditionArgs) ToApiFuncGraphPolicyConditionOutput() ApiFuncGraphPolicyConditionOutput

func (ApiFuncGraphPolicyConditionArgs) ToApiFuncGraphPolicyConditionOutputWithContext 

func (i ApiFuncGraphPolicyConditionArgs) ToApiFuncGraphPolicyConditionOutputWithContext(ctx context.Context) ApiFuncGraphPolicyConditionOutput

type ApiFuncGraphPolicyConditionArray 

type ApiFuncGraphPolicyConditionArray []ApiFuncGraphPolicyConditionInput

func (ApiFuncGraphPolicyConditionArray) ElementType 

func (ApiFuncGraphPolicyConditionArray) ElementType() reflect.Type

func (ApiFuncGraphPolicyConditionArray) ToApiFuncGraphPolicyConditionArrayOutput 

func (i ApiFuncGraphPolicyConditionArray) ToApiFuncGraphPolicyConditionArrayOutput() ApiFuncGraphPolicyConditionArrayOutput

func (ApiFuncGraphPolicyConditionArray) ToApiFuncGraphPolicyConditionArrayOutputWithContext 

func (i ApiFuncGraphPolicyConditionArray) ToApiFuncGraphPolicyConditionArrayOutputWithContext(ctx context.Context) ApiFuncGraphPolicyConditionArrayOutput

type ApiFuncGraphPolicyConditionArrayInput 

type ApiFuncGraphPolicyConditionArrayInput interface {
	pulumi.Input

	ToApiFuncGraphPolicyConditionArrayOutput() ApiFuncGraphPolicyConditionArrayOutput
	ToApiFuncGraphPolicyConditionArrayOutputWithContext(context.Context) ApiFuncGraphPolicyConditionArrayOutput
}

ApiFuncGraphPolicyConditionArrayInput is an input type that accepts ApiFuncGraphPolicyConditionArray and ApiFuncGraphPolicyConditionArrayOutput values. You can construct a concrete instance of `ApiFuncGraphPolicyConditionArrayInput` via: 

ApiFuncGraphPolicyConditionArray{ ApiFuncGraphPolicyConditionArgs{...} }

type ApiFuncGraphPolicyConditionArrayOutput 

type ApiFuncGraphPolicyConditionArrayOutput struct{ *pulumi.OutputState }

func (ApiFuncGraphPolicyConditionArrayOutput) ElementType 

func (ApiFuncGraphPolicyConditionArrayOutput) ElementType() reflect.Type

func (ApiFuncGraphPolicyConditionArrayOutput) Index 

func (o ApiFuncGraphPolicyConditionArrayOutput) Index(i pulumi.IntInput) ApiFuncGraphPolicyConditionOutput

func (ApiFuncGraphPolicyConditionArrayOutput) ToApiFuncGraphPolicyConditionArrayOutput 

func (o ApiFuncGraphPolicyConditionArrayOutput) ToApiFuncGraphPolicyConditionArrayOutput() ApiFuncGraphPolicyConditionArrayOutput

func (ApiFuncGraphPolicyConditionArrayOutput) ToApiFuncGraphPolicyConditionArrayOutputWithContext 

func (o ApiFuncGraphPolicyConditionArrayOutput) ToApiFuncGraphPolicyConditionArrayOutputWithContext(ctx context.Context) ApiFuncGraphPolicyConditionArrayOutput

type ApiFuncGraphPolicyConditionInput 

type ApiFuncGraphPolicyConditionInput interface {
	pulumi.Input

	ToApiFuncGraphPolicyConditionOutput() ApiFuncGraphPolicyConditionOutput
	ToApiFuncGraphPolicyConditionOutputWithContext(context.Context) ApiFuncGraphPolicyConditionOutput
}

ApiFuncGraphPolicyConditionInput is an input type that accepts ApiFuncGraphPolicyConditionArgs and ApiFuncGraphPolicyConditionOutput values. You can construct a concrete instance of `ApiFuncGraphPolicyConditionInput` via: 

ApiFuncGraphPolicyConditionArgs{...}

type ApiFuncGraphPolicyConditionOutput 

type ApiFuncGraphPolicyConditionOutput struct{ *pulumi.OutputState }

func (ApiFuncGraphPolicyConditionOutput) ElementType 

func (ApiFuncGraphPolicyConditionOutput) ElementType() reflect.Type

func (ApiFuncGraphPolicyConditionOutput) ParamName 

func (o ApiFuncGraphPolicyConditionOutput) ParamName() pulumi.StringPtrOutput

Specifies the request parameter name. This parameter is required if the policy type is **param**.

func (ApiFuncGraphPolicyConditionOutput) Source 

func (o ApiFuncGraphPolicyConditionOutput) Source() pulumi.StringPtrOutput

Specifies the backend policy type.\ The valid values are **param** and **source**, defaults to **source**.

func (ApiFuncGraphPolicyConditionOutput) ToApiFuncGraphPolicyConditionOutput 

func (o ApiFuncGraphPolicyConditionOutput) ToApiFuncGraphPolicyConditionOutput() ApiFuncGraphPolicyConditionOutput

func (ApiFuncGraphPolicyConditionOutput) ToApiFuncGraphPolicyConditionOutputWithContext 

func (o ApiFuncGraphPolicyConditionOutput) ToApiFuncGraphPolicyConditionOutputWithContext(ctx context.Context) ApiFuncGraphPolicyConditionOutput

func (ApiFuncGraphPolicyConditionOutput) Type 

func (o ApiFuncGraphPolicyConditionOutput) Type() pulumi.StringPtrOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

func (ApiFuncGraphPolicyConditionOutput) Value 

func (o ApiFuncGraphPolicyConditionOutput) Value() pulumi.StringOutput

Specifies the value of the backend policy.\ For a condition with the input parameter source: + If the condition type is **Enumerated**, separate condition values with commas. + If the condition type is **Matching**, enter a regular expression compatible with PERL.

type ApiFuncGraphPolicyInput 

type ApiFuncGraphPolicyInput interface {
	pulumi.Input

	ToApiFuncGraphPolicyOutput() ApiFuncGraphPolicyOutput
	ToApiFuncGraphPolicyOutputWithContext(context.Context) ApiFuncGraphPolicyOutput
}

ApiFuncGraphPolicyInput is an input type that accepts ApiFuncGraphPolicyArgs and ApiFuncGraphPolicyOutput values. You can construct a concrete instance of `ApiFuncGraphPolicyInput` via: 

ApiFuncGraphPolicyArgs{...}

type ApiFuncGraphPolicyOutput 

type ApiFuncGraphPolicyOutput struct{ *pulumi.OutputState }

func (ApiFuncGraphPolicyOutput) AuthorizerId 

func (o ApiFuncGraphPolicyOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiFuncGraphPolicyOutput) BackendParams 

func (o ApiFuncGraphPolicyOutput) BackendParams() ApiFuncGraphPolicyBackendParamArrayOutput

Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.

func (ApiFuncGraphPolicyOutput) Conditions 

func (o ApiFuncGraphPolicyOutput) Conditions() ApiFuncGraphPolicyConditionArrayOutput

Specifies an array of one or more policy conditions.\ Up to five conditions can be set. The object structure is documented below.

func (ApiFuncGraphPolicyOutput) EffectiveMode 

func (o ApiFuncGraphPolicyOutput) EffectiveMode() pulumi.StringPtrOutput

Specifies the effective mode of the backend policy. The valid values are **ALL** and **ANY**, defaults to **ANY**.

func (ApiFuncGraphPolicyOutput) ElementType 

func (ApiFuncGraphPolicyOutput) ElementType() reflect.Type

func (ApiFuncGraphPolicyOutput) FunctionUrn 

func (o ApiFuncGraphPolicyOutput) FunctionUrn() pulumi.StringOutput

Specifies the URN of the FunctionGraph function.

func (ApiFuncGraphPolicyOutput) InvocationMode 

func (o ApiFuncGraphPolicyOutput) InvocationMode() pulumi.StringPtrOutput

Specifies the invocation mode of the FunctionGraph function.\ The valid values are **async** and **sync**, defaults to **sync**.

func (ApiFuncGraphPolicyOutput) Name 

func (o ApiFuncGraphPolicyOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiFuncGraphPolicyOutput) Timeout 

func (o ApiFuncGraphPolicyOutput) Timeout() pulumi.IntPtrOutput

Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from `1` to `600,000`, defaults to `5,000`.

func (ApiFuncGraphPolicyOutput) ToApiFuncGraphPolicyOutput 

func (o ApiFuncGraphPolicyOutput) ToApiFuncGraphPolicyOutput() ApiFuncGraphPolicyOutput

func (ApiFuncGraphPolicyOutput) ToApiFuncGraphPolicyOutputWithContext 

func (o ApiFuncGraphPolicyOutput) ToApiFuncGraphPolicyOutputWithContext(ctx context.Context) ApiFuncGraphPolicyOutput

func (ApiFuncGraphPolicyOutput) Version 

func (o ApiFuncGraphPolicyOutput) Version() pulumi.StringPtrOutput

Specifies the version of the FunctionGraph function.

type ApiFuncGraphPtrInput 

type ApiFuncGraphPtrInput interface {
	pulumi.Input

	ToApiFuncGraphPtrOutput() ApiFuncGraphPtrOutput
	ToApiFuncGraphPtrOutputWithContext(context.Context) ApiFuncGraphPtrOutput
}

ApiFuncGraphPtrInput is an input type that accepts ApiFuncGraphArgs, ApiFuncGraphPtr and ApiFuncGraphPtrOutput values. You can construct a concrete instance of `ApiFuncGraphPtrInput` via: 

        ApiFuncGraphArgs{...}

or:

        nil

func ApiFuncGraphPtr 

func ApiFuncGraphPtr(v *ApiFuncGraphArgs) ApiFuncGraphPtrInput

type ApiFuncGraphPtrOutput 

type ApiFuncGraphPtrOutput struct{ *pulumi.OutputState }

func (ApiFuncGraphPtrOutput) AuthorizerId 

func (o ApiFuncGraphPtrOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiFuncGraphPtrOutput) Elem 

func (o ApiFuncGraphPtrOutput) Elem() ApiFuncGraphOutput

func (ApiFuncGraphPtrOutput) ElementType 

func (ApiFuncGraphPtrOutput) ElementType() reflect.Type

func (ApiFuncGraphPtrOutput) FunctionUrn 

func (o ApiFuncGraphPtrOutput) FunctionUrn() pulumi.StringPtrOutput

Specifies the URN of the FunctionGraph function.

func (ApiFuncGraphPtrOutput) InvocationType 

func (o ApiFuncGraphPtrOutput) InvocationType() pulumi.StringPtrOutput

Specifies the invocation type.\ The valid values are **async** and **sync**, defaults to **sync**.

func (ApiFuncGraphPtrOutput) Timeout 

func (o ApiFuncGraphPtrOutput) Timeout() pulumi.IntPtrOutput

Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from `1` to `600,000`, defaults to `5,000`.

func (ApiFuncGraphPtrOutput) ToApiFuncGraphPtrOutput 

func (o ApiFuncGraphPtrOutput) ToApiFuncGraphPtrOutput() ApiFuncGraphPtrOutput

func (ApiFuncGraphPtrOutput) ToApiFuncGraphPtrOutputWithContext 

func (o ApiFuncGraphPtrOutput) ToApiFuncGraphPtrOutputWithContext(ctx context.Context) ApiFuncGraphPtrOutput

func (ApiFuncGraphPtrOutput) Version 

func (o ApiFuncGraphPtrOutput) Version() pulumi.StringPtrOutput

Specifies the version of the FunctionGraph function.

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 ApiMock 

type ApiMock struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId *string `pulumi:"authorizerId"`
	// Specifies the response of the backend policy.\
	// The description contains a maximum of `2,048` characters and the angle brackets (< and >) are not allowed.
	Response *string `pulumi:"response"`
}

type ApiMockArgs 

type ApiMockArgs struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrInput `pulumi:"authorizerId"`
	// Specifies the response of the backend policy.\
	// The description contains a maximum of `2,048` characters and the angle brackets (< and >) are not allowed.
	Response pulumi.StringPtrInput `pulumi:"response"`
}

func (ApiMockArgs) ElementType 

func (ApiMockArgs) ElementType() reflect.Type

func (ApiMockArgs) ToApiMockOutput 

func (i ApiMockArgs) ToApiMockOutput() ApiMockOutput

func (ApiMockArgs) ToApiMockOutputWithContext 

func (i ApiMockArgs) ToApiMockOutputWithContext(ctx context.Context) ApiMockOutput

func (ApiMockArgs) ToApiMockPtrOutput 

func (i ApiMockArgs) ToApiMockPtrOutput() ApiMockPtrOutput

func (ApiMockArgs) ToApiMockPtrOutputWithContext 

func (i ApiMockArgs) ToApiMockPtrOutputWithContext(ctx context.Context) ApiMockPtrOutput

type ApiMockInput 

type ApiMockInput interface {
	pulumi.Input

	ToApiMockOutput() ApiMockOutput
	ToApiMockOutputWithContext(context.Context) ApiMockOutput
}

ApiMockInput is an input type that accepts ApiMockArgs and ApiMockOutput values. You can construct a concrete instance of `ApiMockInput` via: 

ApiMockArgs{...}

type ApiMockOutput 

type ApiMockOutput struct{ *pulumi.OutputState }

func (ApiMockOutput) AuthorizerId 

func (o ApiMockOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiMockOutput) ElementType 

func (ApiMockOutput) ElementType() reflect.Type

func (ApiMockOutput) Response 

func (o ApiMockOutput) Response() pulumi.StringPtrOutput

Specifies the response of the backend policy.\ The description contains a maximum of `2,048` characters and the angle brackets (< and >) are not allowed.

func (ApiMockOutput) ToApiMockOutput 

func (o ApiMockOutput) ToApiMockOutput() ApiMockOutput

func (ApiMockOutput) ToApiMockOutputWithContext 

func (o ApiMockOutput) ToApiMockOutputWithContext(ctx context.Context) ApiMockOutput

func (ApiMockOutput) ToApiMockPtrOutput 

func (o ApiMockOutput) ToApiMockPtrOutput() ApiMockPtrOutput

func (ApiMockOutput) ToApiMockPtrOutputWithContext 

func (o ApiMockOutput) ToApiMockPtrOutputWithContext(ctx context.Context) ApiMockPtrOutput

type ApiMockPolicy 

type ApiMockPolicy struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId *string `pulumi:"authorizerId"`
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams []ApiMockPolicyBackendParam `pulumi:"backendParams"`
	// Specifies an array of one or more policy conditions.\
	// Up to five conditions can be set.
	// The object structure is documented below.
	Conditions []ApiMockPolicyCondition `pulumi:"conditions"`
	// Specifies the effective mode of the backend policy. The valid values are **ALL**
	// and **ANY**, defaults to **ANY**.
	EffectiveMode *string `pulumi:"effectiveMode"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies the response of the backend policy.\
	// The description contains a maximum of `2,048` characters and the angle brackets (< and >) are not allowed.
	Response *string `pulumi:"response"`
}

type ApiMockPolicyArgs 

type ApiMockPolicyArgs struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrInput `pulumi:"authorizerId"`
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams ApiMockPolicyBackendParamArrayInput `pulumi:"backendParams"`
	// Specifies an array of one or more policy conditions.\
	// Up to five conditions can be set.
	// The object structure is documented below.
	Conditions ApiMockPolicyConditionArrayInput `pulumi:"conditions"`
	// Specifies the effective mode of the backend policy. The valid values are **ALL**
	// and **ANY**, defaults to **ANY**.
	EffectiveMode pulumi.StringPtrInput `pulumi:"effectiveMode"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the response of the backend policy.\
	// The description contains a maximum of `2,048` characters and the angle brackets (< and >) are not allowed.
	Response pulumi.StringPtrInput `pulumi:"response"`
}

func (ApiMockPolicyArgs) ElementType 

func (ApiMockPolicyArgs) ElementType() reflect.Type

func (ApiMockPolicyArgs) ToApiMockPolicyOutput 

func (i ApiMockPolicyArgs) ToApiMockPolicyOutput() ApiMockPolicyOutput

func (ApiMockPolicyArgs) ToApiMockPolicyOutputWithContext 

func (i ApiMockPolicyArgs) ToApiMockPolicyOutputWithContext(ctx context.Context) ApiMockPolicyOutput

type ApiMockPolicyArray 

type ApiMockPolicyArray []ApiMockPolicyInput

func (ApiMockPolicyArray) ElementType 

func (ApiMockPolicyArray) ElementType() reflect.Type

func (ApiMockPolicyArray) ToApiMockPolicyArrayOutput 

func (i ApiMockPolicyArray) ToApiMockPolicyArrayOutput() ApiMockPolicyArrayOutput

func (ApiMockPolicyArray) ToApiMockPolicyArrayOutputWithContext 

func (i ApiMockPolicyArray) ToApiMockPolicyArrayOutputWithContext(ctx context.Context) ApiMockPolicyArrayOutput

type ApiMockPolicyArrayInput 

type ApiMockPolicyArrayInput interface {
	pulumi.Input

	ToApiMockPolicyArrayOutput() ApiMockPolicyArrayOutput
	ToApiMockPolicyArrayOutputWithContext(context.Context) ApiMockPolicyArrayOutput
}

ApiMockPolicyArrayInput is an input type that accepts ApiMockPolicyArray and ApiMockPolicyArrayOutput values. You can construct a concrete instance of `ApiMockPolicyArrayInput` via: 

ApiMockPolicyArray{ ApiMockPolicyArgs{...} }

type ApiMockPolicyArrayOutput 

type ApiMockPolicyArrayOutput struct{ *pulumi.OutputState }

func (ApiMockPolicyArrayOutput) ElementType 

func (ApiMockPolicyArrayOutput) ElementType() reflect.Type

func (ApiMockPolicyArrayOutput) Index 

func (o ApiMockPolicyArrayOutput) Index(i pulumi.IntInput) ApiMockPolicyOutput

func (ApiMockPolicyArrayOutput) ToApiMockPolicyArrayOutput 

func (o ApiMockPolicyArrayOutput) ToApiMockPolicyArrayOutput() ApiMockPolicyArrayOutput

func (ApiMockPolicyArrayOutput) ToApiMockPolicyArrayOutputWithContext 

func (o ApiMockPolicyArrayOutput) ToApiMockPolicyArrayOutputWithContext(ctx context.Context) ApiMockPolicyArrayOutput

type ApiMockPolicyBackendParam 

type ApiMockPolicyBackendParam struct {
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description *string `pulumi:"description"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location string `pulumi:"location"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies the type of the system parameter.\
	// The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.
	SystemParamType *string `pulumi:"systemParamType"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type string `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value string `pulumi:"value"`
}

type ApiMockPolicyBackendParamArgs 

type ApiMockPolicyBackendParamArgs struct {
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location pulumi.StringInput `pulumi:"location"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the type of the system parameter.\
	// The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.
	SystemParamType pulumi.StringPtrInput `pulumi:"systemParamType"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringInput `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ApiMockPolicyBackendParamArgs) ElementType 

func (ApiMockPolicyBackendParamArgs) ElementType() reflect.Type

func (ApiMockPolicyBackendParamArgs) ToApiMockPolicyBackendParamOutput 

func (i ApiMockPolicyBackendParamArgs) ToApiMockPolicyBackendParamOutput() ApiMockPolicyBackendParamOutput

func (ApiMockPolicyBackendParamArgs) ToApiMockPolicyBackendParamOutputWithContext 

func (i ApiMockPolicyBackendParamArgs) ToApiMockPolicyBackendParamOutputWithContext(ctx context.Context) ApiMockPolicyBackendParamOutput

type ApiMockPolicyBackendParamArray 

type ApiMockPolicyBackendParamArray []ApiMockPolicyBackendParamInput

func (ApiMockPolicyBackendParamArray) ElementType 

func (ApiMockPolicyBackendParamArray) ElementType() reflect.Type

func (ApiMockPolicyBackendParamArray) ToApiMockPolicyBackendParamArrayOutput 

func (i ApiMockPolicyBackendParamArray) ToApiMockPolicyBackendParamArrayOutput() ApiMockPolicyBackendParamArrayOutput

func (ApiMockPolicyBackendParamArray) ToApiMockPolicyBackendParamArrayOutputWithContext 

func (i ApiMockPolicyBackendParamArray) ToApiMockPolicyBackendParamArrayOutputWithContext(ctx context.Context) ApiMockPolicyBackendParamArrayOutput

type ApiMockPolicyBackendParamArrayInput 

type ApiMockPolicyBackendParamArrayInput interface {
	pulumi.Input

	ToApiMockPolicyBackendParamArrayOutput() ApiMockPolicyBackendParamArrayOutput
	ToApiMockPolicyBackendParamArrayOutputWithContext(context.Context) ApiMockPolicyBackendParamArrayOutput
}

ApiMockPolicyBackendParamArrayInput is an input type that accepts ApiMockPolicyBackendParamArray and ApiMockPolicyBackendParamArrayOutput values. You can construct a concrete instance of `ApiMockPolicyBackendParamArrayInput` via: 

ApiMockPolicyBackendParamArray{ ApiMockPolicyBackendParamArgs{...} }

type ApiMockPolicyBackendParamArrayOutput 

type ApiMockPolicyBackendParamArrayOutput struct{ *pulumi.OutputState }

func (ApiMockPolicyBackendParamArrayOutput) ElementType 

func (ApiMockPolicyBackendParamArrayOutput) ElementType() reflect.Type

func (ApiMockPolicyBackendParamArrayOutput) Index 

func (o ApiMockPolicyBackendParamArrayOutput) Index(i pulumi.IntInput) ApiMockPolicyBackendParamOutput

func (ApiMockPolicyBackendParamArrayOutput) ToApiMockPolicyBackendParamArrayOutput 

func (o ApiMockPolicyBackendParamArrayOutput) ToApiMockPolicyBackendParamArrayOutput() ApiMockPolicyBackendParamArrayOutput

func (ApiMockPolicyBackendParamArrayOutput) ToApiMockPolicyBackendParamArrayOutputWithContext 

func (o ApiMockPolicyBackendParamArrayOutput) ToApiMockPolicyBackendParamArrayOutputWithContext(ctx context.Context) ApiMockPolicyBackendParamArrayOutput

type ApiMockPolicyBackendParamInput 

type ApiMockPolicyBackendParamInput interface {
	pulumi.Input

	ToApiMockPolicyBackendParamOutput() ApiMockPolicyBackendParamOutput
	ToApiMockPolicyBackendParamOutputWithContext(context.Context) ApiMockPolicyBackendParamOutput
}

ApiMockPolicyBackendParamInput is an input type that accepts ApiMockPolicyBackendParamArgs and ApiMockPolicyBackendParamOutput values. You can construct a concrete instance of `ApiMockPolicyBackendParamInput` via: 

ApiMockPolicyBackendParamArgs{...}

type ApiMockPolicyBackendParamOutput 

type ApiMockPolicyBackendParamOutput struct{ *pulumi.OutputState }

func (ApiMockPolicyBackendParamOutput) Description 

func (o ApiMockPolicyBackendParamOutput) Description() pulumi.StringPtrOutput

Specifies the description of the constant or system parameter.\ The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ApiMockPolicyBackendParamOutput) ElementType 

func (ApiMockPolicyBackendParamOutput) ElementType() reflect.Type

func (ApiMockPolicyBackendParamOutput) Location 

func (o ApiMockPolicyBackendParamOutput) Location() pulumi.StringOutput

Specifies the location of the backend parameter.\ The valid values are **PATH**, **QUERY** and **HEADER**.

func (ApiMockPolicyBackendParamOutput) Name 

func (o ApiMockPolicyBackendParamOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiMockPolicyBackendParamOutput) SystemParamType added in v0.0.8 

func (o ApiMockPolicyBackendParamOutput) SystemParamType() pulumi.StringPtrOutput

Specifies the type of the system parameter.\ The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.

func (ApiMockPolicyBackendParamOutput) ToApiMockPolicyBackendParamOutput 

func (o ApiMockPolicyBackendParamOutput) ToApiMockPolicyBackendParamOutput() ApiMockPolicyBackendParamOutput

func (ApiMockPolicyBackendParamOutput) ToApiMockPolicyBackendParamOutputWithContext 

func (o ApiMockPolicyBackendParamOutput) ToApiMockPolicyBackendParamOutputWithContext(ctx context.Context) ApiMockPolicyBackendParamOutput

func (ApiMockPolicyBackendParamOutput) Type 

func (o ApiMockPolicyBackendParamOutput) Type() pulumi.StringOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

func (ApiMockPolicyBackendParamOutput) Value 

func (o ApiMockPolicyBackendParamOutput) Value() pulumi.StringOutput

Specifies the value of the backend policy.\ For a condition with the input parameter source: + If the condition type is **Enumerated**, separate condition values with commas. + If the condition type is **Matching**, enter a regular expression compatible with PERL.

type ApiMockPolicyCondition 

type ApiMockPolicyCondition struct {
	// Specifies the request parameter name.
	// This parameter is required if the policy type is **param**.
	ParamName *string `pulumi:"paramName"`
	// Specifies the backend policy type.\
	// The valid values are **param** and **source**, defaults to **source**.
	Source *string `pulumi:"source"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type *string `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value string `pulumi:"value"`
}

type ApiMockPolicyConditionArgs 

type ApiMockPolicyConditionArgs struct {
	// Specifies the request parameter name.
	// This parameter is required if the policy type is **param**.
	ParamName pulumi.StringPtrInput `pulumi:"paramName"`
	// Specifies the backend policy type.\
	// The valid values are **param** and **source**, defaults to **source**.
	Source pulumi.StringPtrInput `pulumi:"source"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringPtrInput `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ApiMockPolicyConditionArgs) ElementType 

func (ApiMockPolicyConditionArgs) ElementType() reflect.Type

func (ApiMockPolicyConditionArgs) ToApiMockPolicyConditionOutput 

func (i ApiMockPolicyConditionArgs) ToApiMockPolicyConditionOutput() ApiMockPolicyConditionOutput

func (ApiMockPolicyConditionArgs) ToApiMockPolicyConditionOutputWithContext 

func (i ApiMockPolicyConditionArgs) ToApiMockPolicyConditionOutputWithContext(ctx context.Context) ApiMockPolicyConditionOutput

type ApiMockPolicyConditionArray 

type ApiMockPolicyConditionArray []ApiMockPolicyConditionInput

func (ApiMockPolicyConditionArray) ElementType 

func (ApiMockPolicyConditionArray) ElementType() reflect.Type

func (ApiMockPolicyConditionArray) ToApiMockPolicyConditionArrayOutput 

func (i ApiMockPolicyConditionArray) ToApiMockPolicyConditionArrayOutput() ApiMockPolicyConditionArrayOutput

func (ApiMockPolicyConditionArray) ToApiMockPolicyConditionArrayOutputWithContext 

func (i ApiMockPolicyConditionArray) ToApiMockPolicyConditionArrayOutputWithContext(ctx context.Context) ApiMockPolicyConditionArrayOutput

type ApiMockPolicyConditionArrayInput 

type ApiMockPolicyConditionArrayInput interface {
	pulumi.Input

	ToApiMockPolicyConditionArrayOutput() ApiMockPolicyConditionArrayOutput
	ToApiMockPolicyConditionArrayOutputWithContext(context.Context) ApiMockPolicyConditionArrayOutput
}

ApiMockPolicyConditionArrayInput is an input type that accepts ApiMockPolicyConditionArray and ApiMockPolicyConditionArrayOutput values. You can construct a concrete instance of `ApiMockPolicyConditionArrayInput` via: 

ApiMockPolicyConditionArray{ ApiMockPolicyConditionArgs{...} }

type ApiMockPolicyConditionArrayOutput 

type ApiMockPolicyConditionArrayOutput struct{ *pulumi.OutputState }

func (ApiMockPolicyConditionArrayOutput) ElementType 

func (ApiMockPolicyConditionArrayOutput) ElementType() reflect.Type

func (ApiMockPolicyConditionArrayOutput) Index 

func (o ApiMockPolicyConditionArrayOutput) Index(i pulumi.IntInput) ApiMockPolicyConditionOutput

func (ApiMockPolicyConditionArrayOutput) ToApiMockPolicyConditionArrayOutput 

func (o ApiMockPolicyConditionArrayOutput) ToApiMockPolicyConditionArrayOutput() ApiMockPolicyConditionArrayOutput

func (ApiMockPolicyConditionArrayOutput) ToApiMockPolicyConditionArrayOutputWithContext 

func (o ApiMockPolicyConditionArrayOutput) ToApiMockPolicyConditionArrayOutputWithContext(ctx context.Context) ApiMockPolicyConditionArrayOutput

type ApiMockPolicyConditionInput 

type ApiMockPolicyConditionInput interface {
	pulumi.Input

	ToApiMockPolicyConditionOutput() ApiMockPolicyConditionOutput
	ToApiMockPolicyConditionOutputWithContext(context.Context) ApiMockPolicyConditionOutput
}

ApiMockPolicyConditionInput is an input type that accepts ApiMockPolicyConditionArgs and ApiMockPolicyConditionOutput values. You can construct a concrete instance of `ApiMockPolicyConditionInput` via: 

ApiMockPolicyConditionArgs{...}

type ApiMockPolicyConditionOutput 

type ApiMockPolicyConditionOutput struct{ *pulumi.OutputState }

func (ApiMockPolicyConditionOutput) ElementType 

func (ApiMockPolicyConditionOutput) ElementType() reflect.Type

func (ApiMockPolicyConditionOutput) ParamName 

func (o ApiMockPolicyConditionOutput) ParamName() pulumi.StringPtrOutput

Specifies the request parameter name. This parameter is required if the policy type is **param**.

func (ApiMockPolicyConditionOutput) Source 

func (o ApiMockPolicyConditionOutput) Source() pulumi.StringPtrOutput

Specifies the backend policy type.\ The valid values are **param** and **source**, defaults to **source**.

func (ApiMockPolicyConditionOutput) ToApiMockPolicyConditionOutput 

func (o ApiMockPolicyConditionOutput) ToApiMockPolicyConditionOutput() ApiMockPolicyConditionOutput

func (ApiMockPolicyConditionOutput) ToApiMockPolicyConditionOutputWithContext 

func (o ApiMockPolicyConditionOutput) ToApiMockPolicyConditionOutputWithContext(ctx context.Context) ApiMockPolicyConditionOutput

func (ApiMockPolicyConditionOutput) Type 

func (o ApiMockPolicyConditionOutput) Type() pulumi.StringPtrOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

func (ApiMockPolicyConditionOutput) Value 

func (o ApiMockPolicyConditionOutput) Value() pulumi.StringOutput

Specifies the value of the backend policy.\ For a condition with the input parameter source: + If the condition type is **Enumerated**, separate condition values with commas. + If the condition type is **Matching**, enter a regular expression compatible with PERL.

type ApiMockPolicyInput 

type ApiMockPolicyInput interface {
	pulumi.Input

	ToApiMockPolicyOutput() ApiMockPolicyOutput
	ToApiMockPolicyOutputWithContext(context.Context) ApiMockPolicyOutput
}

ApiMockPolicyInput is an input type that accepts ApiMockPolicyArgs and ApiMockPolicyOutput values. You can construct a concrete instance of `ApiMockPolicyInput` via: 

ApiMockPolicyArgs{...}

type ApiMockPolicyOutput 

type ApiMockPolicyOutput struct{ *pulumi.OutputState }

func (ApiMockPolicyOutput) AuthorizerId 

func (o ApiMockPolicyOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiMockPolicyOutput) BackendParams 

func (o ApiMockPolicyOutput) BackendParams() ApiMockPolicyBackendParamArrayOutput

Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.

func (ApiMockPolicyOutput) Conditions 

func (o ApiMockPolicyOutput) Conditions() ApiMockPolicyConditionArrayOutput

Specifies an array of one or more policy conditions.\ Up to five conditions can be set. The object structure is documented below.

func (ApiMockPolicyOutput) EffectiveMode 

func (o ApiMockPolicyOutput) EffectiveMode() pulumi.StringPtrOutput

Specifies the effective mode of the backend policy. The valid values are **ALL** and **ANY**, defaults to **ANY**.

func (ApiMockPolicyOutput) ElementType 

func (ApiMockPolicyOutput) ElementType() reflect.Type

func (ApiMockPolicyOutput) Name 

func (o ApiMockPolicyOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiMockPolicyOutput) Response 

func (o ApiMockPolicyOutput) Response() pulumi.StringPtrOutput

Specifies the response of the backend policy.\ The description contains a maximum of `2,048` characters and the angle brackets (< and >) are not allowed.

func (ApiMockPolicyOutput) ToApiMockPolicyOutput 

func (o ApiMockPolicyOutput) ToApiMockPolicyOutput() ApiMockPolicyOutput

func (ApiMockPolicyOutput) ToApiMockPolicyOutputWithContext 

func (o ApiMockPolicyOutput) ToApiMockPolicyOutputWithContext(ctx context.Context) ApiMockPolicyOutput

type ApiMockPtrInput 

type ApiMockPtrInput interface {
	pulumi.Input

	ToApiMockPtrOutput() ApiMockPtrOutput
	ToApiMockPtrOutputWithContext(context.Context) ApiMockPtrOutput
}

ApiMockPtrInput is an input type that accepts ApiMockArgs, ApiMockPtr and ApiMockPtrOutput values. You can construct a concrete instance of `ApiMockPtrInput` via: 

        ApiMockArgs{...}

or:

        nil

func ApiMockPtr 

func ApiMockPtr(v *ApiMockArgs) ApiMockPtrInput

type ApiMockPtrOutput 

type ApiMockPtrOutput struct{ *pulumi.OutputState }

func (ApiMockPtrOutput) AuthorizerId 

func (o ApiMockPtrOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiMockPtrOutput) Elem 

func (o ApiMockPtrOutput) Elem() ApiMockOutput

func (ApiMockPtrOutput) ElementType 

func (ApiMockPtrOutput) ElementType() reflect.Type

func (ApiMockPtrOutput) Response 

func (o ApiMockPtrOutput) Response() pulumi.StringPtrOutput

Specifies the response of the backend policy.\ The description contains a maximum of `2,048` characters and the angle brackets (< and >) are not allowed.

func (ApiMockPtrOutput) ToApiMockPtrOutput 

func (o ApiMockPtrOutput) ToApiMockPtrOutput() ApiMockPtrOutput

func (ApiMockPtrOutput) ToApiMockPtrOutputWithContext 

func (o ApiMockPtrOutput) ToApiMockPtrOutputWithContext(ctx context.Context) ApiMockPtrOutput

type ApiOutput 

type ApiOutput struct{ *pulumi.OutputState }

func (ApiOutput) AuthorizerId 

func (o ApiOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiOutput) BackendParams 

func (o ApiOutput) BackendParams() ApiBackendParamArrayOutput

Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.

func (ApiOutput) BodyDescription 

func (o ApiOutput) BodyDescription() pulumi.StringPtrOutput

Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed `20,480` characters.

func (ApiOutput) Cors 

func (o ApiOutput) Cors() pulumi.BoolPtrOutput

Specifies whether CORS is supported, defaults to **false**.

func (ApiOutput) Description 

func (o ApiOutput) Description() pulumi.StringPtrOutput

Specifies the description of the constant or system parameter.\ The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ApiOutput) ElementType 

func (ApiOutput) ElementType() reflect.Type

func (ApiOutput) FailureResponse 

func (o ApiOutput) FailureResponse() pulumi.StringPtrOutput

Specifies the example response for a failure request.\ The response contains a maximum of `20,480` characters.

func (ApiOutput) FuncGraph 

func (o ApiOutput) FuncGraph() ApiFuncGraphOutput

Specifies the function graph backend details.\ The object structure is documented below. Changing this will create a new API resource.

func (ApiOutput) FuncGraphPolicies 

func (o ApiOutput) FuncGraphPolicies() ApiFuncGraphPolicyArrayOutput

Specifies the Mock policy backends.\ The maximum blocks of the policy is 5. The object structure is documented below.

func (ApiOutput) GroupId 

func (o ApiOutput) GroupId() pulumi.StringOutput

Specifies an ID of the APIG group to which the API belongs to.

func (ApiOutput) InstanceId 

func (o ApiOutput) InstanceId() pulumi.StringOutput

Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.

func (ApiOutput) Matching 

func (o ApiOutput) Matching() pulumi.StringPtrOutput

Specifies the route matching mode.\ The valid values are **Exact** and **Prefix**, defaults to **Exact**.

func (ApiOutput) Mock 

func (o ApiOutput) Mock() ApiMockOutput

Specifies the mock backend details.\ The object structure is documented below. Changing this will create a new API resource.

func (ApiOutput) MockPolicies 

func (o ApiOutput) MockPolicies() ApiMockPolicyArrayOutput

Specifies the Mock policy backends.\ The maximum blocks of the policy is 5. The object structure is documented below.

func (ApiOutput) Name 

func (o ApiOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiOutput) Region 

func (o ApiOutput) Region() pulumi.StringOutput

Specifies the region where the API is located.\ If omitted, the provider-level region will be used. Changing this will create a new API resource.

func (ApiOutput) RegisteredAt added in v0.0.8 

func (o ApiOutput) RegisteredAt() pulumi.StringOutput

The registered time of the API.

func (ApiOutput) RequestMethod 

func (o ApiOutput) RequestMethod() pulumi.StringOutput

Specifies the backend request method of the API.\ The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.

func (ApiOutput) RequestParams 

func (o ApiOutput) RequestParams() ApiRequestParamArrayOutput

Specifies the configurations of the front-end parameters.\ The object structure is documented below.

func (ApiOutput) RequestPath 

func (o ApiOutput) RequestPath() pulumi.StringOutput

Specifies the request address, which can contain a maximum of `512` characters, the request parameters enclosed with brackets ({}).

  • The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
  • The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters.

func (ApiOutput) RequestProtocol 

func (o ApiOutput) RequestProtocol() pulumi.StringOutput

Specifies the backend request protocol. The valid values are **HTTP** and **HTTPS**, defaults to **HTTPS**.

func (ApiOutput) ResponseId 

func (o ApiOutput) ResponseId() pulumi.StringPtrOutput

Specifies the APIG group response ID.

func (ApiOutput) SecurityAuthentication 

func (o ApiOutput) SecurityAuthentication() pulumi.StringPtrOutput

Specifies the security authentication mode of the API request.\ The valid values are **NONE**, **APP** and **IAM**, defaults to **NONE**.

func (ApiOutput) SimpleAuthentication 

func (o ApiOutput) SimpleAuthentication() pulumi.BoolOutput

Specifies whether the authentication of the application code is enabled.\ The application code must located in the header when `simpleAuthentication` is true.

func (ApiOutput) SuccessResponse 

func (o ApiOutput) SuccessResponse() pulumi.StringPtrOutput

Specifies the example response for a successful request.\ The response contains a maximum of `20,480` characters.

func (ApiOutput) ToApiOutput 

func (o ApiOutput) ToApiOutput() ApiOutput

func (ApiOutput) ToApiOutputWithContext 

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

func (ApiOutput) Type 

func (o ApiOutput) Type() pulumi.StringOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

func (ApiOutput) UpdatedAt added in v0.0.8 

func (o ApiOutput) UpdatedAt() pulumi.StringOutput

The latest update time of the API.

func (ApiOutput) Web 

func (o ApiOutput) Web() ApiWebOutput

Specifies the web backend details.\ The object structure is documented below. Changing this will create a new API resource.

func (ApiOutput) WebPolicies 

func (o ApiOutput) WebPolicies() ApiWebPolicyArrayOutput

Specifies the example response for a failed request.\ The maximum blocks of the policy is 5. The object structure is documented below.

type ApiPublishment 

type ApiPublishment struct {
	pulumi.CustomResourceState

	// Specifies the ID of the API to be published or already published.\
	// Changing this will create a new resource.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// Specifies the description of the current publishment.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies the ID of the environmentto which the current version of the API
	// will be published or has been published.
	// Changing this will create a new resource.
	EnvId pulumi.StringOutput `pulumi:"envId"`
	// The name of the environment to which the current version of the API is published.
	EnvName pulumi.StringOutput `pulumi:"envName"`
	// All publish informations of the API.\
	// The object structure is documented below.
	Histories ApiPublishmentHistoryArrayOutput `pulumi:"histories"`
	// Specifies an ID of the APIG dedicated instance to which the API belongs
	// to. Changing this will create a new publishment resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// The publish ID of the API in current environment.
	PublishId pulumi.StringOutput `pulumi:"publishId"`
	// Time when the current version was published.
	PublishedAt pulumi.StringOutput `pulumi:"publishedAt"`
	// Specifies the region in which to publish APIs.\
	// If omitted, the provider-level region will be used.
	// Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// Specifies the version ID of the current publishment.
	VersionId pulumi.StringPtrOutput `pulumi:"versionId"`
}

## Example Usage ### Publish a new version of the API

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		envId := cfg.RequireObject("envId")
		apiId := cfg.RequireObject("apiId")
		_, err := DedicatedApig.NewApiPublishment(ctx, "default", &DedicatedApig.ApiPublishmentArgs{
			InstanceId: pulumi.Any(instanceId),
			EnvId:      pulumi.Any(envId),
			ApiId:      pulumi.Any(apiId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Switch to a specified version of the API which is published

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		envId := cfg.RequireObject("envId")
		apiId := cfg.RequireObject("apiId")
		versionId := cfg.RequireObject("versionId")
		_, err := DedicatedApig.NewApiPublishment(ctx, "default", &DedicatedApig.ApiPublishmentArgs{
			InstanceId: pulumi.Any(instanceId),
			EnvId:      pulumi.Any(envId),
			ApiId:      pulumi.Any(apiId),
			VersionId:  pulumi.Any(versionId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

The publishments can be imported using their related `instance_id`, `env_id` and `api_id`, separated by slashes, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/apiPublishment:ApiPublishment test <instance_id>/<env_id>/<api_id>

```

func GetApiPublishment 

func GetApiPublishment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApiPublishmentState, opts ...pulumi.ResourceOption) (*ApiPublishment, error)

GetApiPublishment gets an existing ApiPublishment 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 NewApiPublishment 

func NewApiPublishment(ctx *pulumi.Context,
	name string, args *ApiPublishmentArgs, opts ...pulumi.ResourceOption) (*ApiPublishment, error)

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

func (*ApiPublishment) ElementType 

func (*ApiPublishment) ElementType() reflect.Type

func (*ApiPublishment) ToApiPublishmentOutput 

func (i *ApiPublishment) ToApiPublishmentOutput() ApiPublishmentOutput

func (*ApiPublishment) ToApiPublishmentOutputWithContext 

func (i *ApiPublishment) ToApiPublishmentOutputWithContext(ctx context.Context) ApiPublishmentOutput

type ApiPublishmentArgs 

type ApiPublishmentArgs struct {
	// Specifies the ID of the API to be published or already published.\
	// Changing this will create a new resource.
	ApiId pulumi.StringInput
	// Specifies the description of the current publishment.
	Description pulumi.StringPtrInput
	// Specifies the ID of the environmentto which the current version of the API
	// will be published or has been published.
	// Changing this will create a new resource.
	EnvId pulumi.StringInput
	// Specifies an ID of the APIG dedicated instance to which the API belongs
	// to. Changing this will create a new publishment resource.
	InstanceId pulumi.StringInput
	// Specifies the region in which to publish APIs.\
	// If omitted, the provider-level region will be used.
	// Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the version ID of the current publishment.
	VersionId pulumi.StringPtrInput
}

The set of arguments for constructing a ApiPublishment resource.

func (ApiPublishmentArgs) ElementType 

func (ApiPublishmentArgs) ElementType() reflect.Type

type ApiPublishmentArray 

type ApiPublishmentArray []ApiPublishmentInput

func (ApiPublishmentArray) ElementType 

func (ApiPublishmentArray) ElementType() reflect.Type

func (ApiPublishmentArray) ToApiPublishmentArrayOutput 

func (i ApiPublishmentArray) ToApiPublishmentArrayOutput() ApiPublishmentArrayOutput

func (ApiPublishmentArray) ToApiPublishmentArrayOutputWithContext 

func (i ApiPublishmentArray) ToApiPublishmentArrayOutputWithContext(ctx context.Context) ApiPublishmentArrayOutput

type ApiPublishmentArrayInput 

type ApiPublishmentArrayInput interface {
	pulumi.Input

	ToApiPublishmentArrayOutput() ApiPublishmentArrayOutput
	ToApiPublishmentArrayOutputWithContext(context.Context) ApiPublishmentArrayOutput
}

ApiPublishmentArrayInput is an input type that accepts ApiPublishmentArray and ApiPublishmentArrayOutput values. You can construct a concrete instance of `ApiPublishmentArrayInput` via: 

ApiPublishmentArray{ ApiPublishmentArgs{...} }

type ApiPublishmentArrayOutput 

type ApiPublishmentArrayOutput struct{ *pulumi.OutputState }

func (ApiPublishmentArrayOutput) ElementType 

func (ApiPublishmentArrayOutput) ElementType() reflect.Type

func (ApiPublishmentArrayOutput) Index 

func (o ApiPublishmentArrayOutput) Index(i pulumi.IntInput) ApiPublishmentOutput

func (ApiPublishmentArrayOutput) ToApiPublishmentArrayOutput 

func (o ApiPublishmentArrayOutput) ToApiPublishmentArrayOutput() ApiPublishmentArrayOutput

func (ApiPublishmentArrayOutput) ToApiPublishmentArrayOutputWithContext 

func (o ApiPublishmentArrayOutput) ToApiPublishmentArrayOutputWithContext(ctx context.Context) ApiPublishmentArrayOutput

type ApiPublishmentHistory 

type ApiPublishmentHistory struct {
	// Specifies the description of the current publishment.
	Description *string `pulumi:"description"`
	// Specifies the version ID of the current publishment.
	VersionId *string `pulumi:"versionId"`
}

type ApiPublishmentHistoryArgs 

type ApiPublishmentHistoryArgs struct {
	// Specifies the description of the current publishment.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the version ID of the current publishment.
	VersionId pulumi.StringPtrInput `pulumi:"versionId"`
}

func (ApiPublishmentHistoryArgs) ElementType 

func (ApiPublishmentHistoryArgs) ElementType() reflect.Type

func (ApiPublishmentHistoryArgs) ToApiPublishmentHistoryOutput 

func (i ApiPublishmentHistoryArgs) ToApiPublishmentHistoryOutput() ApiPublishmentHistoryOutput

func (ApiPublishmentHistoryArgs) ToApiPublishmentHistoryOutputWithContext 

func (i ApiPublishmentHistoryArgs) ToApiPublishmentHistoryOutputWithContext(ctx context.Context) ApiPublishmentHistoryOutput

type ApiPublishmentHistoryArray 

type ApiPublishmentHistoryArray []ApiPublishmentHistoryInput

func (ApiPublishmentHistoryArray) ElementType 

func (ApiPublishmentHistoryArray) ElementType() reflect.Type

func (ApiPublishmentHistoryArray) ToApiPublishmentHistoryArrayOutput 

func (i ApiPublishmentHistoryArray) ToApiPublishmentHistoryArrayOutput() ApiPublishmentHistoryArrayOutput

func (ApiPublishmentHistoryArray) ToApiPublishmentHistoryArrayOutputWithContext 

func (i ApiPublishmentHistoryArray) ToApiPublishmentHistoryArrayOutputWithContext(ctx context.Context) ApiPublishmentHistoryArrayOutput

type ApiPublishmentHistoryArrayInput 

type ApiPublishmentHistoryArrayInput interface {
	pulumi.Input

	ToApiPublishmentHistoryArrayOutput() ApiPublishmentHistoryArrayOutput
	ToApiPublishmentHistoryArrayOutputWithContext(context.Context) ApiPublishmentHistoryArrayOutput
}

ApiPublishmentHistoryArrayInput is an input type that accepts ApiPublishmentHistoryArray and ApiPublishmentHistoryArrayOutput values. You can construct a concrete instance of `ApiPublishmentHistoryArrayInput` via: 

ApiPublishmentHistoryArray{ ApiPublishmentHistoryArgs{...} }

type ApiPublishmentHistoryArrayOutput 

type ApiPublishmentHistoryArrayOutput struct{ *pulumi.OutputState }

func (ApiPublishmentHistoryArrayOutput) ElementType 

func (ApiPublishmentHistoryArrayOutput) ElementType() reflect.Type

func (ApiPublishmentHistoryArrayOutput) Index 

func (o ApiPublishmentHistoryArrayOutput) Index(i pulumi.IntInput) ApiPublishmentHistoryOutput

func (ApiPublishmentHistoryArrayOutput) ToApiPublishmentHistoryArrayOutput 

func (o ApiPublishmentHistoryArrayOutput) ToApiPublishmentHistoryArrayOutput() ApiPublishmentHistoryArrayOutput

func (ApiPublishmentHistoryArrayOutput) ToApiPublishmentHistoryArrayOutputWithContext 

func (o ApiPublishmentHistoryArrayOutput) ToApiPublishmentHistoryArrayOutputWithContext(ctx context.Context) ApiPublishmentHistoryArrayOutput

type ApiPublishmentHistoryInput 

type ApiPublishmentHistoryInput interface {
	pulumi.Input

	ToApiPublishmentHistoryOutput() ApiPublishmentHistoryOutput
	ToApiPublishmentHistoryOutputWithContext(context.Context) ApiPublishmentHistoryOutput
}

ApiPublishmentHistoryInput is an input type that accepts ApiPublishmentHistoryArgs and ApiPublishmentHistoryOutput values. You can construct a concrete instance of `ApiPublishmentHistoryInput` via: 

ApiPublishmentHistoryArgs{...}

type ApiPublishmentHistoryOutput 

type ApiPublishmentHistoryOutput struct{ *pulumi.OutputState }

func (ApiPublishmentHistoryOutput) Description 

func (o ApiPublishmentHistoryOutput) Description() pulumi.StringPtrOutput

Specifies the description of the current publishment.

func (ApiPublishmentHistoryOutput) ElementType 

func (ApiPublishmentHistoryOutput) ElementType() reflect.Type

func (ApiPublishmentHistoryOutput) ToApiPublishmentHistoryOutput 

func (o ApiPublishmentHistoryOutput) ToApiPublishmentHistoryOutput() ApiPublishmentHistoryOutput

func (ApiPublishmentHistoryOutput) ToApiPublishmentHistoryOutputWithContext 

func (o ApiPublishmentHistoryOutput) ToApiPublishmentHistoryOutputWithContext(ctx context.Context) ApiPublishmentHistoryOutput

func (ApiPublishmentHistoryOutput) VersionId 

func (o ApiPublishmentHistoryOutput) VersionId() pulumi.StringPtrOutput

Specifies the version ID of the current publishment.

type ApiPublishmentInput 

type ApiPublishmentInput interface {
	pulumi.Input

	ToApiPublishmentOutput() ApiPublishmentOutput
	ToApiPublishmentOutputWithContext(ctx context.Context) ApiPublishmentOutput
}

type ApiPublishmentMap 

type ApiPublishmentMap map[string]ApiPublishmentInput

func (ApiPublishmentMap) ElementType 

func (ApiPublishmentMap) ElementType() reflect.Type

func (ApiPublishmentMap) ToApiPublishmentMapOutput 

func (i ApiPublishmentMap) ToApiPublishmentMapOutput() ApiPublishmentMapOutput

func (ApiPublishmentMap) ToApiPublishmentMapOutputWithContext 

func (i ApiPublishmentMap) ToApiPublishmentMapOutputWithContext(ctx context.Context) ApiPublishmentMapOutput

type ApiPublishmentMapInput 

type ApiPublishmentMapInput interface {
	pulumi.Input

	ToApiPublishmentMapOutput() ApiPublishmentMapOutput
	ToApiPublishmentMapOutputWithContext(context.Context) ApiPublishmentMapOutput
}

ApiPublishmentMapInput is an input type that accepts ApiPublishmentMap and ApiPublishmentMapOutput values. You can construct a concrete instance of `ApiPublishmentMapInput` via: 

ApiPublishmentMap{ "key": ApiPublishmentArgs{...} }

type ApiPublishmentMapOutput 

type ApiPublishmentMapOutput struct{ *pulumi.OutputState }

func (ApiPublishmentMapOutput) ElementType 

func (ApiPublishmentMapOutput) ElementType() reflect.Type

func (ApiPublishmentMapOutput) MapIndex 

func (o ApiPublishmentMapOutput) MapIndex(k pulumi.StringInput) ApiPublishmentOutput

func (ApiPublishmentMapOutput) ToApiPublishmentMapOutput 

func (o ApiPublishmentMapOutput) ToApiPublishmentMapOutput() ApiPublishmentMapOutput

func (ApiPublishmentMapOutput) ToApiPublishmentMapOutputWithContext 

func (o ApiPublishmentMapOutput) ToApiPublishmentMapOutputWithContext(ctx context.Context) ApiPublishmentMapOutput

type ApiPublishmentOutput 

type ApiPublishmentOutput struct{ *pulumi.OutputState }

func (ApiPublishmentOutput) ApiId 

func (o ApiPublishmentOutput) ApiId() pulumi.StringOutput

Specifies the ID of the API to be published or already published.\ Changing this will create a new resource.

func (ApiPublishmentOutput) Description 

func (o ApiPublishmentOutput) Description() pulumi.StringPtrOutput

Specifies the description of the current publishment.

func (ApiPublishmentOutput) ElementType 

func (ApiPublishmentOutput) ElementType() reflect.Type

func (ApiPublishmentOutput) EnvId 

func (o ApiPublishmentOutput) EnvId() pulumi.StringOutput

Specifies the ID of the environmentto which the current version of the API will be published or has been published. Changing this will create a new resource.

func (ApiPublishmentOutput) EnvName 

func (o ApiPublishmentOutput) EnvName() pulumi.StringOutput

The name of the environment to which the current version of the API is published.

func (ApiPublishmentOutput) Histories 

func (o ApiPublishmentOutput) Histories() ApiPublishmentHistoryArrayOutput

All publish informations of the API.\ The object structure is documented below.

func (ApiPublishmentOutput) InstanceId 

func (o ApiPublishmentOutput) InstanceId() pulumi.StringOutput

Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new publishment resource.

func (ApiPublishmentOutput) PublishId 

func (o ApiPublishmentOutput) PublishId() pulumi.StringOutput

The publish ID of the API in current environment.

func (ApiPublishmentOutput) PublishedAt added in v0.0.8 

func (o ApiPublishmentOutput) PublishedAt() pulumi.StringOutput

Time when the current version was published.

func (ApiPublishmentOutput) Region 

func (o ApiPublishmentOutput) Region() pulumi.StringOutput

Specifies the region in which to publish APIs.\ If omitted, the provider-level region will be used. Changing this will create a new resource.

func (ApiPublishmentOutput) ToApiPublishmentOutput 

func (o ApiPublishmentOutput) ToApiPublishmentOutput() ApiPublishmentOutput

func (ApiPublishmentOutput) ToApiPublishmentOutputWithContext 

func (o ApiPublishmentOutput) ToApiPublishmentOutputWithContext(ctx context.Context) ApiPublishmentOutput

func (ApiPublishmentOutput) VersionId 

func (o ApiPublishmentOutput) VersionId() pulumi.StringPtrOutput

Specifies the version ID of the current publishment.

type ApiPublishmentState 

type ApiPublishmentState struct {
	// Specifies the ID of the API to be published or already published.\
	// Changing this will create a new resource.
	ApiId pulumi.StringPtrInput
	// Specifies the description of the current publishment.
	Description pulumi.StringPtrInput
	// Specifies the ID of the environmentto which the current version of the API
	// will be published or has been published.
	// Changing this will create a new resource.
	EnvId pulumi.StringPtrInput
	// The name of the environment to which the current version of the API is published.
	EnvName pulumi.StringPtrInput
	// All publish informations of the API.\
	// The object structure is documented below.
	Histories ApiPublishmentHistoryArrayInput
	// Specifies an ID of the APIG dedicated instance to which the API belongs
	// to. Changing this will create a new publishment resource.
	InstanceId pulumi.StringPtrInput
	// The publish ID of the API in current environment.
	PublishId pulumi.StringPtrInput
	// Time when the current version was published.
	PublishedAt pulumi.StringPtrInput
	// Specifies the region in which to publish APIs.\
	// If omitted, the provider-level region will be used.
	// Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the version ID of the current publishment.
	VersionId pulumi.StringPtrInput
}

func (ApiPublishmentState) ElementType 

func (ApiPublishmentState) ElementType() reflect.Type

type ApiRequestParam 

type ApiRequestParam struct {
	// Specifies the default value of the request parameter.
	// The value contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Default *string `pulumi:"default"`
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description *string `pulumi:"description"`
	// Specifies the example value of the request parameter.\
	// The example contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Example *string `pulumi:"example"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location *string `pulumi:"location"`
	// Specifies the maximum value or size of the request parameter.
	Maximum *int `pulumi:"maximum"`
	// Specifies the minimum value or size of the request parameter.
	Minimum *int `pulumi:"minimum"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies whether the request parameter is required.
	Required bool `pulumi:"required"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type *string `pulumi:"type"`
}

type ApiRequestParamArgs 

type ApiRequestParamArgs struct {
	// Specifies the default value of the request parameter.
	// The value contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Default pulumi.StringPtrInput `pulumi:"default"`
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the example value of the request parameter.\
	// The example contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Example pulumi.StringPtrInput `pulumi:"example"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location pulumi.StringPtrInput `pulumi:"location"`
	// Specifies the maximum value or size of the request parameter.
	Maximum pulumi.IntPtrInput `pulumi:"maximum"`
	// Specifies the minimum value or size of the request parameter.
	Minimum pulumi.IntPtrInput `pulumi:"minimum"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies whether the request parameter is required.
	Required pulumi.BoolInput `pulumi:"required"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringPtrInput `pulumi:"type"`
}

func (ApiRequestParamArgs) ElementType 

func (ApiRequestParamArgs) ElementType() reflect.Type

func (ApiRequestParamArgs) ToApiRequestParamOutput 

func (i ApiRequestParamArgs) ToApiRequestParamOutput() ApiRequestParamOutput

func (ApiRequestParamArgs) ToApiRequestParamOutputWithContext 

func (i ApiRequestParamArgs) ToApiRequestParamOutputWithContext(ctx context.Context) ApiRequestParamOutput

type ApiRequestParamArray 

type ApiRequestParamArray []ApiRequestParamInput

func (ApiRequestParamArray) ElementType 

func (ApiRequestParamArray) ElementType() reflect.Type

func (ApiRequestParamArray) ToApiRequestParamArrayOutput 

func (i ApiRequestParamArray) ToApiRequestParamArrayOutput() ApiRequestParamArrayOutput

func (ApiRequestParamArray) ToApiRequestParamArrayOutputWithContext 

func (i ApiRequestParamArray) ToApiRequestParamArrayOutputWithContext(ctx context.Context) ApiRequestParamArrayOutput

type ApiRequestParamArrayInput 

type ApiRequestParamArrayInput interface {
	pulumi.Input

	ToApiRequestParamArrayOutput() ApiRequestParamArrayOutput
	ToApiRequestParamArrayOutputWithContext(context.Context) ApiRequestParamArrayOutput
}

ApiRequestParamArrayInput is an input type that accepts ApiRequestParamArray and ApiRequestParamArrayOutput values. You can construct a concrete instance of `ApiRequestParamArrayInput` via: 

ApiRequestParamArray{ ApiRequestParamArgs{...} }

type ApiRequestParamArrayOutput 

type ApiRequestParamArrayOutput struct{ *pulumi.OutputState }

func (ApiRequestParamArrayOutput) ElementType 

func (ApiRequestParamArrayOutput) ElementType() reflect.Type

func (ApiRequestParamArrayOutput) Index 

func (o ApiRequestParamArrayOutput) Index(i pulumi.IntInput) ApiRequestParamOutput

func (ApiRequestParamArrayOutput) ToApiRequestParamArrayOutput 

func (o ApiRequestParamArrayOutput) ToApiRequestParamArrayOutput() ApiRequestParamArrayOutput

func (ApiRequestParamArrayOutput) ToApiRequestParamArrayOutputWithContext 

func (o ApiRequestParamArrayOutput) ToApiRequestParamArrayOutputWithContext(ctx context.Context) ApiRequestParamArrayOutput

type ApiRequestParamInput 

type ApiRequestParamInput interface {
	pulumi.Input

	ToApiRequestParamOutput() ApiRequestParamOutput
	ToApiRequestParamOutputWithContext(context.Context) ApiRequestParamOutput
}

ApiRequestParamInput is an input type that accepts ApiRequestParamArgs and ApiRequestParamOutput values. You can construct a concrete instance of `ApiRequestParamInput` via: 

ApiRequestParamArgs{...}

type ApiRequestParamOutput 

type ApiRequestParamOutput struct{ *pulumi.OutputState }

func (ApiRequestParamOutput) Default 

func (o ApiRequestParamOutput) Default() pulumi.StringPtrOutput

Specifies the default value of the request parameter. The value contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ApiRequestParamOutput) Description 

func (o ApiRequestParamOutput) Description() pulumi.StringPtrOutput

Specifies the description of the constant or system parameter.\ The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ApiRequestParamOutput) ElementType 

func (ApiRequestParamOutput) ElementType() reflect.Type

func (ApiRequestParamOutput) Example 

func (o ApiRequestParamOutput) Example() pulumi.StringPtrOutput

Specifies the example value of the request parameter.\ The example contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ApiRequestParamOutput) Location 

func (o ApiRequestParamOutput) Location() pulumi.StringPtrOutput

Specifies the location of the backend parameter.\ The valid values are **PATH**, **QUERY** and **HEADER**.

func (ApiRequestParamOutput) Maximum 

func (o ApiRequestParamOutput) Maximum() pulumi.IntPtrOutput

Specifies the maximum value or size of the request parameter.

func (ApiRequestParamOutput) Minimum 

func (o ApiRequestParamOutput) Minimum() pulumi.IntPtrOutput

Specifies the minimum value or size of the request parameter.

func (ApiRequestParamOutput) Name 

func (o ApiRequestParamOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiRequestParamOutput) Required 

func (o ApiRequestParamOutput) Required() pulumi.BoolOutput

Specifies whether the request parameter is required.

func (ApiRequestParamOutput) ToApiRequestParamOutput 

func (o ApiRequestParamOutput) ToApiRequestParamOutput() ApiRequestParamOutput

func (ApiRequestParamOutput) ToApiRequestParamOutputWithContext 

func (o ApiRequestParamOutput) ToApiRequestParamOutputWithContext(ctx context.Context) ApiRequestParamOutput

func (ApiRequestParamOutput) Type 

func (o ApiRequestParamOutput) Type() pulumi.StringPtrOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

type ApiState 

type ApiState struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrInput
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams ApiBackendParamArrayInput
	// Specifies the description of the API request body, which can be an example
	// request body, media type or parameters.
	// The request body does not exceed `20,480` characters.
	BodyDescription pulumi.StringPtrInput
	// Specifies whether CORS is supported, defaults to **false**.
	Cors pulumi.BoolPtrInput
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput
	// Specifies the example response for a failure request.\
	// The response contains a maximum of `20,480` characters.
	FailureResponse pulumi.StringPtrInput
	// Specifies the function graph backend details.\
	// The object structure is documented below.
	// Changing this will create a new API resource.
	FuncGraph ApiFuncGraphPtrInput
	// Specifies the Mock policy backends.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	FuncGraphPolicies ApiFuncGraphPolicyArrayInput
	// Specifies an ID of the APIG group to which the API belongs to.
	GroupId pulumi.StringPtrInput
	// Specifies an ID of the APIG dedicated instance to which the API belongs
	// to. Changing this will create a new API resource.
	InstanceId pulumi.StringPtrInput
	// Specifies the route matching mode.\
	// The valid values are **Exact** and **Prefix**, defaults to **Exact**.
	Matching pulumi.StringPtrInput
	// Specifies the mock backend details.\
	// The object structure is documented below.
	// Changing this will create a new API resource.
	Mock ApiMockPtrInput
	// Specifies the Mock policy backends.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	MockPolicies ApiMockPolicyArrayInput
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringPtrInput
	// Specifies the region where the API is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new API resource.
	Region pulumi.StringPtrInput
	// The registered time of the API.
	RegisteredAt pulumi.StringPtrInput
	// Specifies the backend request method of the API.\
	// The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.
	RequestMethod pulumi.StringPtrInput
	// Specifies the configurations of the front-end parameters.\
	// The object structure is documented below.
	RequestParams ApiRequestParamArrayInput
	// Specifies the request address, which can contain a maximum of `512` characters,
	// the request parameters enclosed with brackets ({}).
	// + The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-), and
	//   underscores (_) and must comply with URI specifications.
	// + The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters.
	RequestPath pulumi.StringPtrInput
	// Specifies the backend request protocol. The valid values are **HTTP** and
	// **HTTPS**, defaults to **HTTPS**.
	RequestProtocol pulumi.StringPtrInput
	// Specifies the APIG group response ID.
	ResponseId pulumi.StringPtrInput
	// Specifies the security authentication mode of the API request.\
	// The valid values are **NONE**, **APP** and **IAM**, defaults to **NONE**.
	SecurityAuthentication pulumi.StringPtrInput
	// Specifies whether the authentication of the application code is enabled.\
	// The application code must located in the header when `simpleAuthentication` is true.
	SimpleAuthentication pulumi.BoolPtrInput
	// Specifies the example response for a successful request.\
	// The response contains a maximum of `20,480` characters.
	SuccessResponse pulumi.StringPtrInput
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringPtrInput
	// The latest update time of the API.
	UpdatedAt pulumi.StringPtrInput
	// Specifies the web backend details.\
	// The object structure is documented below. Changing this will create a new API resource.
	Web ApiWebPtrInput
	// Specifies the example response for a failed request.\
	// The maximum blocks of the policy is 5.
	// The object structure is documented below.
	WebPolicies ApiWebPolicyArrayInput
}

func (ApiState) ElementType 

func (ApiState) ElementType() reflect.Type

type ApiWeb 

type ApiWeb struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId *string `pulumi:"authorizerId"`
	// Specifies the backend service address.\
	// The value which consists of a domain name or IP address, and a port number, with not more than `255` characters.
	// The backend service address must be in the format "{host name}:{Port number}", for example, `apig.example.com:7443`.
	// If the port number is not specified, the default HTTPS port `443`, or the default HTTP port `80` is used.
	// The backend service address can contain environment variables, each starting with a letter and consisting of `3` to
	// `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
	BackendAddress *string `pulumi:"backendAddress"`
	// Specifies the proxy host header.\
	// The host header can be customized for requests to be forwarded to cloud servers through the VPC channel.
	// By default, the original host header of the request is used.
	HostHeader *string `pulumi:"hostHeader"`
	// Specifies the backend request address, which can contain a maximum of `512` characters and
	// must comply with URI specifications.
	// + The address can contain request parameters enclosed with brackets ({}).
	// + The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and
	//   underscores (_) and must comply with URI specifications.
	// + The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters.
	//   Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
	Path string `pulumi:"path"`
	// Specifies the backend request method of the API.\
	// The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.
	RequestMethod *string `pulumi:"requestMethod"`
	// Specifies the backend request protocol. The valid values are **HTTP** and
	// **HTTPS**, defaults to **HTTPS**.
	RequestProtocol *string `pulumi:"requestProtocol"`
	// Specifies whether to enable two-way authentication, defaults to **false**.
	SslEnable *bool `pulumi:"sslEnable"`
	// Specifies the timeout, in ms, which allowed for APIG to request the backend service. The
	// valid value is range from `1` to `600,000`, defaults to `5,000`.
	Timeout *int `pulumi:"timeout"`
	// Specifies the VPC channel ID.\
	// This parameter and `backendAddress` are alternative.
	VpcChannelId *string `pulumi:"vpcChannelId"`
}

type ApiWebArgs 

type ApiWebArgs struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrInput `pulumi:"authorizerId"`
	// Specifies the backend service address.\
	// The value which consists of a domain name or IP address, and a port number, with not more than `255` characters.
	// The backend service address must be in the format "{host name}:{Port number}", for example, `apig.example.com:7443`.
	// If the port number is not specified, the default HTTPS port `443`, or the default HTTP port `80` is used.
	// The backend service address can contain environment variables, each starting with a letter and consisting of `3` to
	// `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
	BackendAddress pulumi.StringPtrInput `pulumi:"backendAddress"`
	// Specifies the proxy host header.\
	// The host header can be customized for requests to be forwarded to cloud servers through the VPC channel.
	// By default, the original host header of the request is used.
	HostHeader pulumi.StringPtrInput `pulumi:"hostHeader"`
	// Specifies the backend request address, which can contain a maximum of `512` characters and
	// must comply with URI specifications.
	// + The address can contain request parameters enclosed with brackets ({}).
	// + The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and
	//   underscores (_) and must comply with URI specifications.
	// + The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters.
	//   Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
	Path pulumi.StringInput `pulumi:"path"`
	// Specifies the backend request method of the API.\
	// The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.
	RequestMethod pulumi.StringPtrInput `pulumi:"requestMethod"`
	// Specifies the backend request protocol. The valid values are **HTTP** and
	// **HTTPS**, defaults to **HTTPS**.
	RequestProtocol pulumi.StringPtrInput `pulumi:"requestProtocol"`
	// Specifies whether to enable two-way authentication, defaults to **false**.
	SslEnable pulumi.BoolPtrInput `pulumi:"sslEnable"`
	// Specifies the timeout, in ms, which allowed for APIG to request the backend service. The
	// valid value is range from `1` to `600,000`, defaults to `5,000`.
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// Specifies the VPC channel ID.\
	// This parameter and `backendAddress` are alternative.
	VpcChannelId pulumi.StringPtrInput `pulumi:"vpcChannelId"`
}

func (ApiWebArgs) ElementType 

func (ApiWebArgs) ElementType() reflect.Type

func (ApiWebArgs) ToApiWebOutput 

func (i ApiWebArgs) ToApiWebOutput() ApiWebOutput

func (ApiWebArgs) ToApiWebOutputWithContext 

func (i ApiWebArgs) ToApiWebOutputWithContext(ctx context.Context) ApiWebOutput

func (ApiWebArgs) ToApiWebPtrOutput 

func (i ApiWebArgs) ToApiWebPtrOutput() ApiWebPtrOutput

func (ApiWebArgs) ToApiWebPtrOutputWithContext 

func (i ApiWebArgs) ToApiWebPtrOutputWithContext(ctx context.Context) ApiWebPtrOutput

type ApiWebInput 

type ApiWebInput interface {
	pulumi.Input

	ToApiWebOutput() ApiWebOutput
	ToApiWebOutputWithContext(context.Context) ApiWebOutput
}

ApiWebInput is an input type that accepts ApiWebArgs and ApiWebOutput values. You can construct a concrete instance of `ApiWebInput` via: 

ApiWebArgs{...}

type ApiWebOutput 

type ApiWebOutput struct{ *pulumi.OutputState }

func (ApiWebOutput) AuthorizerId 

func (o ApiWebOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiWebOutput) BackendAddress 

func (o ApiWebOutput) BackendAddress() pulumi.StringPtrOutput

Specifies the backend service address.\ The value which consists of a domain name or IP address, and a port number, with not more than `255` characters. The backend service address must be in the format "{host name}:{Port number}", for example, `apig.example.com:7443`. If the port number is not specified, the default HTTPS port `443`, or the default HTTP port `80` is used. The backend service address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

func (ApiWebOutput) ElementType 

func (ApiWebOutput) ElementType() reflect.Type

func (ApiWebOutput) HostHeader 

func (o ApiWebOutput) HostHeader() pulumi.StringPtrOutput

Specifies the proxy host header.\ The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.

func (ApiWebOutput) Path 

func (o ApiWebOutput) Path() pulumi.StringOutput

Specifies the backend request address, which can contain a maximum of `512` characters and must comply with URI specifications.

  • The address can contain request parameters enclosed with brackets ({}).
  • The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
  • The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.

func (ApiWebOutput) RequestMethod 

func (o ApiWebOutput) RequestMethod() pulumi.StringPtrOutput

Specifies the backend request method of the API.\ The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.

func (ApiWebOutput) RequestProtocol 

func (o ApiWebOutput) RequestProtocol() pulumi.StringPtrOutput

Specifies the backend request protocol. The valid values are **HTTP** and **HTTPS**, defaults to **HTTPS**.

func (ApiWebOutput) SslEnable 

func (o ApiWebOutput) SslEnable() pulumi.BoolPtrOutput

Specifies whether to enable two-way authentication, defaults to **false**.

func (ApiWebOutput) Timeout 

func (o ApiWebOutput) Timeout() pulumi.IntPtrOutput

Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from `1` to `600,000`, defaults to `5,000`.

func (ApiWebOutput) ToApiWebOutput 

func (o ApiWebOutput) ToApiWebOutput() ApiWebOutput

func (ApiWebOutput) ToApiWebOutputWithContext 

func (o ApiWebOutput) ToApiWebOutputWithContext(ctx context.Context) ApiWebOutput

func (ApiWebOutput) ToApiWebPtrOutput 

func (o ApiWebOutput) ToApiWebPtrOutput() ApiWebPtrOutput

func (ApiWebOutput) ToApiWebPtrOutputWithContext 

func (o ApiWebOutput) ToApiWebPtrOutputWithContext(ctx context.Context) ApiWebPtrOutput

func (ApiWebOutput) VpcChannelId 

func (o ApiWebOutput) VpcChannelId() pulumi.StringPtrOutput

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

type ApiWebPolicy 

type ApiWebPolicy struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId *string `pulumi:"authorizerId"`
	// Specifies the backend service address.\
	// The value which consists of a domain name or IP address, and a port number, with not more than `255` characters.
	// The backend service address must be in the format "{host name}:{Port number}", for example, `apig.example.com:7443`.
	// If the port number is not specified, the default HTTPS port `443`, or the default HTTP port `80` is used.
	// The backend service address can contain environment variables, each starting with a letter and consisting of `3` to
	// `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
	BackendAddress *string `pulumi:"backendAddress"`
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams []ApiWebPolicyBackendParam `pulumi:"backendParams"`
	// Specifies an array of one or more policy conditions.\
	// Up to five conditions can be set.
	// The object structure is documented below.
	Conditions []ApiWebPolicyCondition `pulumi:"conditions"`
	// Specifies the effective mode of the backend policy. The valid values are **ALL**
	// and **ANY**, defaults to **ANY**.
	EffectiveMode *string `pulumi:"effectiveMode"`
	// Specifies the proxy host header.\
	// The host header can be customized for requests to be forwarded to cloud servers through the VPC channel.
	// By default, the original host header of the request is used.
	HostHeader *string `pulumi:"hostHeader"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies the backend request address, which can contain a maximum of `512` characters and
	// must comply with URI specifications.
	// + The address can contain request parameters enclosed with brackets ({}).
	// + The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and
	//   underscores (_) and must comply with URI specifications.
	// + The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters.
	//   Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
	Path string `pulumi:"path"`
	// Specifies the backend request method of the API.\
	// The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.
	RequestMethod string `pulumi:"requestMethod"`
	// Specifies the backend request protocol. The valid values are **HTTP** and
	// **HTTPS**, defaults to **HTTPS**.
	RequestProtocol *string `pulumi:"requestProtocol"`
	// Specifies the timeout, in ms, which allowed for APIG to request the backend service. The
	// valid value is range from `1` to `600,000`, defaults to `5,000`.
	Timeout *int `pulumi:"timeout"`
	// Specifies the VPC channel ID.\
	// This parameter and `backendAddress` are alternative.
	VpcChannelId *string `pulumi:"vpcChannelId"`
}

type ApiWebPolicyArgs 

type ApiWebPolicyArgs struct {
	// Specifies the ID of the backend custom authorization.
	AuthorizerId pulumi.StringPtrInput `pulumi:"authorizerId"`
	// Specifies the backend service address.\
	// The value which consists of a domain name or IP address, and a port number, with not more than `255` characters.
	// The backend service address must be in the format "{host name}:{Port number}", for example, `apig.example.com:7443`.
	// If the port number is not specified, the default HTTPS port `443`, or the default HTTP port `80` is used.
	// The backend service address can contain environment variables, each starting with a letter and consisting of `3` to
	// `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
	BackendAddress pulumi.StringPtrInput `pulumi:"backendAddress"`
	// Specifies an array of one or more backend parameters. The maximum of request
	// parameters is 50. The object structure is documented above.
	BackendParams ApiWebPolicyBackendParamArrayInput `pulumi:"backendParams"`
	// Specifies an array of one or more policy conditions.\
	// Up to five conditions can be set.
	// The object structure is documented below.
	Conditions ApiWebPolicyConditionArrayInput `pulumi:"conditions"`
	// Specifies the effective mode of the backend policy. The valid values are **ALL**
	// and **ANY**, defaults to **ANY**.
	EffectiveMode pulumi.StringPtrInput `pulumi:"effectiveMode"`
	// Specifies the proxy host header.\
	// The host header can be customized for requests to be forwarded to cloud servers through the VPC channel.
	// By default, the original host header of the request is used.
	HostHeader pulumi.StringPtrInput `pulumi:"hostHeader"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the backend request address, which can contain a maximum of `512` characters and
	// must comply with URI specifications.
	// + The address can contain request parameters enclosed with brackets ({}).
	// + The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and
	//   underscores (_) and must comply with URI specifications.
	// + The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters.
	//   Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
	Path pulumi.StringInput `pulumi:"path"`
	// Specifies the backend request method of the API.\
	// The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.
	RequestMethod pulumi.StringInput `pulumi:"requestMethod"`
	// Specifies the backend request protocol. The valid values are **HTTP** and
	// **HTTPS**, defaults to **HTTPS**.
	RequestProtocol pulumi.StringPtrInput `pulumi:"requestProtocol"`
	// Specifies the timeout, in ms, which allowed for APIG to request the backend service. The
	// valid value is range from `1` to `600,000`, defaults to `5,000`.
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// Specifies the VPC channel ID.\
	// This parameter and `backendAddress` are alternative.
	VpcChannelId pulumi.StringPtrInput `pulumi:"vpcChannelId"`
}

func (ApiWebPolicyArgs) ElementType 

func (ApiWebPolicyArgs) ElementType() reflect.Type

func (ApiWebPolicyArgs) ToApiWebPolicyOutput 

func (i ApiWebPolicyArgs) ToApiWebPolicyOutput() ApiWebPolicyOutput

func (ApiWebPolicyArgs) ToApiWebPolicyOutputWithContext 

func (i ApiWebPolicyArgs) ToApiWebPolicyOutputWithContext(ctx context.Context) ApiWebPolicyOutput

type ApiWebPolicyArray 

type ApiWebPolicyArray []ApiWebPolicyInput

func (ApiWebPolicyArray) ElementType 

func (ApiWebPolicyArray) ElementType() reflect.Type

func (ApiWebPolicyArray) ToApiWebPolicyArrayOutput 

func (i ApiWebPolicyArray) ToApiWebPolicyArrayOutput() ApiWebPolicyArrayOutput

func (ApiWebPolicyArray) ToApiWebPolicyArrayOutputWithContext 

func (i ApiWebPolicyArray) ToApiWebPolicyArrayOutputWithContext(ctx context.Context) ApiWebPolicyArrayOutput

type ApiWebPolicyArrayInput 

type ApiWebPolicyArrayInput interface {
	pulumi.Input

	ToApiWebPolicyArrayOutput() ApiWebPolicyArrayOutput
	ToApiWebPolicyArrayOutputWithContext(context.Context) ApiWebPolicyArrayOutput
}

ApiWebPolicyArrayInput is an input type that accepts ApiWebPolicyArray and ApiWebPolicyArrayOutput values. You can construct a concrete instance of `ApiWebPolicyArrayInput` via: 

ApiWebPolicyArray{ ApiWebPolicyArgs{...} }

type ApiWebPolicyArrayOutput 

type ApiWebPolicyArrayOutput struct{ *pulumi.OutputState }

func (ApiWebPolicyArrayOutput) ElementType 

func (ApiWebPolicyArrayOutput) ElementType() reflect.Type

func (ApiWebPolicyArrayOutput) Index 

func (o ApiWebPolicyArrayOutput) Index(i pulumi.IntInput) ApiWebPolicyOutput

func (ApiWebPolicyArrayOutput) ToApiWebPolicyArrayOutput 

func (o ApiWebPolicyArrayOutput) ToApiWebPolicyArrayOutput() ApiWebPolicyArrayOutput

func (ApiWebPolicyArrayOutput) ToApiWebPolicyArrayOutputWithContext 

func (o ApiWebPolicyArrayOutput) ToApiWebPolicyArrayOutputWithContext(ctx context.Context) ApiWebPolicyArrayOutput

type ApiWebPolicyBackendParam 

type ApiWebPolicyBackendParam struct {
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description *string `pulumi:"description"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location string `pulumi:"location"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
	// Specifies the type of the system parameter.\
	// The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.
	SystemParamType *string `pulumi:"systemParamType"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type string `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value string `pulumi:"value"`
}

type ApiWebPolicyBackendParamArgs 

type ApiWebPolicyBackendParamArgs struct {
	// Specifies the description of the constant or system parameter.\
	// The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Specifies the location of the backend parameter.\
	// The valid values are **PATH**, **QUERY** and **HEADER**.
	Location pulumi.StringInput `pulumi:"location"`
	// Specifies the backend policy name.\
	// The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the type of the system parameter.\
	// The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.
	SystemParamType pulumi.StringPtrInput `pulumi:"systemParamType"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringInput `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ApiWebPolicyBackendParamArgs) ElementType 

func (ApiWebPolicyBackendParamArgs) ElementType() reflect.Type

func (ApiWebPolicyBackendParamArgs) ToApiWebPolicyBackendParamOutput 

func (i ApiWebPolicyBackendParamArgs) ToApiWebPolicyBackendParamOutput() ApiWebPolicyBackendParamOutput

func (ApiWebPolicyBackendParamArgs) ToApiWebPolicyBackendParamOutputWithContext 

func (i ApiWebPolicyBackendParamArgs) ToApiWebPolicyBackendParamOutputWithContext(ctx context.Context) ApiWebPolicyBackendParamOutput

type ApiWebPolicyBackendParamArray 

type ApiWebPolicyBackendParamArray []ApiWebPolicyBackendParamInput

func (ApiWebPolicyBackendParamArray) ElementType 

func (ApiWebPolicyBackendParamArray) ElementType() reflect.Type

func (ApiWebPolicyBackendParamArray) ToApiWebPolicyBackendParamArrayOutput 

func (i ApiWebPolicyBackendParamArray) ToApiWebPolicyBackendParamArrayOutput() ApiWebPolicyBackendParamArrayOutput

func (ApiWebPolicyBackendParamArray) ToApiWebPolicyBackendParamArrayOutputWithContext 

func (i ApiWebPolicyBackendParamArray) ToApiWebPolicyBackendParamArrayOutputWithContext(ctx context.Context) ApiWebPolicyBackendParamArrayOutput

type ApiWebPolicyBackendParamArrayInput 

type ApiWebPolicyBackendParamArrayInput interface {
	pulumi.Input

	ToApiWebPolicyBackendParamArrayOutput() ApiWebPolicyBackendParamArrayOutput
	ToApiWebPolicyBackendParamArrayOutputWithContext(context.Context) ApiWebPolicyBackendParamArrayOutput
}

ApiWebPolicyBackendParamArrayInput is an input type that accepts ApiWebPolicyBackendParamArray and ApiWebPolicyBackendParamArrayOutput values. You can construct a concrete instance of `ApiWebPolicyBackendParamArrayInput` via: 

ApiWebPolicyBackendParamArray{ ApiWebPolicyBackendParamArgs{...} }

type ApiWebPolicyBackendParamArrayOutput 

type ApiWebPolicyBackendParamArrayOutput struct{ *pulumi.OutputState }

func (ApiWebPolicyBackendParamArrayOutput) ElementType 

func (ApiWebPolicyBackendParamArrayOutput) ElementType() reflect.Type

func (ApiWebPolicyBackendParamArrayOutput) Index 

func (o ApiWebPolicyBackendParamArrayOutput) Index(i pulumi.IntInput) ApiWebPolicyBackendParamOutput

func (ApiWebPolicyBackendParamArrayOutput) ToApiWebPolicyBackendParamArrayOutput 

func (o ApiWebPolicyBackendParamArrayOutput) ToApiWebPolicyBackendParamArrayOutput() ApiWebPolicyBackendParamArrayOutput

func (ApiWebPolicyBackendParamArrayOutput) ToApiWebPolicyBackendParamArrayOutputWithContext 

func (o ApiWebPolicyBackendParamArrayOutput) ToApiWebPolicyBackendParamArrayOutputWithContext(ctx context.Context) ApiWebPolicyBackendParamArrayOutput

type ApiWebPolicyBackendParamInput 

type ApiWebPolicyBackendParamInput interface {
	pulumi.Input

	ToApiWebPolicyBackendParamOutput() ApiWebPolicyBackendParamOutput
	ToApiWebPolicyBackendParamOutputWithContext(context.Context) ApiWebPolicyBackendParamOutput
}

ApiWebPolicyBackendParamInput is an input type that accepts ApiWebPolicyBackendParamArgs and ApiWebPolicyBackendParamOutput values. You can construct a concrete instance of `ApiWebPolicyBackendParamInput` via: 

ApiWebPolicyBackendParamArgs{...}

type ApiWebPolicyBackendParamOutput 

type ApiWebPolicyBackendParamOutput struct{ *pulumi.OutputState }

func (ApiWebPolicyBackendParamOutput) Description 

func (o ApiWebPolicyBackendParamOutput) Description() pulumi.StringPtrOutput

Specifies the description of the constant or system parameter.\ The description contains a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ApiWebPolicyBackendParamOutput) ElementType 

func (ApiWebPolicyBackendParamOutput) ElementType() reflect.Type

func (ApiWebPolicyBackendParamOutput) Location 

func (o ApiWebPolicyBackendParamOutput) Location() pulumi.StringOutput

Specifies the location of the backend parameter.\ The valid values are **PATH**, **QUERY** and **HEADER**.

func (ApiWebPolicyBackendParamOutput) Name 

func (o ApiWebPolicyBackendParamOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiWebPolicyBackendParamOutput) SystemParamType added in v0.0.8 

func (o ApiWebPolicyBackendParamOutput) SystemParamType() pulumi.StringPtrOutput

Specifies the type of the system parameter.\ The valid values are **frontend**, **backend** and **internal**, defaults to **internal**.

func (ApiWebPolicyBackendParamOutput) ToApiWebPolicyBackendParamOutput 

func (o ApiWebPolicyBackendParamOutput) ToApiWebPolicyBackendParamOutput() ApiWebPolicyBackendParamOutput

func (ApiWebPolicyBackendParamOutput) ToApiWebPolicyBackendParamOutputWithContext 

func (o ApiWebPolicyBackendParamOutput) ToApiWebPolicyBackendParamOutputWithContext(ctx context.Context) ApiWebPolicyBackendParamOutput

func (ApiWebPolicyBackendParamOutput) Type 

func (o ApiWebPolicyBackendParamOutput) Type() pulumi.StringOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

func (ApiWebPolicyBackendParamOutput) Value 

func (o ApiWebPolicyBackendParamOutput) Value() pulumi.StringOutput

Specifies the value of the backend policy.\ For a condition with the input parameter source: + If the condition type is **Enumerated**, separate condition values with commas. + If the condition type is **Matching**, enter a regular expression compatible with PERL.

type ApiWebPolicyCondition 

type ApiWebPolicyCondition struct {
	// Specifies the request parameter name.
	// This parameter is required if the policy type is **param**.
	ParamName *string `pulumi:"paramName"`
	// Specifies the backend policy type.\
	// The valid values are **param** and **source**, defaults to **source**.
	Source *string `pulumi:"source"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type *string `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value string `pulumi:"value"`
}

type ApiWebPolicyConditionArgs 

type ApiWebPolicyConditionArgs struct {
	// Specifies the request parameter name.
	// This parameter is required if the policy type is **param**.
	ParamName pulumi.StringPtrInput `pulumi:"paramName"`
	// Specifies the backend policy type.\
	// The valid values are **param** and **source**, defaults to **source**.
	Source pulumi.StringPtrInput `pulumi:"source"`
	// Specifies the condition type of the backend policy.\
	// The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.
	Type pulumi.StringPtrInput `pulumi:"type"`
	// Specifies the value of the backend policy.\
	// For a condition with the input parameter source:
	// + If the condition type is **Enumerated**, separate condition values with commas.
	// + If the condition type is **Matching**, enter a regular expression compatible with PERL.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ApiWebPolicyConditionArgs) ElementType 

func (ApiWebPolicyConditionArgs) ElementType() reflect.Type

func (ApiWebPolicyConditionArgs) ToApiWebPolicyConditionOutput 

func (i ApiWebPolicyConditionArgs) ToApiWebPolicyConditionOutput() ApiWebPolicyConditionOutput

func (ApiWebPolicyConditionArgs) ToApiWebPolicyConditionOutputWithContext 

func (i ApiWebPolicyConditionArgs) ToApiWebPolicyConditionOutputWithContext(ctx context.Context) ApiWebPolicyConditionOutput

type ApiWebPolicyConditionArray 

type ApiWebPolicyConditionArray []ApiWebPolicyConditionInput

func (ApiWebPolicyConditionArray) ElementType 

func (ApiWebPolicyConditionArray) ElementType() reflect.Type

func (ApiWebPolicyConditionArray) ToApiWebPolicyConditionArrayOutput 

func (i ApiWebPolicyConditionArray) ToApiWebPolicyConditionArrayOutput() ApiWebPolicyConditionArrayOutput

func (ApiWebPolicyConditionArray) ToApiWebPolicyConditionArrayOutputWithContext 

func (i ApiWebPolicyConditionArray) ToApiWebPolicyConditionArrayOutputWithContext(ctx context.Context) ApiWebPolicyConditionArrayOutput

type ApiWebPolicyConditionArrayInput 

type ApiWebPolicyConditionArrayInput interface {
	pulumi.Input

	ToApiWebPolicyConditionArrayOutput() ApiWebPolicyConditionArrayOutput
	ToApiWebPolicyConditionArrayOutputWithContext(context.Context) ApiWebPolicyConditionArrayOutput
}

ApiWebPolicyConditionArrayInput is an input type that accepts ApiWebPolicyConditionArray and ApiWebPolicyConditionArrayOutput values. You can construct a concrete instance of `ApiWebPolicyConditionArrayInput` via: 

ApiWebPolicyConditionArray{ ApiWebPolicyConditionArgs{...} }

type ApiWebPolicyConditionArrayOutput 

type ApiWebPolicyConditionArrayOutput struct{ *pulumi.OutputState }

func (ApiWebPolicyConditionArrayOutput) ElementType 

func (ApiWebPolicyConditionArrayOutput) ElementType() reflect.Type

func (ApiWebPolicyConditionArrayOutput) Index 

func (o ApiWebPolicyConditionArrayOutput) Index(i pulumi.IntInput) ApiWebPolicyConditionOutput

func (ApiWebPolicyConditionArrayOutput) ToApiWebPolicyConditionArrayOutput 

func (o ApiWebPolicyConditionArrayOutput) ToApiWebPolicyConditionArrayOutput() ApiWebPolicyConditionArrayOutput

func (ApiWebPolicyConditionArrayOutput) ToApiWebPolicyConditionArrayOutputWithContext 

func (o ApiWebPolicyConditionArrayOutput) ToApiWebPolicyConditionArrayOutputWithContext(ctx context.Context) ApiWebPolicyConditionArrayOutput

type ApiWebPolicyConditionInput 

type ApiWebPolicyConditionInput interface {
	pulumi.Input

	ToApiWebPolicyConditionOutput() ApiWebPolicyConditionOutput
	ToApiWebPolicyConditionOutputWithContext(context.Context) ApiWebPolicyConditionOutput
}

ApiWebPolicyConditionInput is an input type that accepts ApiWebPolicyConditionArgs and ApiWebPolicyConditionOutput values. You can construct a concrete instance of `ApiWebPolicyConditionInput` via: 

ApiWebPolicyConditionArgs{...}

type ApiWebPolicyConditionOutput 

type ApiWebPolicyConditionOutput struct{ *pulumi.OutputState }

func (ApiWebPolicyConditionOutput) ElementType 

func (ApiWebPolicyConditionOutput) ElementType() reflect.Type

func (ApiWebPolicyConditionOutput) ParamName 

func (o ApiWebPolicyConditionOutput) ParamName() pulumi.StringPtrOutput

Specifies the request parameter name. This parameter is required if the policy type is **param**.

func (ApiWebPolicyConditionOutput) Source 

func (o ApiWebPolicyConditionOutput) Source() pulumi.StringPtrOutput

Specifies the backend policy type.\ The valid values are **param** and **source**, defaults to **source**.

func (ApiWebPolicyConditionOutput) ToApiWebPolicyConditionOutput 

func (o ApiWebPolicyConditionOutput) ToApiWebPolicyConditionOutput() ApiWebPolicyConditionOutput

func (ApiWebPolicyConditionOutput) ToApiWebPolicyConditionOutputWithContext 

func (o ApiWebPolicyConditionOutput) ToApiWebPolicyConditionOutputWithContext(ctx context.Context) ApiWebPolicyConditionOutput

func (ApiWebPolicyConditionOutput) Type 

func (o ApiWebPolicyConditionOutput) Type() pulumi.StringPtrOutput

Specifies the condition type of the backend policy.\ The valid values are **Equal**, **Enumerated** and **Matching**, defaults to **Equal**.

func (ApiWebPolicyConditionOutput) Value 

func (o ApiWebPolicyConditionOutput) Value() pulumi.StringOutput

Specifies the value of the backend policy.\ For a condition with the input parameter source: + If the condition type is **Enumerated**, separate condition values with commas. + If the condition type is **Matching**, enter a regular expression compatible with PERL.

type ApiWebPolicyInput 

type ApiWebPolicyInput interface {
	pulumi.Input

	ToApiWebPolicyOutput() ApiWebPolicyOutput
	ToApiWebPolicyOutputWithContext(context.Context) ApiWebPolicyOutput
}

ApiWebPolicyInput is an input type that accepts ApiWebPolicyArgs and ApiWebPolicyOutput values. You can construct a concrete instance of `ApiWebPolicyInput` via: 

ApiWebPolicyArgs{...}

type ApiWebPolicyOutput 

type ApiWebPolicyOutput struct{ *pulumi.OutputState }

func (ApiWebPolicyOutput) AuthorizerId 

func (o ApiWebPolicyOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiWebPolicyOutput) BackendAddress 

func (o ApiWebPolicyOutput) BackendAddress() pulumi.StringPtrOutput

Specifies the backend service address.\ The value which consists of a domain name or IP address, and a port number, with not more than `255` characters. The backend service address must be in the format "{host name}:{Port number}", for example, `apig.example.com:7443`. If the port number is not specified, the default HTTPS port `443`, or the default HTTP port `80` is used. The backend service address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

func (ApiWebPolicyOutput) BackendParams 

func (o ApiWebPolicyOutput) BackendParams() ApiWebPolicyBackendParamArrayOutput

Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.

func (ApiWebPolicyOutput) Conditions 

func (o ApiWebPolicyOutput) Conditions() ApiWebPolicyConditionArrayOutput

Specifies an array of one or more policy conditions.\ Up to five conditions can be set. The object structure is documented below.

func (ApiWebPolicyOutput) EffectiveMode 

func (o ApiWebPolicyOutput) EffectiveMode() pulumi.StringPtrOutput

Specifies the effective mode of the backend policy. The valid values are **ALL** and **ANY**, defaults to **ANY**.

func (ApiWebPolicyOutput) ElementType 

func (ApiWebPolicyOutput) ElementType() reflect.Type

func (ApiWebPolicyOutput) HostHeader 

func (o ApiWebPolicyOutput) HostHeader() pulumi.StringPtrOutput

Specifies the proxy host header.\ The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.

func (ApiWebPolicyOutput) Name 

func (o ApiWebPolicyOutput) Name() pulumi.StringOutput

Specifies the backend policy name.\ The valid length is limited from can contain `3` to `64`, only letters, digits and underscores (_) are allowed.

func (ApiWebPolicyOutput) Path 

func (o ApiWebPolicyOutput) Path() pulumi.StringOutput

Specifies the backend request address, which can contain a maximum of `512` characters and must comply with URI specifications.

  • The address can contain request parameters enclosed with brackets ({}).
  • The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
  • The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.

func (ApiWebPolicyOutput) RequestMethod 

func (o ApiWebPolicyOutput) RequestMethod() pulumi.StringOutput

Specifies the backend request method of the API.\ The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.

func (ApiWebPolicyOutput) RequestProtocol 

func (o ApiWebPolicyOutput) RequestProtocol() pulumi.StringPtrOutput

Specifies the backend request protocol. The valid values are **HTTP** and **HTTPS**, defaults to **HTTPS**.

func (ApiWebPolicyOutput) Timeout 

func (o ApiWebPolicyOutput) Timeout() pulumi.IntPtrOutput

Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from `1` to `600,000`, defaults to `5,000`.

func (ApiWebPolicyOutput) ToApiWebPolicyOutput 

func (o ApiWebPolicyOutput) ToApiWebPolicyOutput() ApiWebPolicyOutput

func (ApiWebPolicyOutput) ToApiWebPolicyOutputWithContext 

func (o ApiWebPolicyOutput) ToApiWebPolicyOutputWithContext(ctx context.Context) ApiWebPolicyOutput

func (ApiWebPolicyOutput) VpcChannelId 

func (o ApiWebPolicyOutput) VpcChannelId() pulumi.StringPtrOutput

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

type ApiWebPtrInput 

type ApiWebPtrInput interface {
	pulumi.Input

	ToApiWebPtrOutput() ApiWebPtrOutput
	ToApiWebPtrOutputWithContext(context.Context) ApiWebPtrOutput
}

ApiWebPtrInput is an input type that accepts ApiWebArgs, ApiWebPtr and ApiWebPtrOutput values. You can construct a concrete instance of `ApiWebPtrInput` via: 

        ApiWebArgs{...}

or:

        nil

func ApiWebPtr 

func ApiWebPtr(v *ApiWebArgs) ApiWebPtrInput

type ApiWebPtrOutput 

type ApiWebPtrOutput struct{ *pulumi.OutputState }

func (ApiWebPtrOutput) AuthorizerId 

func (o ApiWebPtrOutput) AuthorizerId() pulumi.StringPtrOutput

Specifies the ID of the backend custom authorization.

func (ApiWebPtrOutput) BackendAddress 

func (o ApiWebPtrOutput) BackendAddress() pulumi.StringPtrOutput

Specifies the backend service address.\ The value which consists of a domain name or IP address, and a port number, with not more than `255` characters. The backend service address must be in the format "{host name}:{Port number}", for example, `apig.example.com:7443`. If the port number is not specified, the default HTTPS port `443`, or the default HTTP port `80` is used. The backend service address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

func (ApiWebPtrOutput) Elem 

func (o ApiWebPtrOutput) Elem() ApiWebOutput

func (ApiWebPtrOutput) ElementType 

func (ApiWebPtrOutput) ElementType() reflect.Type

func (ApiWebPtrOutput) HostHeader 

func (o ApiWebPtrOutput) HostHeader() pulumi.StringPtrOutput

Specifies the proxy host header.\ The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.

func (ApiWebPtrOutput) Path 

func (o ApiWebPtrOutput) Path() pulumi.StringPtrOutput

Specifies the backend request address, which can contain a maximum of `512` characters and must comply with URI specifications.

  • The address can contain request parameters enclosed with brackets ({}).
  • The address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
  • The address can contain environment variables, each starting with a letter and consisting of `3` to `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.

func (ApiWebPtrOutput) RequestMethod 

func (o ApiWebPtrOutput) RequestMethod() pulumi.StringPtrOutput

Specifies the backend request method of the API.\ The valid types are **GET**, **POST**, **PUT**, **DELETE**, **HEAD**, **PATCH**, **OPTIONS** and **ANY**.

func (ApiWebPtrOutput) RequestProtocol 

func (o ApiWebPtrOutput) RequestProtocol() pulumi.StringPtrOutput

Specifies the backend request protocol. The valid values are **HTTP** and **HTTPS**, defaults to **HTTPS**.

func (ApiWebPtrOutput) SslEnable 

func (o ApiWebPtrOutput) SslEnable() pulumi.BoolPtrOutput

Specifies whether to enable two-way authentication, defaults to **false**.

func (ApiWebPtrOutput) Timeout 

func (o ApiWebPtrOutput) Timeout() pulumi.IntPtrOutput

Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from `1` to `600,000`, defaults to `5,000`.

func (ApiWebPtrOutput) ToApiWebPtrOutput 

func (o ApiWebPtrOutput) ToApiWebPtrOutput() ApiWebPtrOutput

func (ApiWebPtrOutput) ToApiWebPtrOutputWithContext 

func (o ApiWebPtrOutput) ToApiWebPtrOutputWithContext(ctx context.Context) ApiWebPtrOutput

func (ApiWebPtrOutput) VpcChannelId 

func (o ApiWebPtrOutput) VpcChannelId() pulumi.StringPtrOutput

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

type Application 

type Application struct {
	pulumi.CustomResourceState

	// Specifies an array of one or more application codes that the application has.\
	// Up to five application codes can be created.
	// The valid length of each application code is limited from can contain `64` to `180`.
	// The application code must start with a letter, digit, plus sign (+) or slash (/).
	// Only letters, digits and following special special characters are allowed: `!@#$%+-_/=`.
	AppCodes pulumi.StringArrayOutput `pulumi:"appCodes"`
	// App key.
	AppKey pulumi.StringOutput `pulumi:"appKey"`
	// App secret.
	AppSecret pulumi.StringOutput `pulumi:"appSecret"`
	// Specifies the application description.\
	// The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringOutput `pulumi:"description"`
	// Specifies the ID of the dedicated instance to which the application
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the application name.\
	// The valid length is limited from can contain `3` to `64`, only Chinese and English letters, digits and hyphens (-)
	// are allowed.
	// The name must start with a Chinese or English letter.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the region where the application is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// the registration time.
	RegistrationTime pulumi.StringOutput `pulumi:"registrationTime"`
	// Specifies the secret action to be done for the application.\
	// The valid action is **RESET**.
	SecretAction pulumi.StringPtrOutput `pulumi:"secretAction"`
	// The latest update time of the application.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
}

Manages an APIG application resource within HuaweiCloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		appName := cfg.RequireObject("appName")
		appCode := cfg.RequireObject("appCode")
		_, err := DedicatedApig.NewApplication(ctx, "test", &DedicatedApig.ApplicationArgs{
			InstanceId:  pulumi.Any(instanceId),
			Description: pulumi.String("Created by script"),
			AppCodes: pulumi.StringArray{
				pulumi.Any(appCode),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Applications can be imported using their `id` and the ID of the related dedicated instance, separated by a slash, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/application:Application test <instance_id>/<id>

```

func GetApplication 

func GetApplication(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationState, opts ...pulumi.ResourceOption) (*Application, error)

GetApplication gets an existing Application 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 NewApplication 

func NewApplication(ctx *pulumi.Context,
	name string, args *ApplicationArgs, opts ...pulumi.ResourceOption) (*Application, error)

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

func (*Application) ElementType 

func (*Application) ElementType() reflect.Type

func (*Application) ToApplicationOutput 

func (i *Application) ToApplicationOutput() ApplicationOutput

func (*Application) ToApplicationOutputWithContext 

func (i *Application) ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput

type ApplicationArgs 

type ApplicationArgs struct {
	// Specifies an array of one or more application codes that the application has.\
	// Up to five application codes can be created.
	// The valid length of each application code is limited from can contain `64` to `180`.
	// The application code must start with a letter, digit, plus sign (+) or slash (/).
	// Only letters, digits and following special special characters are allowed: `!@#$%+-_/=`.
	AppCodes pulumi.StringArrayInput
	// Specifies the application description.\
	// The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the application
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringInput
	// Specifies the application name.\
	// The valid length is limited from can contain `3` to `64`, only Chinese and English letters, digits and hyphens (-)
	// are allowed.
	// The name must start with a Chinese or English letter.
	Name pulumi.StringPtrInput
	// Specifies the region where the application is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the secret action to be done for the application.\
	// The valid action is **RESET**.
	SecretAction pulumi.StringPtrInput
}

The set of arguments for constructing a Application resource.

func (ApplicationArgs) ElementType 

func (ApplicationArgs) ElementType() reflect.Type

type ApplicationArray 

type ApplicationArray []ApplicationInput

func (ApplicationArray) ElementType 

func (ApplicationArray) ElementType() reflect.Type

func (ApplicationArray) ToApplicationArrayOutput 

func (i ApplicationArray) ToApplicationArrayOutput() ApplicationArrayOutput

func (ApplicationArray) ToApplicationArrayOutputWithContext 

func (i ApplicationArray) ToApplicationArrayOutputWithContext(ctx context.Context) ApplicationArrayOutput

type ApplicationArrayInput 

type ApplicationArrayInput interface {
	pulumi.Input

	ToApplicationArrayOutput() ApplicationArrayOutput
	ToApplicationArrayOutputWithContext(context.Context) ApplicationArrayOutput
}

ApplicationArrayInput is an input type that accepts ApplicationArray and ApplicationArrayOutput values. You can construct a concrete instance of `ApplicationArrayInput` via: 

ApplicationArray{ ApplicationArgs{...} }

type ApplicationArrayOutput 

type ApplicationArrayOutput struct{ *pulumi.OutputState }

func (ApplicationArrayOutput) ElementType 

func (ApplicationArrayOutput) ElementType() reflect.Type

func (ApplicationArrayOutput) Index 

func (o ApplicationArrayOutput) Index(i pulumi.IntInput) ApplicationOutput

func (ApplicationArrayOutput) ToApplicationArrayOutput 

func (o ApplicationArrayOutput) ToApplicationArrayOutput() ApplicationArrayOutput

func (ApplicationArrayOutput) ToApplicationArrayOutputWithContext 

func (o ApplicationArrayOutput) ToApplicationArrayOutputWithContext(ctx context.Context) ApplicationArrayOutput

type ApplicationInput 

type ApplicationInput interface {
	pulumi.Input

	ToApplicationOutput() ApplicationOutput
	ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput
}

type ApplicationMap 

type ApplicationMap map[string]ApplicationInput

func (ApplicationMap) ElementType 

func (ApplicationMap) ElementType() reflect.Type

func (ApplicationMap) ToApplicationMapOutput 

func (i ApplicationMap) ToApplicationMapOutput() ApplicationMapOutput

func (ApplicationMap) ToApplicationMapOutputWithContext 

func (i ApplicationMap) ToApplicationMapOutputWithContext(ctx context.Context) ApplicationMapOutput

type ApplicationMapInput 

type ApplicationMapInput interface {
	pulumi.Input

	ToApplicationMapOutput() ApplicationMapOutput
	ToApplicationMapOutputWithContext(context.Context) ApplicationMapOutput
}

ApplicationMapInput is an input type that accepts ApplicationMap and ApplicationMapOutput values. You can construct a concrete instance of `ApplicationMapInput` via: 

ApplicationMap{ "key": ApplicationArgs{...} }

type ApplicationMapOutput 

type ApplicationMapOutput struct{ *pulumi.OutputState }

func (ApplicationMapOutput) ElementType 

func (ApplicationMapOutput) ElementType() reflect.Type

func (ApplicationMapOutput) MapIndex 

func (o ApplicationMapOutput) MapIndex(k pulumi.StringInput) ApplicationOutput

func (ApplicationMapOutput) ToApplicationMapOutput 

func (o ApplicationMapOutput) ToApplicationMapOutput() ApplicationMapOutput

func (ApplicationMapOutput) ToApplicationMapOutputWithContext 

func (o ApplicationMapOutput) ToApplicationMapOutputWithContext(ctx context.Context) ApplicationMapOutput

type ApplicationOutput 

type ApplicationOutput struct{ *pulumi.OutputState }

func (ApplicationOutput) AppCodes 

func (o ApplicationOutput) AppCodes() pulumi.StringArrayOutput

Specifies an array of one or more application codes that the application has.\ Up to five application codes can be created. The valid length of each application code is limited from can contain `64` to `180`. The application code must start with a letter, digit, plus sign (+) or slash (/). Only letters, digits and following special special characters are allowed: `!@#$%+-_/=`.

func (ApplicationOutput) AppKey 

func (o ApplicationOutput) AppKey() pulumi.StringOutput

App key.

func (ApplicationOutput) AppSecret 

func (o ApplicationOutput) AppSecret() pulumi.StringOutput

App secret.

func (ApplicationOutput) Description 

func (o ApplicationOutput) Description() pulumi.StringOutput

Specifies the application description.\ The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.

func (ApplicationOutput) ElementType 

func (ApplicationOutput) ElementType() reflect.Type

func (ApplicationOutput) InstanceId 

func (o ApplicationOutput) InstanceId() pulumi.StringOutput

Specifies the ID of the dedicated instance to which the application belongs. Changing this will create a new resource.

func (ApplicationOutput) Name 

func (o ApplicationOutput) Name() pulumi.StringOutput

Specifies the application name.\ The valid length is limited from can contain `3` to `64`, only Chinese and English letters, digits and hyphens (-) are allowed. The name must start with a Chinese or English letter.

func (ApplicationOutput) Region 

func (o ApplicationOutput) Region() pulumi.StringOutput

Specifies the region where the application is located.\ If omitted, the provider-level region will be used. Changing this will create a new resource.

func (ApplicationOutput) RegistrationTime added in v0.0.8 

func (o ApplicationOutput) RegistrationTime() pulumi.StringOutput

the registration time.

func (ApplicationOutput) SecretAction 

func (o ApplicationOutput) SecretAction() pulumi.StringPtrOutput

Specifies the secret action to be done for the application.\ The valid action is **RESET**.

func (ApplicationOutput) ToApplicationOutput 

func (o ApplicationOutput) ToApplicationOutput() ApplicationOutput

func (ApplicationOutput) ToApplicationOutputWithContext 

func (o ApplicationOutput) ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput

func (ApplicationOutput) UpdatedAt added in v0.0.8 

func (o ApplicationOutput) UpdatedAt() pulumi.StringOutput

The latest update time of the application.

type ApplicationState 

type ApplicationState struct {
	// Specifies an array of one or more application codes that the application has.\
	// Up to five application codes can be created.
	// The valid length of each application code is limited from can contain `64` to `180`.
	// The application code must start with a letter, digit, plus sign (+) or slash (/).
	// Only letters, digits and following special special characters are allowed: `!@#$%+-_/=`.
	AppCodes pulumi.StringArrayInput
	// App key.
	AppKey pulumi.StringPtrInput
	// App secret.
	AppSecret pulumi.StringPtrInput
	// Specifies the application description.\
	// The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the application
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringPtrInput
	// Specifies the application name.\
	// The valid length is limited from can contain `3` to `64`, only Chinese and English letters, digits and hyphens (-)
	// are allowed.
	// The name must start with a Chinese or English letter.
	Name pulumi.StringPtrInput
	// Specifies the region where the application is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// the registration time.
	RegistrationTime pulumi.StringPtrInput
	// Specifies the secret action to be done for the application.\
	// The valid action is **RESET**.
	SecretAction pulumi.StringPtrInput
	// The latest update time of the application.
	UpdatedAt pulumi.StringPtrInput
}

func (ApplicationState) ElementType 

func (ApplicationState) ElementType() reflect.Type

type CustomAuthorizer 

type CustomAuthorizer struct {
	pulumi.CustomResourceState

	// Specifies the maximum cache age.
	CacheAge pulumi.IntPtrOutput `pulumi:"cacheAge"`
	// The creation time of the custom authorizer.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Specifies the uniform function URN of the function graph resource.
	FunctionUrn pulumi.StringOutput `pulumi:"functionUrn"`
	// Specifies an array of one or more parameter identities of the custom authorizer.
	// The object structure is documented below.
	Identities CustomAuthorizerIdentityArrayOutput `pulumi:"identities"`
	// Specifies an ID of the APIG dedicated instance to which the
	// custom authorizer belongs to.
	// Changing this will create a new custom authorizer resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies whether to send the body.
	IsBodySend pulumi.BoolPtrOutput `pulumi:"isBodySend"`
	// Specifies the name of the parameter to be verified.
	// The parameter includes front-end and back-end parameters.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the region in which to create the custom authorizer resource.
	// If omitted, the provider-level region will be used.
	// Changing this will create a new custom authorizer resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// Specifies the custom authoriz type.
	// The valid values are **FRONTEND** and **BACKEND**. Defaults to **FRONTEND**.
	// Changing this will create a new custom authorizer resource.
	Type pulumi.StringPtrOutput `pulumi:"type"`
	// Specifies the user data, which can contain a maximum of `2,048` characters.
	// The user data is used by APIG to invoke the specified authentication function when accessing the backend service.
	UserData pulumi.StringPtrOutput `pulumi:"userData"`
}

Manages an APIG custom authorizer resource within HuaweiCloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		authorizerName := cfg.RequireObject("authorizerName")
		functionUrn := cfg.RequireObject("functionUrn")
		_, err := DedicatedApig.NewCustomAuthorizer(ctx, "test", &DedicatedApig.CustomAuthorizerArgs{
			InstanceId:  pulumi.Any(instanceId),
			FunctionUrn: pulumi.Any(functionUrn),
			Type:        pulumi.String("FRONTEND"),
			CacheAge:    pulumi.Int(60),
			Identities: dedicatedapig.CustomAuthorizerIdentityArray{
				&dedicatedapig.CustomAuthorizerIdentityArgs{
					Name:     pulumi.String("user_name"),
					Location: pulumi.String("QUERY"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Custom Authorizers of the APIG can be imported using their `name` and related dedicated instance IDs, separated by a slash, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/customAuthorizer:CustomAuthorizer test <instance_id>/<name>

```

func GetCustomAuthorizer 

func GetCustomAuthorizer(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CustomAuthorizerState, opts ...pulumi.ResourceOption) (*CustomAuthorizer, error)

GetCustomAuthorizer gets an existing CustomAuthorizer 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 NewCustomAuthorizer 

func NewCustomAuthorizer(ctx *pulumi.Context,
	name string, args *CustomAuthorizerArgs, opts ...pulumi.ResourceOption) (*CustomAuthorizer, error)

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

func (*CustomAuthorizer) ElementType 

func (*CustomAuthorizer) ElementType() reflect.Type

func (*CustomAuthorizer) ToCustomAuthorizerOutput 

func (i *CustomAuthorizer) ToCustomAuthorizerOutput() CustomAuthorizerOutput

func (*CustomAuthorizer) ToCustomAuthorizerOutputWithContext 

func (i *CustomAuthorizer) ToCustomAuthorizerOutputWithContext(ctx context.Context) CustomAuthorizerOutput

type CustomAuthorizerArgs 

type CustomAuthorizerArgs struct {
	// Specifies the maximum cache age.
	CacheAge pulumi.IntPtrInput
	// Specifies the uniform function URN of the function graph resource.
	FunctionUrn pulumi.StringInput
	// Specifies an array of one or more parameter identities of the custom authorizer.
	// The object structure is documented below.
	Identities CustomAuthorizerIdentityArrayInput
	// Specifies an ID of the APIG dedicated instance to which the
	// custom authorizer belongs to.
	// Changing this will create a new custom authorizer resource.
	InstanceId pulumi.StringInput
	// Specifies whether to send the body.
	IsBodySend pulumi.BoolPtrInput
	// Specifies the name of the parameter to be verified.
	// The parameter includes front-end and back-end parameters.
	Name pulumi.StringPtrInput
	// Specifies the region in which to create the custom authorizer resource.
	// If omitted, the provider-level region will be used.
	// Changing this will create a new custom authorizer resource.
	Region pulumi.StringPtrInput
	// Specifies the custom authoriz type.
	// The valid values are **FRONTEND** and **BACKEND**. Defaults to **FRONTEND**.
	// Changing this will create a new custom authorizer resource.
	Type pulumi.StringPtrInput
	// Specifies the user data, which can contain a maximum of `2,048` characters.
	// The user data is used by APIG to invoke the specified authentication function when accessing the backend service.
	UserData pulumi.StringPtrInput
}

The set of arguments for constructing a CustomAuthorizer resource.

func (CustomAuthorizerArgs) ElementType 

func (CustomAuthorizerArgs) ElementType() reflect.Type

type CustomAuthorizerArray 

type CustomAuthorizerArray []CustomAuthorizerInput

func (CustomAuthorizerArray) ElementType 

func (CustomAuthorizerArray) ElementType() reflect.Type

func (CustomAuthorizerArray) ToCustomAuthorizerArrayOutput 

func (i CustomAuthorizerArray) ToCustomAuthorizerArrayOutput() CustomAuthorizerArrayOutput

func (CustomAuthorizerArray) ToCustomAuthorizerArrayOutputWithContext 

func (i CustomAuthorizerArray) ToCustomAuthorizerArrayOutputWithContext(ctx context.Context) CustomAuthorizerArrayOutput

type CustomAuthorizerArrayInput 

type CustomAuthorizerArrayInput interface {
	pulumi.Input

	ToCustomAuthorizerArrayOutput() CustomAuthorizerArrayOutput
	ToCustomAuthorizerArrayOutputWithContext(context.Context) CustomAuthorizerArrayOutput
}

CustomAuthorizerArrayInput is an input type that accepts CustomAuthorizerArray and CustomAuthorizerArrayOutput values. You can construct a concrete instance of `CustomAuthorizerArrayInput` via: 

CustomAuthorizerArray{ CustomAuthorizerArgs{...} }

type CustomAuthorizerArrayOutput 

type CustomAuthorizerArrayOutput struct{ *pulumi.OutputState }

func (CustomAuthorizerArrayOutput) ElementType 

func (CustomAuthorizerArrayOutput) ElementType() reflect.Type

func (CustomAuthorizerArrayOutput) Index 

func (o CustomAuthorizerArrayOutput) Index(i pulumi.IntInput) CustomAuthorizerOutput

func (CustomAuthorizerArrayOutput) ToCustomAuthorizerArrayOutput 

func (o CustomAuthorizerArrayOutput) ToCustomAuthorizerArrayOutput() CustomAuthorizerArrayOutput

func (CustomAuthorizerArrayOutput) ToCustomAuthorizerArrayOutputWithContext 

func (o CustomAuthorizerArrayOutput) ToCustomAuthorizerArrayOutputWithContext(ctx context.Context) CustomAuthorizerArrayOutput

type CustomAuthorizerIdentity 

type CustomAuthorizerIdentity struct {
	// Specifies the parameter location, which support **HEADER** and **QUERY**.
	Location string `pulumi:"location"`
	// Specifies the name of the parameter to be verified.
	// The parameter includes front-end and back-end parameters.
	Name string `pulumi:"name"`
	// Specifies the parameter verification expression.
	// If omitted, the custom authorizer will not perform verification.
	// The valid value is range form `1` to `2,048`.
	Validation *string `pulumi:"validation"`
}

type CustomAuthorizerIdentityArgs 

type CustomAuthorizerIdentityArgs struct {
	// Specifies the parameter location, which support **HEADER** and **QUERY**.
	Location pulumi.StringInput `pulumi:"location"`
	// Specifies the name of the parameter to be verified.
	// The parameter includes front-end and back-end parameters.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the parameter verification expression.
	// If omitted, the custom authorizer will not perform verification.
	// The valid value is range form `1` to `2,048`.
	Validation pulumi.StringPtrInput `pulumi:"validation"`
}

func (CustomAuthorizerIdentityArgs) ElementType 

func (CustomAuthorizerIdentityArgs) ElementType() reflect.Type

func (CustomAuthorizerIdentityArgs) ToCustomAuthorizerIdentityOutput 

func (i CustomAuthorizerIdentityArgs) ToCustomAuthorizerIdentityOutput() CustomAuthorizerIdentityOutput

func (CustomAuthorizerIdentityArgs) ToCustomAuthorizerIdentityOutputWithContext 

func (i CustomAuthorizerIdentityArgs) ToCustomAuthorizerIdentityOutputWithContext(ctx context.Context) CustomAuthorizerIdentityOutput

type CustomAuthorizerIdentityArray 

type CustomAuthorizerIdentityArray []CustomAuthorizerIdentityInput

func (CustomAuthorizerIdentityArray) ElementType 

func (CustomAuthorizerIdentityArray) ElementType() reflect.Type

func (CustomAuthorizerIdentityArray) ToCustomAuthorizerIdentityArrayOutput 

func (i CustomAuthorizerIdentityArray) ToCustomAuthorizerIdentityArrayOutput() CustomAuthorizerIdentityArrayOutput

func (CustomAuthorizerIdentityArray) ToCustomAuthorizerIdentityArrayOutputWithContext 

func (i CustomAuthorizerIdentityArray) ToCustomAuthorizerIdentityArrayOutputWithContext(ctx context.Context) CustomAuthorizerIdentityArrayOutput

type CustomAuthorizerIdentityArrayInput 

type CustomAuthorizerIdentityArrayInput interface {
	pulumi.Input

	ToCustomAuthorizerIdentityArrayOutput() CustomAuthorizerIdentityArrayOutput
	ToCustomAuthorizerIdentityArrayOutputWithContext(context.Context) CustomAuthorizerIdentityArrayOutput
}

CustomAuthorizerIdentityArrayInput is an input type that accepts CustomAuthorizerIdentityArray and CustomAuthorizerIdentityArrayOutput values. You can construct a concrete instance of `CustomAuthorizerIdentityArrayInput` via: 

CustomAuthorizerIdentityArray{ CustomAuthorizerIdentityArgs{...} }

type CustomAuthorizerIdentityArrayOutput 

type CustomAuthorizerIdentityArrayOutput struct{ *pulumi.OutputState }

func (CustomAuthorizerIdentityArrayOutput) ElementType 

func (CustomAuthorizerIdentityArrayOutput) ElementType() reflect.Type

func (CustomAuthorizerIdentityArrayOutput) Index 

func (o CustomAuthorizerIdentityArrayOutput) Index(i pulumi.IntInput) CustomAuthorizerIdentityOutput

func (CustomAuthorizerIdentityArrayOutput) ToCustomAuthorizerIdentityArrayOutput 

func (o CustomAuthorizerIdentityArrayOutput) ToCustomAuthorizerIdentityArrayOutput() CustomAuthorizerIdentityArrayOutput

func (CustomAuthorizerIdentityArrayOutput) ToCustomAuthorizerIdentityArrayOutputWithContext 

func (o CustomAuthorizerIdentityArrayOutput) ToCustomAuthorizerIdentityArrayOutputWithContext(ctx context.Context) CustomAuthorizerIdentityArrayOutput

type CustomAuthorizerIdentityInput 

type CustomAuthorizerIdentityInput interface {
	pulumi.Input

	ToCustomAuthorizerIdentityOutput() CustomAuthorizerIdentityOutput
	ToCustomAuthorizerIdentityOutputWithContext(context.Context) CustomAuthorizerIdentityOutput
}

CustomAuthorizerIdentityInput is an input type that accepts CustomAuthorizerIdentityArgs and CustomAuthorizerIdentityOutput values. You can construct a concrete instance of `CustomAuthorizerIdentityInput` via: 

CustomAuthorizerIdentityArgs{...}

type CustomAuthorizerIdentityOutput 

type CustomAuthorizerIdentityOutput struct{ *pulumi.OutputState }

func (CustomAuthorizerIdentityOutput) ElementType 

func (CustomAuthorizerIdentityOutput) ElementType() reflect.Type

func (CustomAuthorizerIdentityOutput) Location 

func (o CustomAuthorizerIdentityOutput) Location() pulumi.StringOutput

Specifies the parameter location, which support **HEADER** and **QUERY**.

func (CustomAuthorizerIdentityOutput) Name 

func (o CustomAuthorizerIdentityOutput) Name() pulumi.StringOutput

Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.

func (CustomAuthorizerIdentityOutput) ToCustomAuthorizerIdentityOutput 

func (o CustomAuthorizerIdentityOutput) ToCustomAuthorizerIdentityOutput() CustomAuthorizerIdentityOutput

func (CustomAuthorizerIdentityOutput) ToCustomAuthorizerIdentityOutputWithContext 

func (o CustomAuthorizerIdentityOutput) ToCustomAuthorizerIdentityOutputWithContext(ctx context.Context) CustomAuthorizerIdentityOutput

func (CustomAuthorizerIdentityOutput) Validation 

func (o CustomAuthorizerIdentityOutput) Validation() pulumi.StringPtrOutput

Specifies the parameter verification expression. If omitted, the custom authorizer will not perform verification. The valid value is range form `1` to `2,048`.

type CustomAuthorizerInput 

type CustomAuthorizerInput interface {
	pulumi.Input

	ToCustomAuthorizerOutput() CustomAuthorizerOutput
	ToCustomAuthorizerOutputWithContext(ctx context.Context) CustomAuthorizerOutput
}

type CustomAuthorizerMap 

type CustomAuthorizerMap map[string]CustomAuthorizerInput

func (CustomAuthorizerMap) ElementType 

func (CustomAuthorizerMap) ElementType() reflect.Type

func (CustomAuthorizerMap) ToCustomAuthorizerMapOutput 

func (i CustomAuthorizerMap) ToCustomAuthorizerMapOutput() CustomAuthorizerMapOutput

func (CustomAuthorizerMap) ToCustomAuthorizerMapOutputWithContext 

func (i CustomAuthorizerMap) ToCustomAuthorizerMapOutputWithContext(ctx context.Context) CustomAuthorizerMapOutput

type CustomAuthorizerMapInput 

type CustomAuthorizerMapInput interface {
	pulumi.Input

	ToCustomAuthorizerMapOutput() CustomAuthorizerMapOutput
	ToCustomAuthorizerMapOutputWithContext(context.Context) CustomAuthorizerMapOutput
}

CustomAuthorizerMapInput is an input type that accepts CustomAuthorizerMap and CustomAuthorizerMapOutput values. You can construct a concrete instance of `CustomAuthorizerMapInput` via: 

CustomAuthorizerMap{ "key": CustomAuthorizerArgs{...} }

type CustomAuthorizerMapOutput 

type CustomAuthorizerMapOutput struct{ *pulumi.OutputState }

func (CustomAuthorizerMapOutput) ElementType 

func (CustomAuthorizerMapOutput) ElementType() reflect.Type

func (CustomAuthorizerMapOutput) MapIndex 

func (o CustomAuthorizerMapOutput) MapIndex(k pulumi.StringInput) CustomAuthorizerOutput

func (CustomAuthorizerMapOutput) ToCustomAuthorizerMapOutput 

func (o CustomAuthorizerMapOutput) ToCustomAuthorizerMapOutput() CustomAuthorizerMapOutput

func (CustomAuthorizerMapOutput) ToCustomAuthorizerMapOutputWithContext 

func (o CustomAuthorizerMapOutput) ToCustomAuthorizerMapOutputWithContext(ctx context.Context) CustomAuthorizerMapOutput

type CustomAuthorizerOutput 

type CustomAuthorizerOutput struct{ *pulumi.OutputState }

func (CustomAuthorizerOutput) CacheAge 

func (o CustomAuthorizerOutput) CacheAge() pulumi.IntPtrOutput

Specifies the maximum cache age.

func (CustomAuthorizerOutput) CreatedAt added in v0.0.8 

func (o CustomAuthorizerOutput) CreatedAt() pulumi.StringOutput

The creation time of the custom authorizer.

func (CustomAuthorizerOutput) ElementType 

func (CustomAuthorizerOutput) ElementType() reflect.Type

func (CustomAuthorizerOutput) FunctionUrn 

func (o CustomAuthorizerOutput) FunctionUrn() pulumi.StringOutput

Specifies the uniform function URN of the function graph resource.

func (CustomAuthorizerOutput) Identities 

func (o CustomAuthorizerOutput) Identities() CustomAuthorizerIdentityArrayOutput

Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.

func (CustomAuthorizerOutput) InstanceId 

func (o CustomAuthorizerOutput) InstanceId() pulumi.StringOutput

Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.

func (CustomAuthorizerOutput) IsBodySend 

func (o CustomAuthorizerOutput) IsBodySend() pulumi.BoolPtrOutput

Specifies whether to send the body.

func (CustomAuthorizerOutput) Name 

func (o CustomAuthorizerOutput) Name() pulumi.StringOutput

Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.

func (CustomAuthorizerOutput) Region 

func (o CustomAuthorizerOutput) Region() pulumi.StringOutput

Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.

func (CustomAuthorizerOutput) ToCustomAuthorizerOutput 

func (o CustomAuthorizerOutput) ToCustomAuthorizerOutput() CustomAuthorizerOutput

func (CustomAuthorizerOutput) ToCustomAuthorizerOutputWithContext 

func (o CustomAuthorizerOutput) ToCustomAuthorizerOutputWithContext(ctx context.Context) CustomAuthorizerOutput

func (CustomAuthorizerOutput) Type 

func (o CustomAuthorizerOutput) Type() pulumi.StringPtrOutput

Specifies the custom authoriz type. The valid values are **FRONTEND** and **BACKEND**. Defaults to **FRONTEND**. Changing this will create a new custom authorizer resource.

func (CustomAuthorizerOutput) UserData 

func (o CustomAuthorizerOutput) UserData() pulumi.StringPtrOutput

Specifies the user data, which can contain a maximum of `2,048` characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

type CustomAuthorizerState 

type CustomAuthorizerState struct {
	// Specifies the maximum cache age.
	CacheAge pulumi.IntPtrInput
	// The creation time of the custom authorizer.
	CreatedAt pulumi.StringPtrInput
	// Specifies the uniform function URN of the function graph resource.
	FunctionUrn pulumi.StringPtrInput
	// Specifies an array of one or more parameter identities of the custom authorizer.
	// The object structure is documented below.
	Identities CustomAuthorizerIdentityArrayInput
	// Specifies an ID of the APIG dedicated instance to which the
	// custom authorizer belongs to.
	// Changing this will create a new custom authorizer resource.
	InstanceId pulumi.StringPtrInput
	// Specifies whether to send the body.
	IsBodySend pulumi.BoolPtrInput
	// Specifies the name of the parameter to be verified.
	// The parameter includes front-end and back-end parameters.
	Name pulumi.StringPtrInput
	// Specifies the region in which to create the custom authorizer resource.
	// If omitted, the provider-level region will be used.
	// Changing this will create a new custom authorizer resource.
	Region pulumi.StringPtrInput
	// Specifies the custom authoriz type.
	// The valid values are **FRONTEND** and **BACKEND**. Defaults to **FRONTEND**.
	// Changing this will create a new custom authorizer resource.
	Type pulumi.StringPtrInput
	// Specifies the user data, which can contain a maximum of `2,048` characters.
	// The user data is used by APIG to invoke the specified authentication function when accessing the backend service.
	UserData pulumi.StringPtrInput
}

func (CustomAuthorizerState) ElementType 

func (CustomAuthorizerState) ElementType() reflect.Type

type Environment 

type Environment struct {
	pulumi.CustomResourceState

	// schema: Deprecated; The time when the environment was created.
	//
	// Deprecated: Use 'created_at' instead
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// The time when the environment was created.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Specifies the environment description.\
	// The value can contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
	// Chinese characters must be in **UTF-8** or **Unicode** format.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies the ID of the dedicated instance to which the environment
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the environment name.\
	// The valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.
	// The name must start with a letter.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the region where the dedicated instance is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
}

Manages an APIG environment resource within HuaweiCloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		environmentName := cfg.RequireObject("environmentName")
		description := cfg.RequireObject("description")
		_, err := DedicatedApig.NewEnvironment(ctx, "test", &DedicatedApig.EnvironmentArgs{
			InstanceId:  pulumi.Any(instanceId),
			Description: pulumi.Any(description),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Environments can be imported using their `name` and the ID of the related dedicated instance, separated by a slash, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/environment:Environment test &ltinstance_id&gt/&ltname&gt

```

func GetEnvironment 

func GetEnvironment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EnvironmentState, opts ...pulumi.ResourceOption) (*Environment, error)

GetEnvironment gets an existing Environment 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 NewEnvironment 

func NewEnvironment(ctx *pulumi.Context,
	name string, args *EnvironmentArgs, opts ...pulumi.ResourceOption) (*Environment, error)

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

func (*Environment) ElementType 

func (*Environment) ElementType() reflect.Type

func (*Environment) ToEnvironmentOutput 

func (i *Environment) ToEnvironmentOutput() EnvironmentOutput

func (*Environment) ToEnvironmentOutputWithContext 

func (i *Environment) ToEnvironmentOutputWithContext(ctx context.Context) EnvironmentOutput

type EnvironmentArgs 

type EnvironmentArgs struct {
	// Specifies the environment description.\
	// The value can contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
	// Chinese characters must be in **UTF-8** or **Unicode** format.
	Description pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the environment
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringInput
	// Specifies the environment name.\
	// The valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.
	// The name must start with a letter.
	Name pulumi.StringPtrInput
	// Specifies the region where the dedicated instance is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
}

The set of arguments for constructing a Environment resource.

func (EnvironmentArgs) ElementType 

func (EnvironmentArgs) ElementType() reflect.Type

type EnvironmentArray 

type EnvironmentArray []EnvironmentInput

func (EnvironmentArray) ElementType 

func (EnvironmentArray) ElementType() reflect.Type

func (EnvironmentArray) ToEnvironmentArrayOutput 

func (i EnvironmentArray) ToEnvironmentArrayOutput() EnvironmentArrayOutput

func (EnvironmentArray) ToEnvironmentArrayOutputWithContext 

func (i EnvironmentArray) ToEnvironmentArrayOutputWithContext(ctx context.Context) EnvironmentArrayOutput

type EnvironmentArrayInput 

type EnvironmentArrayInput interface {
	pulumi.Input

	ToEnvironmentArrayOutput() EnvironmentArrayOutput
	ToEnvironmentArrayOutputWithContext(context.Context) EnvironmentArrayOutput
}

EnvironmentArrayInput is an input type that accepts EnvironmentArray and EnvironmentArrayOutput values. You can construct a concrete instance of `EnvironmentArrayInput` via: 

EnvironmentArray{ EnvironmentArgs{...} }

type EnvironmentArrayOutput 

type EnvironmentArrayOutput struct{ *pulumi.OutputState }

func (EnvironmentArrayOutput) ElementType 

func (EnvironmentArrayOutput) ElementType() reflect.Type

func (EnvironmentArrayOutput) Index 

func (o EnvironmentArrayOutput) Index(i pulumi.IntInput) EnvironmentOutput

func (EnvironmentArrayOutput) ToEnvironmentArrayOutput 

func (o EnvironmentArrayOutput) ToEnvironmentArrayOutput() EnvironmentArrayOutput

func (EnvironmentArrayOutput) ToEnvironmentArrayOutputWithContext 

func (o EnvironmentArrayOutput) ToEnvironmentArrayOutputWithContext(ctx context.Context) EnvironmentArrayOutput

type EnvironmentInput 

type EnvironmentInput interface {
	pulumi.Input

	ToEnvironmentOutput() EnvironmentOutput
	ToEnvironmentOutputWithContext(ctx context.Context) EnvironmentOutput
}

type EnvironmentMap 

type EnvironmentMap map[string]EnvironmentInput

func (EnvironmentMap) ElementType 

func (EnvironmentMap) ElementType() reflect.Type

func (EnvironmentMap) ToEnvironmentMapOutput 

func (i EnvironmentMap) ToEnvironmentMapOutput() EnvironmentMapOutput

func (EnvironmentMap) ToEnvironmentMapOutputWithContext 

func (i EnvironmentMap) ToEnvironmentMapOutputWithContext(ctx context.Context) EnvironmentMapOutput

type EnvironmentMapInput 

type EnvironmentMapInput interface {
	pulumi.Input

	ToEnvironmentMapOutput() EnvironmentMapOutput
	ToEnvironmentMapOutputWithContext(context.Context) EnvironmentMapOutput
}

EnvironmentMapInput is an input type that accepts EnvironmentMap and EnvironmentMapOutput values. You can construct a concrete instance of `EnvironmentMapInput` via: 

EnvironmentMap{ "key": EnvironmentArgs{...} }

type EnvironmentMapOutput 

type EnvironmentMapOutput struct{ *pulumi.OutputState }

func (EnvironmentMapOutput) ElementType 

func (EnvironmentMapOutput) ElementType() reflect.Type

func (EnvironmentMapOutput) MapIndex 

func (o EnvironmentMapOutput) MapIndex(k pulumi.StringInput) EnvironmentOutput

func (EnvironmentMapOutput) ToEnvironmentMapOutput 

func (o EnvironmentMapOutput) ToEnvironmentMapOutput() EnvironmentMapOutput

func (EnvironmentMapOutput) ToEnvironmentMapOutputWithContext 

func (o EnvironmentMapOutput) ToEnvironmentMapOutputWithContext(ctx context.Context) EnvironmentMapOutput

type EnvironmentOutput 

type EnvironmentOutput struct{ *pulumi.OutputState }

func (EnvironmentOutput) CreateTime deprecated 

func (o EnvironmentOutput) CreateTime() pulumi.StringOutput

schema: Deprecated; The time when the environment was created.

Deprecated: Use 'created_at' instead

func (EnvironmentOutput) CreatedAt added in v0.0.8 

func (o EnvironmentOutput) CreatedAt() pulumi.StringOutput

The time when the environment was created.

func (EnvironmentOutput) Description 

func (o EnvironmentOutput) Description() pulumi.StringPtrOutput

Specifies the environment description.\ The value can contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed. Chinese characters must be in **UTF-8** or **Unicode** format.

func (EnvironmentOutput) ElementType 

func (EnvironmentOutput) ElementType() reflect.Type

func (EnvironmentOutput) InstanceId 

func (o EnvironmentOutput) InstanceId() pulumi.StringOutput

Specifies the ID of the dedicated instance to which the environment belongs. Changing this will create a new resource.

func (EnvironmentOutput) Name 

func (o EnvironmentOutput) Name() pulumi.StringOutput

Specifies the environment name.\ The valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed. The name must start with a letter.

func (EnvironmentOutput) Region 

func (o EnvironmentOutput) Region() pulumi.StringOutput

Specifies the region where the dedicated instance is located.\ If omitted, the provider-level region will be used. Changing this will create a new resource.

func (EnvironmentOutput) ToEnvironmentOutput 

func (o EnvironmentOutput) ToEnvironmentOutput() EnvironmentOutput

func (EnvironmentOutput) ToEnvironmentOutputWithContext 

func (o EnvironmentOutput) ToEnvironmentOutputWithContext(ctx context.Context) EnvironmentOutput

type EnvironmentState 

type EnvironmentState struct {
	// schema: Deprecated; The time when the environment was created.
	//
	// Deprecated: Use 'created_at' instead
	CreateTime pulumi.StringPtrInput
	// The time when the environment was created.
	CreatedAt pulumi.StringPtrInput
	// Specifies the environment description.\
	// The value can contain a maximum of `255` characters, and the angle brackets (< and >) are not allowed.
	// Chinese characters must be in **UTF-8** or **Unicode** format.
	Description pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the environment
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringPtrInput
	// Specifies the environment name.\
	// The valid length is limited from `3` to `64`, only letters, digits and underscores (_) are allowed.
	// The name must start with a letter.
	Name pulumi.StringPtrInput
	// Specifies the region where the dedicated instance is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
}

func (EnvironmentState) ElementType 

func (EnvironmentState) ElementType() reflect.Type

type GetEnvironmentsArgs 

type GetEnvironmentsArgs struct {
	// Specifies an ID of the APIG dedicated instance to which the API
	// environment belongs.
	InstanceId string `pulumi:"instanceId"`
	// Specifies the name of the API environment. The API environment name consists of 3 to 64
	// characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
	Name *string `pulumi:"name"`
	// Specifies the region in which to query the APIG environment list.
	// If omitted, the provider-level region will be used.
	Region *string `pulumi:"region"`
}

A collection of arguments for invoking getEnvironments.

type GetEnvironmentsEnvironment 

type GetEnvironmentsEnvironment struct {
	// Time when the APIG environment was created, in RFC-3339 format.
	CreateTime string `pulumi:"createTime"`
	// The description about the API environment.
	Description string `pulumi:"description"`
	// ID of the APIG environment.
	Id string `pulumi:"id"`
	// Specifies the name of the API environment. The API environment name consists of 3 to 64
	// characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
	Name string `pulumi:"name"`
}

type GetEnvironmentsEnvironmentArgs 

type GetEnvironmentsEnvironmentArgs struct {
	// Time when the APIG environment was created, in RFC-3339 format.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The description about the API environment.
	Description pulumi.StringInput `pulumi:"description"`
	// ID of the APIG environment.
	Id pulumi.StringInput `pulumi:"id"`
	// Specifies the name of the API environment. The API environment name consists of 3 to 64
	// characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
	Name pulumi.StringInput `pulumi:"name"`
}

func (GetEnvironmentsEnvironmentArgs) ElementType 

func (GetEnvironmentsEnvironmentArgs) ElementType() reflect.Type

func (GetEnvironmentsEnvironmentArgs) ToGetEnvironmentsEnvironmentOutput 

func (i GetEnvironmentsEnvironmentArgs) ToGetEnvironmentsEnvironmentOutput() GetEnvironmentsEnvironmentOutput

func (GetEnvironmentsEnvironmentArgs) ToGetEnvironmentsEnvironmentOutputWithContext 

func (i GetEnvironmentsEnvironmentArgs) ToGetEnvironmentsEnvironmentOutputWithContext(ctx context.Context) GetEnvironmentsEnvironmentOutput

type GetEnvironmentsEnvironmentArray 

type GetEnvironmentsEnvironmentArray []GetEnvironmentsEnvironmentInput

func (GetEnvironmentsEnvironmentArray) ElementType 

func (GetEnvironmentsEnvironmentArray) ElementType() reflect.Type

func (GetEnvironmentsEnvironmentArray) ToGetEnvironmentsEnvironmentArrayOutput 

func (i GetEnvironmentsEnvironmentArray) ToGetEnvironmentsEnvironmentArrayOutput() GetEnvironmentsEnvironmentArrayOutput

func (GetEnvironmentsEnvironmentArray) ToGetEnvironmentsEnvironmentArrayOutputWithContext 

func (i GetEnvironmentsEnvironmentArray) ToGetEnvironmentsEnvironmentArrayOutputWithContext(ctx context.Context) GetEnvironmentsEnvironmentArrayOutput

type GetEnvironmentsEnvironmentArrayInput 

type GetEnvironmentsEnvironmentArrayInput interface {
	pulumi.Input

	ToGetEnvironmentsEnvironmentArrayOutput() GetEnvironmentsEnvironmentArrayOutput
	ToGetEnvironmentsEnvironmentArrayOutputWithContext(context.Context) GetEnvironmentsEnvironmentArrayOutput
}

GetEnvironmentsEnvironmentArrayInput is an input type that accepts GetEnvironmentsEnvironmentArray and GetEnvironmentsEnvironmentArrayOutput values. You can construct a concrete instance of `GetEnvironmentsEnvironmentArrayInput` via: 

GetEnvironmentsEnvironmentArray{ GetEnvironmentsEnvironmentArgs{...} }

type GetEnvironmentsEnvironmentArrayOutput 

type GetEnvironmentsEnvironmentArrayOutput struct{ *pulumi.OutputState }

func (GetEnvironmentsEnvironmentArrayOutput) ElementType 

func (GetEnvironmentsEnvironmentArrayOutput) ElementType() reflect.Type

func (GetEnvironmentsEnvironmentArrayOutput) Index 

func (o GetEnvironmentsEnvironmentArrayOutput) Index(i pulumi.IntInput) GetEnvironmentsEnvironmentOutput

func (GetEnvironmentsEnvironmentArrayOutput) ToGetEnvironmentsEnvironmentArrayOutput 

func (o GetEnvironmentsEnvironmentArrayOutput) ToGetEnvironmentsEnvironmentArrayOutput() GetEnvironmentsEnvironmentArrayOutput

func (GetEnvironmentsEnvironmentArrayOutput) ToGetEnvironmentsEnvironmentArrayOutputWithContext 

func (o GetEnvironmentsEnvironmentArrayOutput) ToGetEnvironmentsEnvironmentArrayOutputWithContext(ctx context.Context) GetEnvironmentsEnvironmentArrayOutput

type GetEnvironmentsEnvironmentInput 

type GetEnvironmentsEnvironmentInput interface {
	pulumi.Input

	ToGetEnvironmentsEnvironmentOutput() GetEnvironmentsEnvironmentOutput
	ToGetEnvironmentsEnvironmentOutputWithContext(context.Context) GetEnvironmentsEnvironmentOutput
}

GetEnvironmentsEnvironmentInput is an input type that accepts GetEnvironmentsEnvironmentArgs and GetEnvironmentsEnvironmentOutput values. You can construct a concrete instance of `GetEnvironmentsEnvironmentInput` via: 

GetEnvironmentsEnvironmentArgs{...}

type GetEnvironmentsEnvironmentOutput 

type GetEnvironmentsEnvironmentOutput struct{ *pulumi.OutputState }

func (GetEnvironmentsEnvironmentOutput) CreateTime 

func (o GetEnvironmentsEnvironmentOutput) CreateTime() pulumi.StringOutput

Time when the APIG environment was created, in RFC-3339 format.

func (GetEnvironmentsEnvironmentOutput) Description 

func (o GetEnvironmentsEnvironmentOutput) Description() pulumi.StringOutput

The description about the API environment.

func (GetEnvironmentsEnvironmentOutput) ElementType 

func (GetEnvironmentsEnvironmentOutput) ElementType() reflect.Type

func (GetEnvironmentsEnvironmentOutput) Id 

func (o GetEnvironmentsEnvironmentOutput) Id() pulumi.StringOutput

ID of the APIG environment.

func (GetEnvironmentsEnvironmentOutput) Name 

func (o GetEnvironmentsEnvironmentOutput) Name() pulumi.StringOutput

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

func (GetEnvironmentsEnvironmentOutput) ToGetEnvironmentsEnvironmentOutput 

func (o GetEnvironmentsEnvironmentOutput) ToGetEnvironmentsEnvironmentOutput() GetEnvironmentsEnvironmentOutput

func (GetEnvironmentsEnvironmentOutput) ToGetEnvironmentsEnvironmentOutputWithContext 

func (o GetEnvironmentsEnvironmentOutput) ToGetEnvironmentsEnvironmentOutputWithContext(ctx context.Context) GetEnvironmentsEnvironmentOutput

type GetEnvironmentsOutputArgs 

type GetEnvironmentsOutputArgs struct {
	// Specifies an ID of the APIG dedicated instance to which the API
	// environment belongs.
	InstanceId pulumi.StringInput `pulumi:"instanceId"`
	// Specifies the name of the API environment. The API environment name consists of 3 to 64
	// characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Specifies the region in which to query the APIG environment list.
	// If omitted, the provider-level region will be used.
	Region pulumi.StringPtrInput `pulumi:"region"`
}

A collection of arguments for invoking getEnvironments.

func (GetEnvironmentsOutputArgs) ElementType 

func (GetEnvironmentsOutputArgs) ElementType() reflect.Type

type GetEnvironmentsResult 

type GetEnvironmentsResult struct {
	// List of APIG environment details. The structure is documented below.
	Environments []GetEnvironmentsEnvironment `pulumi:"environments"`
	// The provider-assigned unique ID for this managed resource.
	Id         string `pulumi:"id"`
	InstanceId string `pulumi:"instanceId"`
	// The environment name.
	Name   *string `pulumi:"name"`
	Region *string `pulumi:"region"`
}

A collection of values returned by getEnvironments.

func GetEnvironments 

func GetEnvironments(ctx *pulumi.Context, args *GetEnvironmentsArgs, opts ...pulumi.InvokeOption) (*GetEnvironmentsResult, error)

Use this data source to query the environment list under the APIG instance within Huaweicloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		environmentName := cfg.RequireObject("environmentName")
		_, err := DedicatedApig.GetEnvironments(ctx, &dedicatedapig.GetEnvironmentsArgs{
			InstanceId: instanceId,
			Name:       pulumi.StringRef(environmentName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetEnvironmentsResultOutput 

type GetEnvironmentsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getEnvironments.

func GetEnvironmentsOutput 

func GetEnvironmentsOutput(ctx *pulumi.Context, args GetEnvironmentsOutputArgs, opts ...pulumi.InvokeOption) GetEnvironmentsResultOutput

func (GetEnvironmentsResultOutput) ElementType 

func (GetEnvironmentsResultOutput) ElementType() reflect.Type

func (GetEnvironmentsResultOutput) Environments 

func (o GetEnvironmentsResultOutput) Environments() GetEnvironmentsEnvironmentArrayOutput

List of APIG environment details. The structure is documented below.

func (GetEnvironmentsResultOutput) Id 

func (o GetEnvironmentsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetEnvironmentsResultOutput) InstanceId 

func (o GetEnvironmentsResultOutput) InstanceId() pulumi.StringOutput

func (GetEnvironmentsResultOutput) Name 

func (o GetEnvironmentsResultOutput) Name() pulumi.StringPtrOutput

The environment name.

func (GetEnvironmentsResultOutput) Region 

func (o GetEnvironmentsResultOutput) Region() pulumi.StringPtrOutput

func (GetEnvironmentsResultOutput) ToGetEnvironmentsResultOutput 

func (o GetEnvironmentsResultOutput) ToGetEnvironmentsResultOutput() GetEnvironmentsResultOutput

func (GetEnvironmentsResultOutput) ToGetEnvironmentsResultOutputWithContext 

func (o GetEnvironmentsResultOutput) ToGetEnvironmentsResultOutputWithContext(ctx context.Context) GetEnvironmentsResultOutput

type Group 

type Group struct {
	pulumi.CustomResourceState

	// Specifies the group description.\
	// The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
	// Chinese characters must be in **UTF-8** or **Unicode** format.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies an array of one or more environments of the associated group.\
	// The object structure is documented below.
	Environments GroupEnvironmentArrayOutput `pulumi:"environments"`
	// Specifies the ID of the dedicated instance to which the group belongs.\
	// Changing this will create a new resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the variable name.\
	// The valid length is limited from `3` to `32` characters.
	// Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter.
	// In the definition of an API, `name` (case-sensitive) indicates a variable, such as #Name#.
	// It is replaced by the actual value when the API is published in an environment.
	// The variable names are not allowed to be repeated for an API group.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the region where the APIG (API) group is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// The registration time, in RFC-3339 format.
	RegistrationTime pulumi.StringOutput `pulumi:"registrationTime"`
	// schema: Deprecated; The latest update time of the group.
	//
	// Deprecated: Use 'updated_at' instead
	UpdateTime pulumi.StringOutput `pulumi:"updateTime"`
	// The time when the API group was last modified, in RFC-3339 format.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
}

Manages an APIG (API) group resource within HuaweiCloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		groupName := cfg.RequireObject("groupName")
		description := cfg.RequireObject("description")
		environmentId := cfg.RequireObject("environmentId")
		_, err := DedicatedApig.NewGroup(ctx, "test", &DedicatedApig.GroupArgs{
			InstanceId:  pulumi.Any(instanceId),
			Description: pulumi.Any(description),
			Environments: dedicatedapig.GroupEnvironmentArray{
				&dedicatedapig.GroupEnvironmentArgs{
					Variables: dedicatedapig.GroupEnvironmentVariableArray{
						&dedicatedapig.GroupEnvironmentVariableArgs{
							Name:  pulumi.String("TERRAFORM"),
							Value: pulumi.String("/stage/terraform"),
						},
					},
					EnvironmentId: pulumi.Any(environmentId),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

API groups can be imported using their `id` and the ID of the related dedicated instance, separated by a slash, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/group:Group test <instance_id>/<id>

```

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 group description.\
	// The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
	// Chinese characters must be in **UTF-8** or **Unicode** format.
	Description pulumi.StringPtrInput
	// Specifies an array of one or more environments of the associated group.\
	// The object structure is documented below.
	Environments GroupEnvironmentArrayInput
	// Specifies the ID of the dedicated instance to which the group belongs.\
	// Changing this will create a new resource.
	InstanceId pulumi.StringInput
	// Specifies the variable name.\
	// The valid length is limited from `3` to `32` characters.
	// Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter.
	// In the definition of an API, `name` (case-sensitive) indicates a variable, such as #Name#.
	// It is replaced by the actual value when the API is published in an environment.
	// The variable names are not allowed to be repeated for an API group.
	Name pulumi.StringPtrInput
	// Specifies the region where the APIG (API) group is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new 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 GroupEnvironment 

type GroupEnvironment struct {
	// Specifies the environment ID of the associated group.
	EnvironmentId string `pulumi:"environmentId"`
	// Specifies an array of one or more environment variables.\
	// The object structure is documented below.
	Variables []GroupEnvironmentVariable `pulumi:"variables"`
}

type GroupEnvironmentArgs 

type GroupEnvironmentArgs struct {
	// Specifies the environment ID of the associated group.
	EnvironmentId pulumi.StringInput `pulumi:"environmentId"`
	// Specifies an array of one or more environment variables.\
	// The object structure is documented below.
	Variables GroupEnvironmentVariableArrayInput `pulumi:"variables"`
}

func (GroupEnvironmentArgs) ElementType 

func (GroupEnvironmentArgs) ElementType() reflect.Type

func (GroupEnvironmentArgs) ToGroupEnvironmentOutput 

func (i GroupEnvironmentArgs) ToGroupEnvironmentOutput() GroupEnvironmentOutput

func (GroupEnvironmentArgs) ToGroupEnvironmentOutputWithContext 

func (i GroupEnvironmentArgs) ToGroupEnvironmentOutputWithContext(ctx context.Context) GroupEnvironmentOutput

type GroupEnvironmentArray 

type GroupEnvironmentArray []GroupEnvironmentInput

func (GroupEnvironmentArray) ElementType 

func (GroupEnvironmentArray) ElementType() reflect.Type

func (GroupEnvironmentArray) ToGroupEnvironmentArrayOutput 

func (i GroupEnvironmentArray) ToGroupEnvironmentArrayOutput() GroupEnvironmentArrayOutput

func (GroupEnvironmentArray) ToGroupEnvironmentArrayOutputWithContext 

func (i GroupEnvironmentArray) ToGroupEnvironmentArrayOutputWithContext(ctx context.Context) GroupEnvironmentArrayOutput

type GroupEnvironmentArrayInput 

type GroupEnvironmentArrayInput interface {
	pulumi.Input

	ToGroupEnvironmentArrayOutput() GroupEnvironmentArrayOutput
	ToGroupEnvironmentArrayOutputWithContext(context.Context) GroupEnvironmentArrayOutput
}

GroupEnvironmentArrayInput is an input type that accepts GroupEnvironmentArray and GroupEnvironmentArrayOutput values. You can construct a concrete instance of `GroupEnvironmentArrayInput` via: 

GroupEnvironmentArray{ GroupEnvironmentArgs{...} }

type GroupEnvironmentArrayOutput 

type GroupEnvironmentArrayOutput struct{ *pulumi.OutputState }

func (GroupEnvironmentArrayOutput) ElementType 

func (GroupEnvironmentArrayOutput) ElementType() reflect.Type

func (GroupEnvironmentArrayOutput) Index 

func (o GroupEnvironmentArrayOutput) Index(i pulumi.IntInput) GroupEnvironmentOutput

func (GroupEnvironmentArrayOutput) ToGroupEnvironmentArrayOutput 

func (o GroupEnvironmentArrayOutput) ToGroupEnvironmentArrayOutput() GroupEnvironmentArrayOutput

func (GroupEnvironmentArrayOutput) ToGroupEnvironmentArrayOutputWithContext 

func (o GroupEnvironmentArrayOutput) ToGroupEnvironmentArrayOutputWithContext(ctx context.Context) GroupEnvironmentArrayOutput

type GroupEnvironmentInput 

type GroupEnvironmentInput interface {
	pulumi.Input

	ToGroupEnvironmentOutput() GroupEnvironmentOutput
	ToGroupEnvironmentOutputWithContext(context.Context) GroupEnvironmentOutput
}

GroupEnvironmentInput is an input type that accepts GroupEnvironmentArgs and GroupEnvironmentOutput values. You can construct a concrete instance of `GroupEnvironmentInput` via: 

GroupEnvironmentArgs{...}

type GroupEnvironmentOutput 

type GroupEnvironmentOutput struct{ *pulumi.OutputState }

func (GroupEnvironmentOutput) ElementType 

func (GroupEnvironmentOutput) ElementType() reflect.Type

func (GroupEnvironmentOutput) EnvironmentId 

func (o GroupEnvironmentOutput) EnvironmentId() pulumi.StringOutput

Specifies the environment ID of the associated group.

func (GroupEnvironmentOutput) ToGroupEnvironmentOutput 

func (o GroupEnvironmentOutput) ToGroupEnvironmentOutput() GroupEnvironmentOutput

func (GroupEnvironmentOutput) ToGroupEnvironmentOutputWithContext 

func (o GroupEnvironmentOutput) ToGroupEnvironmentOutputWithContext(ctx context.Context) GroupEnvironmentOutput

func (GroupEnvironmentOutput) Variables 

func (o GroupEnvironmentOutput) Variables() GroupEnvironmentVariableArrayOutput

Specifies an array of one or more environment variables.\ The object structure is documented below.

type GroupEnvironmentVariable 

type GroupEnvironmentVariable struct {
	// The variable ID.
	Id *string `pulumi:"id"`
	// Specifies the variable name.\
	// The valid length is limited from `3` to `32` characters.
	// Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter.
	// In the definition of an API, `name` (case-sensitive) indicates a variable, such as #Name#.
	// It is replaced by the actual value when the API is published in an environment.
	// The variable names are not allowed to be repeated for an API group.
	Name string `pulumi:"name"`
	// Specifies the variable value.\
	// The valid length is limited from `1` to `255` characters.
	// Only letters, digits and special characters (_-/.:) are allowed.
	Value string `pulumi:"value"`
	// Deprecated: Use 'id' instead
	VariableId *string `pulumi:"variableId"`
}

type GroupEnvironmentVariableArgs 

type GroupEnvironmentVariableArgs struct {
	// The variable ID.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Specifies the variable name.\
	// The valid length is limited from `3` to `32` characters.
	// Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter.
	// In the definition of an API, `name` (case-sensitive) indicates a variable, such as #Name#.
	// It is replaced by the actual value when the API is published in an environment.
	// The variable names are not allowed to be repeated for an API group.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the variable value.\
	// The valid length is limited from `1` to `255` characters.
	// Only letters, digits and special characters (_-/.:) are allowed.
	Value pulumi.StringInput `pulumi:"value"`
	// Deprecated: Use 'id' instead
	VariableId pulumi.StringPtrInput `pulumi:"variableId"`
}

func (GroupEnvironmentVariableArgs) ElementType 

func (GroupEnvironmentVariableArgs) ElementType() reflect.Type

func (GroupEnvironmentVariableArgs) ToGroupEnvironmentVariableOutput 

func (i GroupEnvironmentVariableArgs) ToGroupEnvironmentVariableOutput() GroupEnvironmentVariableOutput

func (GroupEnvironmentVariableArgs) ToGroupEnvironmentVariableOutputWithContext 

func (i GroupEnvironmentVariableArgs) ToGroupEnvironmentVariableOutputWithContext(ctx context.Context) GroupEnvironmentVariableOutput

type GroupEnvironmentVariableArray 

type GroupEnvironmentVariableArray []GroupEnvironmentVariableInput

func (GroupEnvironmentVariableArray) ElementType 

func (GroupEnvironmentVariableArray) ElementType() reflect.Type

func (GroupEnvironmentVariableArray) ToGroupEnvironmentVariableArrayOutput 

func (i GroupEnvironmentVariableArray) ToGroupEnvironmentVariableArrayOutput() GroupEnvironmentVariableArrayOutput

func (GroupEnvironmentVariableArray) ToGroupEnvironmentVariableArrayOutputWithContext 

func (i GroupEnvironmentVariableArray) ToGroupEnvironmentVariableArrayOutputWithContext(ctx context.Context) GroupEnvironmentVariableArrayOutput

type GroupEnvironmentVariableArrayInput 

type GroupEnvironmentVariableArrayInput interface {
	pulumi.Input

	ToGroupEnvironmentVariableArrayOutput() GroupEnvironmentVariableArrayOutput
	ToGroupEnvironmentVariableArrayOutputWithContext(context.Context) GroupEnvironmentVariableArrayOutput
}

GroupEnvironmentVariableArrayInput is an input type that accepts GroupEnvironmentVariableArray and GroupEnvironmentVariableArrayOutput values. You can construct a concrete instance of `GroupEnvironmentVariableArrayInput` via: 

GroupEnvironmentVariableArray{ GroupEnvironmentVariableArgs{...} }

type GroupEnvironmentVariableArrayOutput 

type GroupEnvironmentVariableArrayOutput struct{ *pulumi.OutputState }

func (GroupEnvironmentVariableArrayOutput) ElementType 

func (GroupEnvironmentVariableArrayOutput) ElementType() reflect.Type

func (GroupEnvironmentVariableArrayOutput) Index 

func (o GroupEnvironmentVariableArrayOutput) Index(i pulumi.IntInput) GroupEnvironmentVariableOutput

func (GroupEnvironmentVariableArrayOutput) ToGroupEnvironmentVariableArrayOutput 

func (o GroupEnvironmentVariableArrayOutput) ToGroupEnvironmentVariableArrayOutput() GroupEnvironmentVariableArrayOutput

func (GroupEnvironmentVariableArrayOutput) ToGroupEnvironmentVariableArrayOutputWithContext 

func (o GroupEnvironmentVariableArrayOutput) ToGroupEnvironmentVariableArrayOutputWithContext(ctx context.Context) GroupEnvironmentVariableArrayOutput

type GroupEnvironmentVariableInput 

type GroupEnvironmentVariableInput interface {
	pulumi.Input

	ToGroupEnvironmentVariableOutput() GroupEnvironmentVariableOutput
	ToGroupEnvironmentVariableOutputWithContext(context.Context) GroupEnvironmentVariableOutput
}

GroupEnvironmentVariableInput is an input type that accepts GroupEnvironmentVariableArgs and GroupEnvironmentVariableOutput values. You can construct a concrete instance of `GroupEnvironmentVariableInput` via: 

GroupEnvironmentVariableArgs{...}

type GroupEnvironmentVariableOutput 

type GroupEnvironmentVariableOutput struct{ *pulumi.OutputState }

func (GroupEnvironmentVariableOutput) ElementType 

func (GroupEnvironmentVariableOutput) ElementType() reflect.Type

func (GroupEnvironmentVariableOutput) Id added in v0.0.8 

func (o GroupEnvironmentVariableOutput) Id() pulumi.StringPtrOutput

The variable ID.

func (GroupEnvironmentVariableOutput) Name 

func (o GroupEnvironmentVariableOutput) Name() pulumi.StringOutput

Specifies the variable name.\ The valid length is limited from `3` to `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter. In the definition of an API, `name` (case-sensitive) indicates a variable, such as #Name#. It is replaced by the actual value when the API is published in an environment. The variable names are not allowed to be repeated for an API group.

func (GroupEnvironmentVariableOutput) ToGroupEnvironmentVariableOutput 

func (o GroupEnvironmentVariableOutput) ToGroupEnvironmentVariableOutput() GroupEnvironmentVariableOutput

func (GroupEnvironmentVariableOutput) ToGroupEnvironmentVariableOutputWithContext 

func (o GroupEnvironmentVariableOutput) ToGroupEnvironmentVariableOutputWithContext(ctx context.Context) GroupEnvironmentVariableOutput

func (GroupEnvironmentVariableOutput) Value 

func (o GroupEnvironmentVariableOutput) Value() pulumi.StringOutput

Specifies the variable value.\ The valid length is limited from `1` to `255` characters. Only letters, digits and special characters (_-/.:) are allowed.

func (GroupEnvironmentVariableOutput) VariableId deprecated 

func (o GroupEnvironmentVariableOutput) VariableId() pulumi.StringPtrOutput

Deprecated: Use 'id' instead

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 group description.\ The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in **UTF-8** or **Unicode** format.

func (GroupOutput) ElementType 

func (GroupOutput) ElementType() reflect.Type

func (GroupOutput) Environments 

func (o GroupOutput) Environments() GroupEnvironmentArrayOutput

Specifies an array of one or more environments of the associated group.\ The object structure is documented below.

func (GroupOutput) InstanceId 

func (o GroupOutput) InstanceId() pulumi.StringOutput

Specifies the ID of the dedicated instance to which the group belongs.\ Changing this will create a new resource.

func (GroupOutput) Name 

func (o GroupOutput) Name() pulumi.StringOutput

Specifies the variable name.\ The valid length is limited from `3` to `32` characters. Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter. In the definition of an API, `name` (case-sensitive) indicates a variable, such as #Name#. It is replaced by the actual value when the API is published in an environment. The variable names are not allowed to be repeated for an API group.

func (GroupOutput) Region 

func (o GroupOutput) Region() pulumi.StringOutput

Specifies the region where the APIG (API) group is located.\ If omitted, the provider-level region will be used. Changing this will create a new resource.

func (GroupOutput) RegistrationTime added in v0.0.8 

func (o GroupOutput) RegistrationTime() pulumi.StringOutput

The registration time, in RFC-3339 format.

func (GroupOutput) ToGroupOutput 

func (o GroupOutput) ToGroupOutput() GroupOutput

func (GroupOutput) ToGroupOutputWithContext 

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

func (GroupOutput) UpdateTime deprecated 

func (o GroupOutput) UpdateTime() pulumi.StringOutput

schema: Deprecated; The latest update time of the group.

Deprecated: Use 'updated_at' instead

func (GroupOutput) UpdatedAt added in v0.0.8 

func (o GroupOutput) UpdatedAt() pulumi.StringOutput

The time when the API group was last modified, in RFC-3339 format.

type GroupState 

type GroupState struct {
	// Specifies the group description.\
	// The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
	// Chinese characters must be in **UTF-8** or **Unicode** format.
	Description pulumi.StringPtrInput
	// Specifies an array of one or more environments of the associated group.\
	// The object structure is documented below.
	Environments GroupEnvironmentArrayInput
	// Specifies the ID of the dedicated instance to which the group belongs.\
	// Changing this will create a new resource.
	InstanceId pulumi.StringPtrInput
	// Specifies the variable name.\
	// The valid length is limited from `3` to `32` characters.
	// Only letters, digits, hyphens (-), and underscores (_) are allowed, and must start with a letter.
	// In the definition of an API, `name` (case-sensitive) indicates a variable, such as #Name#.
	// It is replaced by the actual value when the API is published in an environment.
	// The variable names are not allowed to be repeated for an API group.
	Name pulumi.StringPtrInput
	// Specifies the region where the APIG (API) group is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// The registration time, in RFC-3339 format.
	RegistrationTime pulumi.StringPtrInput
	// schema: Deprecated; The latest update time of the group.
	//
	// Deprecated: Use 'updated_at' instead
	UpdateTime pulumi.StringPtrInput
	// The time when the API group was last modified, in RFC-3339 format.
	UpdatedAt pulumi.StringPtrInput
}

func (GroupState) ElementType 

func (GroupState) ElementType() reflect.Type

type Instance 

type Instance struct {
	pulumi.CustomResourceState

	// Specifies the name list of availability zones for the dedicated
	// instance.
	// Please following [reference](https://developer.huaweicloud.com/intl/en-us/endpoint?APIG) for list elements.
	// Changing this will create a new resource.
	AvailabilityZones pulumi.StringArrayOutput `pulumi:"availabilityZones"`
	// schema: Deprecated; The name list of availability zones for the dedicated instance.
	AvailableZones pulumi.StringArrayOutput `pulumi:"availableZones"`
	// Specifies the egress bandwidth size of the dedicated instance.\
	// The valid value ranges from `0` to `2,000`.
	BandwidthSize pulumi.IntPtrOutput `pulumi:"bandwidthSize"`
	// schema: Deprecated; Time when the dedicated instance is created.
	//
	// Deprecated: Use 'created_at' instead
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// Time when the dedicated instance is created, in RFC-3339 format.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Specifies the description of the dedicated instance.\
	// The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies the edition of the dedicated instance.\
	// The valid values are as follows:
	// + **BASIC**: Basic Edition instance.
	// + **PROFESSIONAL**: Professional Edition instance.
	// + **ENTERPRISE**: Enterprise Edition instance.
	// + **PLATINUM**: Platinum Edition instance.
	// + **BASIC_IPV6**: IPv6 instance of the Basic Edition.
	// + **PROFESSIONAL_IPV6**: IPv6 instance of the Professional Edition.
	// + **ENTERPRISE_IPV6**: IPv6 instance of the Enterprise Edition.
	// + **PLATINUM_IPV6**: IPv6 instance of the Platinum Edition.
	Edition pulumi.StringOutput `pulumi:"edition"`
	// The egress (NAT) public IP address.
	EgressAddress pulumi.StringOutput `pulumi:"egressAddress"`
	// Specifies the EIP ID associated with the dedicated instance.
	EipId pulumi.StringOutput `pulumi:"eipId"`
	// Specifies the enterprise project ID to which the dedicated
	// instance belongs.
	// This parameter is required for enterprise users. Changing this will create a new resource.
	EnterpriseProjectId pulumi.StringOutput `pulumi:"enterpriseProjectId"`
	// The ingress EIP address.
	IngressAddress pulumi.StringOutput `pulumi:"ingressAddress"`
	// Specifies whether public access with an IPv6 address is supported.\
	// Changing this will create a new resource.
	Ipv6Enable pulumi.BoolOutput `pulumi:"ipv6Enable"`
	// Specifies the provider type of load balancer used by the
	// dedicated instance.
	// The valid values are as follows:
	// + **lvs**: Linux virtual server.
	// + **elb**: Elastic load balance.
	LoadbalancerProvider pulumi.StringOutput `pulumi:"loadbalancerProvider"`
	// Specifies the start time of the maintenance time window.\
	// The format is **xx:00:00**, the value of **xx** can be `02`, `06`, `10`, `14`, `18` or `22`.
	MaintainBegin pulumi.StringOutput `pulumi:"maintainBegin"`
	// End time of the maintenance time window, 4-hour difference between the start time and end time.
	MaintainEnd pulumi.StringOutput `pulumi:"maintainEnd"`
	// Specifies the name of the dedicated instance.\
	// The name can contain `3` to `64` characters, only letters, digits, hyphens (-) and underscores (_) are allowed, and
	// must start with a letter.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the region in which to create the dedicated instance resource.\
	// If omitted, the provider-level region will be used.
	// Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// Specifies the ID of the security group to which the dedicated instance
	// belongs to.
	SecurityGroupId pulumi.StringOutput `pulumi:"securityGroupId"`
	// Status of the dedicated instance.
	Status pulumi.StringOutput `pulumi:"status"`
	// Specifies the ID of the VPC subnet used to create the dedicated instance.\
	// Changing this will create a new resource.
	SubnetId pulumi.StringOutput `pulumi:"subnetId"`
	// The supported features of the APIG dedicated instance.
	SupportedFeatures pulumi.StringArrayOutput `pulumi:"supportedFeatures"`
	// Specifies the ID of the VPC used to create the dedicated instance.\
	// Changing this will create a new resource.
	VpcId pulumi.StringOutput `pulumi:"vpcId"`
	// The ingress private IP address of the VPC.
	VpcIngressAddress pulumi.StringOutput `pulumi:"vpcIngressAddress"`
}

Manages an APIG dedicated instance resource within HuaweiCloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud"
"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceName := cfg.RequireObject("instanceName")
		vpcId := cfg.RequireObject("vpcId")
		subnetId := cfg.RequireObject("subnetId")
		securityGroupId := cfg.RequireObject("securityGroupId")
		eipId := cfg.RequireObject("eipId")
		enterpriseProjectId := cfg.RequireObject("enterpriseProjectId")
		testAvailabilityZones, err := huaweicloud.GetAvailabilityZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = DedicatedApig.NewInstance(ctx, "testInstance", &DedicatedApig.InstanceArgs{
			Edition:             pulumi.String("BASIC"),
			VpcId:               pulumi.Any(vpcId),
			SubnetId:            pulumi.Any(subnetId),
			SecurityGroupId:     pulumi.Any(securityGroupId),
			EnterpriseProjectId: pulumi.Any(enterpriseProjectId),
			MaintainBegin:       pulumi.String("06:00:00"),
			Description:         pulumi.String("Created by script"),
			BandwidthSize:       pulumi.Int(3),
			EipId:               pulumi.Any(eipId),
			AvailableZones: pulumi.StringArray{
				pulumi.String(testAvailabilityZones.Names[0]),
				pulumi.String(testAvailabilityZones.Names[1]),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Dedicated instances can be imported by their `id`, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/instance:Instance test de379eed30aa4d31a84f426ea3c7ef4e

```

func GetInstance 

func GetInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *InstanceState, opts ...pulumi.ResourceOption) (*Instance, error)

GetInstance gets an existing Instance 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 NewInstance 

func NewInstance(ctx *pulumi.Context,
	name string, args *InstanceArgs, opts ...pulumi.ResourceOption) (*Instance, error)

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

func (*Instance) ElementType 

func (*Instance) ElementType() reflect.Type

func (*Instance) ToInstanceOutput 

func (i *Instance) ToInstanceOutput() InstanceOutput

func (*Instance) ToInstanceOutputWithContext 

func (i *Instance) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

type InstanceArgs 

type InstanceArgs struct {
	// Specifies the name list of availability zones for the dedicated
	// instance.
	// Please following [reference](https://developer.huaweicloud.com/intl/en-us/endpoint?APIG) for list elements.
	// Changing this will create a new resource.
	AvailabilityZones pulumi.StringArrayInput
	// schema: Deprecated; The name list of availability zones for the dedicated instance.
	AvailableZones pulumi.StringArrayInput
	// Specifies the egress bandwidth size of the dedicated instance.\
	// The valid value ranges from `0` to `2,000`.
	BandwidthSize pulumi.IntPtrInput
	// Specifies the description of the dedicated instance.\
	// The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput
	// Specifies the edition of the dedicated instance.\
	// The valid values are as follows:
	// + **BASIC**: Basic Edition instance.
	// + **PROFESSIONAL**: Professional Edition instance.
	// + **ENTERPRISE**: Enterprise Edition instance.
	// + **PLATINUM**: Platinum Edition instance.
	// + **BASIC_IPV6**: IPv6 instance of the Basic Edition.
	// + **PROFESSIONAL_IPV6**: IPv6 instance of the Professional Edition.
	// + **ENTERPRISE_IPV6**: IPv6 instance of the Enterprise Edition.
	// + **PLATINUM_IPV6**: IPv6 instance of the Platinum Edition.
	Edition pulumi.StringInput
	// Specifies the EIP ID associated with the dedicated instance.
	EipId pulumi.StringPtrInput
	// Specifies the enterprise project ID to which the dedicated
	// instance belongs.
	// This parameter is required for enterprise users. Changing this will create a new resource.
	EnterpriseProjectId pulumi.StringPtrInput
	// Specifies whether public access with an IPv6 address is supported.\
	// Changing this will create a new resource.
	Ipv6Enable pulumi.BoolPtrInput
	// Specifies the provider type of load balancer used by the
	// dedicated instance.
	// The valid values are as follows:
	// + **lvs**: Linux virtual server.
	// + **elb**: Elastic load balance.
	LoadbalancerProvider pulumi.StringPtrInput
	// Specifies the start time of the maintenance time window.\
	// The format is **xx:00:00**, the value of **xx** can be `02`, `06`, `10`, `14`, `18` or `22`.
	MaintainBegin pulumi.StringPtrInput
	// Specifies the name of the dedicated instance.\
	// The name can contain `3` to `64` characters, only letters, digits, hyphens (-) and underscores (_) are allowed, and
	// must start with a letter.
	Name pulumi.StringPtrInput
	// Specifies the region in which to create the dedicated instance resource.\
	// If omitted, the provider-level region will be used.
	// Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the ID of the security group to which the dedicated instance
	// belongs to.
	SecurityGroupId pulumi.StringInput
	// Specifies the ID of the VPC subnet used to create the dedicated instance.\
	// Changing this will create a new resource.
	SubnetId pulumi.StringInput
	// Specifies the ID of the VPC used to create the dedicated instance.\
	// Changing this will create a new resource.
	VpcId pulumi.StringInput
}

The set of arguments for constructing a Instance resource.

func (InstanceArgs) ElementType 

func (InstanceArgs) ElementType() reflect.Type

type InstanceArray 

type InstanceArray []InstanceInput

func (InstanceArray) ElementType 

func (InstanceArray) ElementType() reflect.Type

func (InstanceArray) ToInstanceArrayOutput 

func (i InstanceArray) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArray) ToInstanceArrayOutputWithContext 

func (i InstanceArray) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

type InstanceArrayInput 

type InstanceArrayInput interface {
	pulumi.Input

	ToInstanceArrayOutput() InstanceArrayOutput
	ToInstanceArrayOutputWithContext(context.Context) InstanceArrayOutput
}

InstanceArrayInput is an input type that accepts InstanceArray and InstanceArrayOutput values. You can construct a concrete instance of `InstanceArrayInput` via: 

InstanceArray{ InstanceArgs{...} }

type InstanceArrayOutput 

type InstanceArrayOutput struct{ *pulumi.OutputState }

func (InstanceArrayOutput) ElementType 

func (InstanceArrayOutput) ElementType() reflect.Type

func (InstanceArrayOutput) Index 

func (o InstanceArrayOutput) Index(i pulumi.IntInput) InstanceOutput

func (InstanceArrayOutput) ToInstanceArrayOutput 

func (o InstanceArrayOutput) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArrayOutput) ToInstanceArrayOutputWithContext 

func (o InstanceArrayOutput) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

type InstanceInput 

type InstanceInput interface {
	pulumi.Input

	ToInstanceOutput() InstanceOutput
	ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
}

type InstanceMap 

type InstanceMap map[string]InstanceInput

func (InstanceMap) ElementType 

func (InstanceMap) ElementType() reflect.Type

func (InstanceMap) ToInstanceMapOutput 

func (i InstanceMap) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMap) ToInstanceMapOutputWithContext 

func (i InstanceMap) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

type InstanceMapInput 

type InstanceMapInput interface {
	pulumi.Input

	ToInstanceMapOutput() InstanceMapOutput
	ToInstanceMapOutputWithContext(context.Context) InstanceMapOutput
}

InstanceMapInput is an input type that accepts InstanceMap and InstanceMapOutput values. You can construct a concrete instance of `InstanceMapInput` via: 

InstanceMap{ "key": InstanceArgs{...} }

type InstanceMapOutput 

type InstanceMapOutput struct{ *pulumi.OutputState }

func (InstanceMapOutput) ElementType 

func (InstanceMapOutput) ElementType() reflect.Type

func (InstanceMapOutput) MapIndex 

func (o InstanceMapOutput) MapIndex(k pulumi.StringInput) InstanceOutput

func (InstanceMapOutput) ToInstanceMapOutput 

func (o InstanceMapOutput) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMapOutput) ToInstanceMapOutputWithContext 

func (o InstanceMapOutput) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

type InstanceOutput 

type InstanceOutput struct{ *pulumi.OutputState }

func (InstanceOutput) AvailabilityZones added in v0.0.8 

func (o InstanceOutput) AvailabilityZones() pulumi.StringArrayOutput

Specifies the name list of availability zones for the dedicated instance. Please following [reference](https://developer.huaweicloud.com/intl/en-us/endpoint?APIG) for list elements. Changing this will create a new resource.

func (InstanceOutput) AvailableZones 

func (o InstanceOutput) AvailableZones() pulumi.StringArrayOutput

schema: Deprecated; The name list of availability zones for the dedicated instance.

func (InstanceOutput) BandwidthSize 

func (o InstanceOutput) BandwidthSize() pulumi.IntPtrOutput

Specifies the egress bandwidth size of the dedicated instance.\ The valid value ranges from `0` to `2,000`.

func (InstanceOutput) CreateTime deprecated 

func (o InstanceOutput) CreateTime() pulumi.StringOutput

schema: Deprecated; Time when the dedicated instance is created.

Deprecated: Use 'created_at' instead

func (InstanceOutput) CreatedAt added in v0.0.8 

func (o InstanceOutput) CreatedAt() pulumi.StringOutput

Time when the dedicated instance is created, in RFC-3339 format.

func (InstanceOutput) Description 

func (o InstanceOutput) Description() pulumi.StringPtrOutput

Specifies the description of the dedicated instance.\ The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (InstanceOutput) Edition 

func (o InstanceOutput) Edition() pulumi.StringOutput

Specifies the edition of the dedicated instance.\ The valid values are as follows: + **BASIC**: Basic Edition instance. + **PROFESSIONAL**: Professional Edition instance. + **ENTERPRISE**: Enterprise Edition instance. + **PLATINUM**: Platinum Edition instance. + **BASIC_IPV6**: IPv6 instance of the Basic Edition. + **PROFESSIONAL_IPV6**: IPv6 instance of the Professional Edition. + **ENTERPRISE_IPV6**: IPv6 instance of the Enterprise Edition. + **PLATINUM_IPV6**: IPv6 instance of the Platinum Edition.

func (InstanceOutput) EgressAddress 

func (o InstanceOutput) EgressAddress() pulumi.StringOutput

The egress (NAT) public IP address.

func (InstanceOutput) EipId 

func (o InstanceOutput) EipId() pulumi.StringOutput

Specifies the EIP ID associated with the dedicated instance.

func (InstanceOutput) ElementType 

func (InstanceOutput) ElementType() reflect.Type

func (InstanceOutput) EnterpriseProjectId 

func (o InstanceOutput) EnterpriseProjectId() pulumi.StringOutput

Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.

func (InstanceOutput) IngressAddress 

func (o InstanceOutput) IngressAddress() pulumi.StringOutput

The ingress EIP address.

func (InstanceOutput) Ipv6Enable added in v0.0.8 

func (o InstanceOutput) Ipv6Enable() pulumi.BoolOutput

Specifies whether public access with an IPv6 address is supported.\ Changing this will create a new resource.

func (InstanceOutput) LoadbalancerProvider added in v0.0.8 

func (o InstanceOutput) LoadbalancerProvider() pulumi.StringOutput

Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows: + **lvs**: Linux virtual server. + **elb**: Elastic load balance.

func (InstanceOutput) MaintainBegin 

func (o InstanceOutput) MaintainBegin() pulumi.StringOutput

Specifies the start time of the maintenance time window.\ The format is **xx:00:00**, the value of **xx** can be `02`, `06`, `10`, `14`, `18` or `22`.

func (InstanceOutput) MaintainEnd 

func (o InstanceOutput) MaintainEnd() pulumi.StringOutput

End time of the maintenance time window, 4-hour difference between the start time and end time.

func (InstanceOutput) Name 

func (o InstanceOutput) Name() pulumi.StringOutput

Specifies the name of the dedicated instance.\ The name can contain `3` to `64` characters, only letters, digits, hyphens (-) and underscores (_) are allowed, and must start with a letter.

func (InstanceOutput) Region 

func (o InstanceOutput) Region() pulumi.StringOutput

Specifies the region in which to create the dedicated instance resource.\ If omitted, the provider-level region will be used. Changing this will create a new resource.

func (InstanceOutput) SecurityGroupId 

func (o InstanceOutput) SecurityGroupId() pulumi.StringOutput

Specifies the ID of the security group to which the dedicated instance belongs to.

func (InstanceOutput) Status 

func (o InstanceOutput) Status() pulumi.StringOutput

Status of the dedicated instance.

func (InstanceOutput) SubnetId 

func (o InstanceOutput) SubnetId() pulumi.StringOutput

Specifies the ID of the VPC subnet used to create the dedicated instance.\ Changing this will create a new resource.

func (InstanceOutput) SupportedFeatures 

func (o InstanceOutput) SupportedFeatures() pulumi.StringArrayOutput

The supported features of the APIG dedicated instance.

func (InstanceOutput) ToInstanceOutput 

func (o InstanceOutput) ToInstanceOutput() InstanceOutput

func (InstanceOutput) ToInstanceOutputWithContext 

func (o InstanceOutput) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

func (InstanceOutput) VpcId 

func (o InstanceOutput) VpcId() pulumi.StringOutput

Specifies the ID of the VPC used to create the dedicated instance.\ Changing this will create a new resource.

func (InstanceOutput) VpcIngressAddress 

func (o InstanceOutput) VpcIngressAddress() pulumi.StringOutput

The ingress private IP address of the VPC.

type InstanceState 

type InstanceState struct {
	// Specifies the name list of availability zones for the dedicated
	// instance.
	// Please following [reference](https://developer.huaweicloud.com/intl/en-us/endpoint?APIG) for list elements.
	// Changing this will create a new resource.
	AvailabilityZones pulumi.StringArrayInput
	// schema: Deprecated; The name list of availability zones for the dedicated instance.
	AvailableZones pulumi.StringArrayInput
	// Specifies the egress bandwidth size of the dedicated instance.\
	// The valid value ranges from `0` to `2,000`.
	BandwidthSize pulumi.IntPtrInput
	// schema: Deprecated; Time when the dedicated instance is created.
	//
	// Deprecated: Use 'created_at' instead
	CreateTime pulumi.StringPtrInput
	// Time when the dedicated instance is created, in RFC-3339 format.
	CreatedAt pulumi.StringPtrInput
	// Specifies the description of the dedicated instance.\
	// The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput
	// Specifies the edition of the dedicated instance.\
	// The valid values are as follows:
	// + **BASIC**: Basic Edition instance.
	// + **PROFESSIONAL**: Professional Edition instance.
	// + **ENTERPRISE**: Enterprise Edition instance.
	// + **PLATINUM**: Platinum Edition instance.
	// + **BASIC_IPV6**: IPv6 instance of the Basic Edition.
	// + **PROFESSIONAL_IPV6**: IPv6 instance of the Professional Edition.
	// + **ENTERPRISE_IPV6**: IPv6 instance of the Enterprise Edition.
	// + **PLATINUM_IPV6**: IPv6 instance of the Platinum Edition.
	Edition pulumi.StringPtrInput
	// The egress (NAT) public IP address.
	EgressAddress pulumi.StringPtrInput
	// Specifies the EIP ID associated with the dedicated instance.
	EipId pulumi.StringPtrInput
	// Specifies the enterprise project ID to which the dedicated
	// instance belongs.
	// This parameter is required for enterprise users. Changing this will create a new resource.
	EnterpriseProjectId pulumi.StringPtrInput
	// The ingress EIP address.
	IngressAddress pulumi.StringPtrInput
	// Specifies whether public access with an IPv6 address is supported.\
	// Changing this will create a new resource.
	Ipv6Enable pulumi.BoolPtrInput
	// Specifies the provider type of load balancer used by the
	// dedicated instance.
	// The valid values are as follows:
	// + **lvs**: Linux virtual server.
	// + **elb**: Elastic load balance.
	LoadbalancerProvider pulumi.StringPtrInput
	// Specifies the start time of the maintenance time window.\
	// The format is **xx:00:00**, the value of **xx** can be `02`, `06`, `10`, `14`, `18` or `22`.
	MaintainBegin pulumi.StringPtrInput
	// End time of the maintenance time window, 4-hour difference between the start time and end time.
	MaintainEnd pulumi.StringPtrInput
	// Specifies the name of the dedicated instance.\
	// The name can contain `3` to `64` characters, only letters, digits, hyphens (-) and underscores (_) are allowed, and
	// must start with a letter.
	Name pulumi.StringPtrInput
	// Specifies the region in which to create the dedicated instance resource.\
	// If omitted, the provider-level region will be used.
	// Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the ID of the security group to which the dedicated instance
	// belongs to.
	SecurityGroupId pulumi.StringPtrInput
	// Status of the dedicated instance.
	Status pulumi.StringPtrInput
	// Specifies the ID of the VPC subnet used to create the dedicated instance.\
	// Changing this will create a new resource.
	SubnetId pulumi.StringPtrInput
	// The supported features of the APIG dedicated instance.
	SupportedFeatures pulumi.StringArrayInput
	// Specifies the ID of the VPC used to create the dedicated instance.\
	// Changing this will create a new resource.
	VpcId pulumi.StringPtrInput
	// The ingress private IP address of the VPC.
	VpcIngressAddress pulumi.StringPtrInput
}

func (InstanceState) ElementType 

func (InstanceState) ElementType() reflect.Type

type Response 

type Response struct {
	pulumi.CustomResourceState

	// The creation time of the API custom response.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Specifies the ID of the API group to which the API custom response
	// belongs.
	// Changing this will create a new resource.
	GroupId pulumi.StringOutput `pulumi:"groupId"`
	// Specifies the ID of the dedicated instance to which the API group and the
	// API custom response belong.
	// Changing this will create a new resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the name of the API custom response.\
	// The valid length is limited from `1` to `64`, letters, digits, hyphens (-) and underscores (_) are allowed.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the region where the API custom response is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// Specifies the API custom response rules definition.\
	// The object structure is documented below.
	Rules ResponseRuleArrayOutput `pulumi:"rules"`
	// The latest update time of the API custom response.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
}

Manages an APIG (API) custom response resource within HuaweiCloud.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		groupId := cfg.RequireObject("groupId")
		responseName := cfg.RequireObject("responseName")
		_, err := DedicatedApig.NewResponse(ctx, "test", &DedicatedApig.ResponseArgs{
			InstanceId: pulumi.Any(instanceId),
			GroupId:    pulumi.Any(groupId),
			Rules: dedicatedapig.ResponseRuleArray{
				&dedicatedapig.ResponseRuleArgs{
					ErrorType:  pulumi.String("AUTHORIZER_FAILURE"),
					Body:       pulumi.String(fmt.Sprintf("{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}")),
					StatusCode: pulumi.Int(401),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

API Responses can be imported using their `name` and IDs of the APIG dedicated instances and API groups to which the API response belongs, separated by slashes, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/response:Response test <instance_id>/<group_id>/<name>

```

func GetResponse 

func GetResponse(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResponseState, opts ...pulumi.ResourceOption) (*Response, error)

GetResponse gets an existing Response 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 NewResponse 

func NewResponse(ctx *pulumi.Context,
	name string, args *ResponseArgs, opts ...pulumi.ResourceOption) (*Response, error)

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

func (*Response) ElementType 

func (*Response) ElementType() reflect.Type

func (*Response) ToResponseOutput 

func (i *Response) ToResponseOutput() ResponseOutput

func (*Response) ToResponseOutputWithContext 

func (i *Response) ToResponseOutputWithContext(ctx context.Context) ResponseOutput

type ResponseArgs 

type ResponseArgs struct {
	// Specifies the ID of the API group to which the API custom response
	// belongs.
	// Changing this will create a new resource.
	GroupId pulumi.StringInput
	// Specifies the ID of the dedicated instance to which the API group and the
	// API custom response belong.
	// Changing this will create a new resource.
	InstanceId pulumi.StringInput
	// Specifies the name of the API custom response.\
	// The valid length is limited from `1` to `64`, letters, digits, hyphens (-) and underscores (_) are allowed.
	Name pulumi.StringPtrInput
	// Specifies the region where the API custom response is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the API custom response rules definition.\
	// The object structure is documented below.
	Rules ResponseRuleArrayInput
}

The set of arguments for constructing a Response resource.

func (ResponseArgs) ElementType 

func (ResponseArgs) ElementType() reflect.Type

type ResponseArray 

type ResponseArray []ResponseInput

func (ResponseArray) ElementType 

func (ResponseArray) ElementType() reflect.Type

func (ResponseArray) ToResponseArrayOutput 

func (i ResponseArray) ToResponseArrayOutput() ResponseArrayOutput

func (ResponseArray) ToResponseArrayOutputWithContext 

func (i ResponseArray) ToResponseArrayOutputWithContext(ctx context.Context) ResponseArrayOutput

type ResponseArrayInput 

type ResponseArrayInput interface {
	pulumi.Input

	ToResponseArrayOutput() ResponseArrayOutput
	ToResponseArrayOutputWithContext(context.Context) ResponseArrayOutput
}

ResponseArrayInput is an input type that accepts ResponseArray and ResponseArrayOutput values. You can construct a concrete instance of `ResponseArrayInput` via: 

ResponseArray{ ResponseArgs{...} }

type ResponseArrayOutput 

type ResponseArrayOutput struct{ *pulumi.OutputState }

func (ResponseArrayOutput) ElementType 

func (ResponseArrayOutput) ElementType() reflect.Type

func (ResponseArrayOutput) Index 

func (o ResponseArrayOutput) Index(i pulumi.IntInput) ResponseOutput

func (ResponseArrayOutput) ToResponseArrayOutput 

func (o ResponseArrayOutput) ToResponseArrayOutput() ResponseArrayOutput

func (ResponseArrayOutput) ToResponseArrayOutputWithContext 

func (o ResponseArrayOutput) ToResponseArrayOutputWithContext(ctx context.Context) ResponseArrayOutput

type ResponseInput 

type ResponseInput interface {
	pulumi.Input

	ToResponseOutput() ResponseOutput
	ToResponseOutputWithContext(ctx context.Context) ResponseOutput
}

type ResponseMap 

type ResponseMap map[string]ResponseInput

func (ResponseMap) ElementType 

func (ResponseMap) ElementType() reflect.Type

func (ResponseMap) ToResponseMapOutput 

func (i ResponseMap) ToResponseMapOutput() ResponseMapOutput

func (ResponseMap) ToResponseMapOutputWithContext 

func (i ResponseMap) ToResponseMapOutputWithContext(ctx context.Context) ResponseMapOutput

type ResponseMapInput 

type ResponseMapInput interface {
	pulumi.Input

	ToResponseMapOutput() ResponseMapOutput
	ToResponseMapOutputWithContext(context.Context) ResponseMapOutput
}

ResponseMapInput is an input type that accepts ResponseMap and ResponseMapOutput values. You can construct a concrete instance of `ResponseMapInput` via: 

ResponseMap{ "key": ResponseArgs{...} }

type ResponseMapOutput 

type ResponseMapOutput struct{ *pulumi.OutputState }

func (ResponseMapOutput) ElementType 

func (ResponseMapOutput) ElementType() reflect.Type

func (ResponseMapOutput) MapIndex 

func (o ResponseMapOutput) MapIndex(k pulumi.StringInput) ResponseOutput

func (ResponseMapOutput) ToResponseMapOutput 

func (o ResponseMapOutput) ToResponseMapOutput() ResponseMapOutput

func (ResponseMapOutput) ToResponseMapOutputWithContext 

func (o ResponseMapOutput) ToResponseMapOutputWithContext(ctx context.Context) ResponseMapOutput

type ResponseOutput 

type ResponseOutput struct{ *pulumi.OutputState }

func (ResponseOutput) CreatedAt added in v0.0.8 

func (o ResponseOutput) CreatedAt() pulumi.StringOutput

The creation time of the API custom response.

func (ResponseOutput) ElementType 

func (ResponseOutput) ElementType() reflect.Type

func (ResponseOutput) GroupId 

func (o ResponseOutput) GroupId() pulumi.StringOutput

Specifies the ID of the API group to which the API custom response belongs. Changing this will create a new resource.

func (ResponseOutput) InstanceId 

func (o ResponseOutput) InstanceId() pulumi.StringOutput

Specifies the ID of the dedicated instance to which the API group and the API custom response belong. Changing this will create a new resource.

func (ResponseOutput) Name 

func (o ResponseOutput) Name() pulumi.StringOutput

Specifies the name of the API custom response.\ The valid length is limited from `1` to `64`, letters, digits, hyphens (-) and underscores (_) are allowed.

func (ResponseOutput) Region 

func (o ResponseOutput) Region() pulumi.StringOutput

Specifies the region where the API custom response is located.\ If omitted, the provider-level region will be used. Changing this will create a new resource.

func (ResponseOutput) Rules 

func (o ResponseOutput) Rules() ResponseRuleArrayOutput

Specifies the API custom response rules definition.\ The object structure is documented below.

func (ResponseOutput) ToResponseOutput 

func (o ResponseOutput) ToResponseOutput() ResponseOutput

func (ResponseOutput) ToResponseOutputWithContext 

func (o ResponseOutput) ToResponseOutputWithContext(ctx context.Context) ResponseOutput

func (ResponseOutput) UpdatedAt added in v0.0.8 

func (o ResponseOutput) UpdatedAt() pulumi.StringOutput

The latest update time of the API custom response.

type ResponseRule 

type ResponseRule struct {
	// Specifies the body template of the API response rule, e.g.
	// `{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}`
	Body string `pulumi:"body"`
	// Specifies the error type of the API response rule.
	// + **AUTH_FAILURE**: Authentication failed.
	// + **AUTH_HEADER_MISSING**: The identity source is missing.
	// + **AUTHORIZER_FAILURE**: Custom authentication failed.
	// + **AUTHORIZER_CONF_FAILURE**: There has been a custom authorizer error.
	// + **AUTHORIZER_IDENTITIES_FAILURE**: The identity source of the custom authorizer is invalid.
	// + **BACKEND_UNAVAILABLE**: The backend service is unavailable.
	// + **BACKEND_TIMEOUT**: Communication with the backend service timed out.
	// + **THROTTLED**: The request was rejected due to request throttling.
	// + **UNAUTHORIZED**: The app you are using has not been authorized to call the API.
	// + **ACCESS_DENIED**: Access denied.
	// + **NOT_FOUND**: No API is found.
	// + **REQUEST_PARAMETERS_FAILURE**: The request parameters are incorrect.
	// + **DEFAULT_4XX**: Another 4XX error occurred.
	// + **DEFAULT_5XX**: Another 5XX error occurred.
	ErrorType string `pulumi:"errorType"`
	// Specifies the HTTP status code of the API response rule.
	StatusCode *int `pulumi:"statusCode"`
}

type ResponseRuleArgs 

type ResponseRuleArgs struct {
	// Specifies the body template of the API response rule, e.g.
	// `{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}`
	Body pulumi.StringInput `pulumi:"body"`
	// Specifies the error type of the API response rule.
	// + **AUTH_FAILURE**: Authentication failed.
	// + **AUTH_HEADER_MISSING**: The identity source is missing.
	// + **AUTHORIZER_FAILURE**: Custom authentication failed.
	// + **AUTHORIZER_CONF_FAILURE**: There has been a custom authorizer error.
	// + **AUTHORIZER_IDENTITIES_FAILURE**: The identity source of the custom authorizer is invalid.
	// + **BACKEND_UNAVAILABLE**: The backend service is unavailable.
	// + **BACKEND_TIMEOUT**: Communication with the backend service timed out.
	// + **THROTTLED**: The request was rejected due to request throttling.
	// + **UNAUTHORIZED**: The app you are using has not been authorized to call the API.
	// + **ACCESS_DENIED**: Access denied.
	// + **NOT_FOUND**: No API is found.
	// + **REQUEST_PARAMETERS_FAILURE**: The request parameters are incorrect.
	// + **DEFAULT_4XX**: Another 4XX error occurred.
	// + **DEFAULT_5XX**: Another 5XX error occurred.
	ErrorType pulumi.StringInput `pulumi:"errorType"`
	// Specifies the HTTP status code of the API response rule.
	StatusCode pulumi.IntPtrInput `pulumi:"statusCode"`
}

func (ResponseRuleArgs) ElementType 

func (ResponseRuleArgs) ElementType() reflect.Type

func (ResponseRuleArgs) ToResponseRuleOutput 

func (i ResponseRuleArgs) ToResponseRuleOutput() ResponseRuleOutput

func (ResponseRuleArgs) ToResponseRuleOutputWithContext 

func (i ResponseRuleArgs) ToResponseRuleOutputWithContext(ctx context.Context) ResponseRuleOutput

type ResponseRuleArray 

type ResponseRuleArray []ResponseRuleInput

func (ResponseRuleArray) ElementType 

func (ResponseRuleArray) ElementType() reflect.Type

func (ResponseRuleArray) ToResponseRuleArrayOutput 

func (i ResponseRuleArray) ToResponseRuleArrayOutput() ResponseRuleArrayOutput

func (ResponseRuleArray) ToResponseRuleArrayOutputWithContext 

func (i ResponseRuleArray) ToResponseRuleArrayOutputWithContext(ctx context.Context) ResponseRuleArrayOutput

type ResponseRuleArrayInput 

type ResponseRuleArrayInput interface {
	pulumi.Input

	ToResponseRuleArrayOutput() ResponseRuleArrayOutput
	ToResponseRuleArrayOutputWithContext(context.Context) ResponseRuleArrayOutput
}

ResponseRuleArrayInput is an input type that accepts ResponseRuleArray and ResponseRuleArrayOutput values. You can construct a concrete instance of `ResponseRuleArrayInput` via: 

ResponseRuleArray{ ResponseRuleArgs{...} }

type ResponseRuleArrayOutput 

type ResponseRuleArrayOutput struct{ *pulumi.OutputState }

func (ResponseRuleArrayOutput) ElementType 

func (ResponseRuleArrayOutput) ElementType() reflect.Type

func (ResponseRuleArrayOutput) Index 

func (o ResponseRuleArrayOutput) Index(i pulumi.IntInput) ResponseRuleOutput

func (ResponseRuleArrayOutput) ToResponseRuleArrayOutput 

func (o ResponseRuleArrayOutput) ToResponseRuleArrayOutput() ResponseRuleArrayOutput

func (ResponseRuleArrayOutput) ToResponseRuleArrayOutputWithContext 

func (o ResponseRuleArrayOutput) ToResponseRuleArrayOutputWithContext(ctx context.Context) ResponseRuleArrayOutput

type ResponseRuleInput 

type ResponseRuleInput interface {
	pulumi.Input

	ToResponseRuleOutput() ResponseRuleOutput
	ToResponseRuleOutputWithContext(context.Context) ResponseRuleOutput
}

ResponseRuleInput is an input type that accepts ResponseRuleArgs and ResponseRuleOutput values. You can construct a concrete instance of `ResponseRuleInput` via: 

ResponseRuleArgs{...}

type ResponseRuleOutput 

type ResponseRuleOutput struct{ *pulumi.OutputState }

func (ResponseRuleOutput) Body 

func (o ResponseRuleOutput) Body() pulumi.StringOutput

Specifies the body template of the API response rule, e.g. `{\"code\":\"$context.authorizer.frontend.code\",\"message\":\"$context.authorizer.frontend.message\"}`

func (ResponseRuleOutput) ElementType 

func (ResponseRuleOutput) ElementType() reflect.Type

func (ResponseRuleOutput) ErrorType 

func (o ResponseRuleOutput) ErrorType() pulumi.StringOutput

Specifies the error type of the API response rule. + **AUTH_FAILURE**: Authentication failed. + **AUTH_HEADER_MISSING**: The identity source is missing. + **AUTHORIZER_FAILURE**: Custom authentication failed. + **AUTHORIZER_CONF_FAILURE**: There has been a custom authorizer error. + **AUTHORIZER_IDENTITIES_FAILURE**: The identity source of the custom authorizer is invalid. + **BACKEND_UNAVAILABLE**: The backend service is unavailable. + **BACKEND_TIMEOUT**: Communication with the backend service timed out. + **THROTTLED**: The request was rejected due to request throttling. + **UNAUTHORIZED**: The app you are using has not been authorized to call the API. + **ACCESS_DENIED**: Access denied. + **NOT_FOUND**: No API is found. + **REQUEST_PARAMETERS_FAILURE**: The request parameters are incorrect. + **DEFAULT_4XX**: Another 4XX error occurred. + **DEFAULT_5XX**: Another 5XX error occurred.

func (ResponseRuleOutput) StatusCode 

func (o ResponseRuleOutput) StatusCode() pulumi.IntPtrOutput

Specifies the HTTP status code of the API response rule.

func (ResponseRuleOutput) ToResponseRuleOutput 

func (o ResponseRuleOutput) ToResponseRuleOutput() ResponseRuleOutput

func (ResponseRuleOutput) ToResponseRuleOutputWithContext 

func (o ResponseRuleOutput) ToResponseRuleOutputWithContext(ctx context.Context) ResponseRuleOutput

type ResponseState 

type ResponseState struct {
	// The creation time of the API custom response.
	CreatedAt pulumi.StringPtrInput
	// Specifies the ID of the API group to which the API custom response
	// belongs.
	// Changing this will create a new resource.
	GroupId pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the API group and the
	// API custom response belong.
	// Changing this will create a new resource.
	InstanceId pulumi.StringPtrInput
	// Specifies the name of the API custom response.\
	// The valid length is limited from `1` to `64`, letters, digits, hyphens (-) and underscores (_) are allowed.
	Name pulumi.StringPtrInput
	// Specifies the region where the API custom response is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the API custom response rules definition.\
	// The object structure is documented below.
	Rules ResponseRuleArrayInput
	// The latest update time of the API custom response.
	UpdatedAt pulumi.StringPtrInput
}

func (ResponseState) ElementType 

func (ResponseState) ElementType() reflect.Type

type ThrottlingPolicy 

type ThrottlingPolicy struct {
	pulumi.CustomResourceState

	// Specifies the array of one or more special throttling policies for APP limit.
	// The object structure is documented below.
	AppThrottles ThrottlingPolicyAppThrottleArrayOutput `pulumi:"appThrottles"`
	// The creation time of the throttling policy.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Specifies the description about the API throttling policy.
	// The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies the ID of the dedicated instance to which the throttling
	// policy belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the maximum number of times an API can be accessed within a specified
	// period.
	MaxApiRequests pulumi.IntOutput `pulumi:"maxApiRequests"`
	// Specifies the maximum number of times the API can be accessed by an app within
	// the same period.
	// The value of this parameter must be less than or equal to the value of `maxUserRequests`.
	MaxAppRequests pulumi.IntPtrOutput `pulumi:"maxAppRequests"`
	// Specifies the maximum number of times the API can be accessed by an IP address
	// within the same period.
	// The value of this parameter must be less than or equal to the value of `maxApiRequests`.
	MaxIpRequests pulumi.IntPtrOutput `pulumi:"maxIpRequests"`
	// Specifies the maximum number of times the API can be accessed by a user within
	// the same period.
	// The value of this parameter must be less than or equal to the value of `maxApiRequests`.
	MaxUserRequests pulumi.IntPtrOutput `pulumi:"maxUserRequests"`
	// Specifies the name of the throttling policy.\
	// The valid length is limited from `3` to `64`, only Chinese and English letters, digits and underscores (_) are
	// allowed.
	// The name must start with a Chinese or English letter.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the period of time for limiting the number of API calls.
	// This parameter applies with each of the API call limits: `maxApiRequests`, `maxAppRequests`, `maxIpRequests`
	// and `maxUserRequests`.
	Period pulumi.IntOutput `pulumi:"period"`
	// Specifies the time unit for limiting the number of API calls.
	// The valid values are **SECOND**, **MINUTE**, **HOUR** and **DAY**, defaults to **MINUTE**.
	PeriodUnit pulumi.StringPtrOutput `pulumi:"periodUnit"`
	// Specifies the region where the throttling policy is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// Specifies the type of the request throttling policy.\
	// The valid values are as follows:
	// + **API-based**: limiting the maximum number of times a single API bound to the policy can be called within the
	//   specified period.
	// + **API-shared**: limiting the maximum number of times all APIs bound to the policy can be called within the specified
	//   period.
	Type pulumi.StringPtrOutput `pulumi:"type"`
	// Specifies the array of one or more special throttling policies for IAM user limit.
	// The object structure is documented below.
	UserThrottles ThrottlingPolicyUserThrottleArrayOutput `pulumi:"userThrottles"`
}

Manages an APIG (API) throttling policy resource within HuaweiCloud.

## Example Usage ### Create a basic throttling policy

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		policyName := cfg.RequireObject("policyName")
		description := cfg.RequireObject("description")
		_, err := DedicatedApig.NewThrottlingPolicy(ctx, "test", &DedicatedApig.ThrottlingPolicyArgs{
			InstanceId:      pulumi.Any(instanceId),
			Description:     pulumi.Any(description),
			Type:            pulumi.String("API-based"),
			Period:          pulumi.Int(10),
			PeriodUnit:      pulumi.String("MINUTE"),
			MaxApiRequests:  pulumi.Int(70),
			MaxUserRequests: pulumi.Int(45),
			MaxAppRequests:  pulumi.Int(45),
			MaxIpRequests:   pulumi.Int(45),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Create a throttling policy with a special throttle

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		policyName := cfg.RequireObject("policyName")
		applicationId := cfg.RequireObject("applicationId")
		_, err := DedicatedApig.NewThrottlingPolicy(ctx, "test", &DedicatedApig.ThrottlingPolicyArgs{
			InstanceId:     pulumi.Any(instanceId),
			Type:           pulumi.String("API-based"),
			Period:         pulumi.Int(10),
			PeriodUnit:     pulumi.String("MINUTE"),
			MaxApiRequests: pulumi.Int(70),
			AppThrottles: dedicatedapig.ThrottlingPolicyAppThrottleArray{
				&dedicatedapig.ThrottlingPolicyAppThrottleArgs{
					MaxApiRequests:     pulumi.Int(40),
					ThrottlingObjectId: pulumi.Any(applicationId),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

API Throttling Policies can be imported using their `name` and related dedicated instance ID, separated by a slash, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/throttlingPolicy:ThrottlingPolicy test <instance_id>/<name>

```

func GetThrottlingPolicy 

func GetThrottlingPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ThrottlingPolicyState, opts ...pulumi.ResourceOption) (*ThrottlingPolicy, error)

GetThrottlingPolicy gets an existing ThrottlingPolicy 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 NewThrottlingPolicy 

func NewThrottlingPolicy(ctx *pulumi.Context,
	name string, args *ThrottlingPolicyArgs, opts ...pulumi.ResourceOption) (*ThrottlingPolicy, error)

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

func (*ThrottlingPolicy) ElementType 

func (*ThrottlingPolicy) ElementType() reflect.Type

func (*ThrottlingPolicy) ToThrottlingPolicyOutput 

func (i *ThrottlingPolicy) ToThrottlingPolicyOutput() ThrottlingPolicyOutput

func (*ThrottlingPolicy) ToThrottlingPolicyOutputWithContext 

func (i *ThrottlingPolicy) ToThrottlingPolicyOutputWithContext(ctx context.Context) ThrottlingPolicyOutput

type ThrottlingPolicyAppThrottle 

type ThrottlingPolicyAppThrottle struct {
	// ID of the special user/application throttling policy.
	Id *string `pulumi:"id"`
	// Specifies the maximum number of times an API can be accessed within a specified
	// period.
	MaxApiRequests int `pulumi:"maxApiRequests"`
	// Specifies the object ID which the special throttling policy belongs.
	ThrottlingObjectId string `pulumi:"throttlingObjectId"`
	// The object name which the special user/application throttling policy belongs.
	ThrottlingObjectName *string `pulumi:"throttlingObjectName"`
}

type ThrottlingPolicyAppThrottleArgs 

type ThrottlingPolicyAppThrottleArgs struct {
	// ID of the special user/application throttling policy.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Specifies the maximum number of times an API can be accessed within a specified
	// period.
	MaxApiRequests pulumi.IntInput `pulumi:"maxApiRequests"`
	// Specifies the object ID which the special throttling policy belongs.
	ThrottlingObjectId pulumi.StringInput `pulumi:"throttlingObjectId"`
	// The object name which the special user/application throttling policy belongs.
	ThrottlingObjectName pulumi.StringPtrInput `pulumi:"throttlingObjectName"`
}

func (ThrottlingPolicyAppThrottleArgs) ElementType 

func (ThrottlingPolicyAppThrottleArgs) ElementType() reflect.Type

func (ThrottlingPolicyAppThrottleArgs) ToThrottlingPolicyAppThrottleOutput 

func (i ThrottlingPolicyAppThrottleArgs) ToThrottlingPolicyAppThrottleOutput() ThrottlingPolicyAppThrottleOutput

func (ThrottlingPolicyAppThrottleArgs) ToThrottlingPolicyAppThrottleOutputWithContext 

func (i ThrottlingPolicyAppThrottleArgs) ToThrottlingPolicyAppThrottleOutputWithContext(ctx context.Context) ThrottlingPolicyAppThrottleOutput

type ThrottlingPolicyAppThrottleArray 

type ThrottlingPolicyAppThrottleArray []ThrottlingPolicyAppThrottleInput

func (ThrottlingPolicyAppThrottleArray) ElementType 

func (ThrottlingPolicyAppThrottleArray) ElementType() reflect.Type

func (ThrottlingPolicyAppThrottleArray) ToThrottlingPolicyAppThrottleArrayOutput 

func (i ThrottlingPolicyAppThrottleArray) ToThrottlingPolicyAppThrottleArrayOutput() ThrottlingPolicyAppThrottleArrayOutput

func (ThrottlingPolicyAppThrottleArray) ToThrottlingPolicyAppThrottleArrayOutputWithContext 

func (i ThrottlingPolicyAppThrottleArray) ToThrottlingPolicyAppThrottleArrayOutputWithContext(ctx context.Context) ThrottlingPolicyAppThrottleArrayOutput

type ThrottlingPolicyAppThrottleArrayInput 

type ThrottlingPolicyAppThrottleArrayInput interface {
	pulumi.Input

	ToThrottlingPolicyAppThrottleArrayOutput() ThrottlingPolicyAppThrottleArrayOutput
	ToThrottlingPolicyAppThrottleArrayOutputWithContext(context.Context) ThrottlingPolicyAppThrottleArrayOutput
}

ThrottlingPolicyAppThrottleArrayInput is an input type that accepts ThrottlingPolicyAppThrottleArray and ThrottlingPolicyAppThrottleArrayOutput values. You can construct a concrete instance of `ThrottlingPolicyAppThrottleArrayInput` via: 

ThrottlingPolicyAppThrottleArray{ ThrottlingPolicyAppThrottleArgs{...} }

type ThrottlingPolicyAppThrottleArrayOutput 

type ThrottlingPolicyAppThrottleArrayOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyAppThrottleArrayOutput) ElementType 

func (ThrottlingPolicyAppThrottleArrayOutput) ElementType() reflect.Type

func (ThrottlingPolicyAppThrottleArrayOutput) Index 

func (o ThrottlingPolicyAppThrottleArrayOutput) Index(i pulumi.IntInput) ThrottlingPolicyAppThrottleOutput

func (ThrottlingPolicyAppThrottleArrayOutput) ToThrottlingPolicyAppThrottleArrayOutput 

func (o ThrottlingPolicyAppThrottleArrayOutput) ToThrottlingPolicyAppThrottleArrayOutput() ThrottlingPolicyAppThrottleArrayOutput

func (ThrottlingPolicyAppThrottleArrayOutput) ToThrottlingPolicyAppThrottleArrayOutputWithContext 

func (o ThrottlingPolicyAppThrottleArrayOutput) ToThrottlingPolicyAppThrottleArrayOutputWithContext(ctx context.Context) ThrottlingPolicyAppThrottleArrayOutput

type ThrottlingPolicyAppThrottleInput 

type ThrottlingPolicyAppThrottleInput interface {
	pulumi.Input

	ToThrottlingPolicyAppThrottleOutput() ThrottlingPolicyAppThrottleOutput
	ToThrottlingPolicyAppThrottleOutputWithContext(context.Context) ThrottlingPolicyAppThrottleOutput
}

ThrottlingPolicyAppThrottleInput is an input type that accepts ThrottlingPolicyAppThrottleArgs and ThrottlingPolicyAppThrottleOutput values. You can construct a concrete instance of `ThrottlingPolicyAppThrottleInput` via: 

ThrottlingPolicyAppThrottleArgs{...}

type ThrottlingPolicyAppThrottleOutput 

type ThrottlingPolicyAppThrottleOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyAppThrottleOutput) ElementType 

func (ThrottlingPolicyAppThrottleOutput) ElementType() reflect.Type

func (ThrottlingPolicyAppThrottleOutput) Id 

func (o ThrottlingPolicyAppThrottleOutput) Id() pulumi.StringPtrOutput

ID of the special user/application throttling policy.

func (ThrottlingPolicyAppThrottleOutput) MaxApiRequests 

func (o ThrottlingPolicyAppThrottleOutput) MaxApiRequests() pulumi.IntOutput

Specifies the maximum number of times an API can be accessed within a specified period.

func (ThrottlingPolicyAppThrottleOutput) ThrottlingObjectId 

func (o ThrottlingPolicyAppThrottleOutput) ThrottlingObjectId() pulumi.StringOutput

Specifies the object ID which the special throttling policy belongs.

func (ThrottlingPolicyAppThrottleOutput) ThrottlingObjectName 

func (o ThrottlingPolicyAppThrottleOutput) ThrottlingObjectName() pulumi.StringPtrOutput

The object name which the special user/application throttling policy belongs.

func (ThrottlingPolicyAppThrottleOutput) ToThrottlingPolicyAppThrottleOutput 

func (o ThrottlingPolicyAppThrottleOutput) ToThrottlingPolicyAppThrottleOutput() ThrottlingPolicyAppThrottleOutput

func (ThrottlingPolicyAppThrottleOutput) ToThrottlingPolicyAppThrottleOutputWithContext 

func (o ThrottlingPolicyAppThrottleOutput) ToThrottlingPolicyAppThrottleOutputWithContext(ctx context.Context) ThrottlingPolicyAppThrottleOutput

type ThrottlingPolicyArgs 

type ThrottlingPolicyArgs struct {
	// Specifies the array of one or more special throttling policies for APP limit.
	// The object structure is documented below.
	AppThrottles ThrottlingPolicyAppThrottleArrayInput
	// Specifies the description about the API throttling policy.
	// The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the throttling
	// policy belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringInput
	// Specifies the maximum number of times an API can be accessed within a specified
	// period.
	MaxApiRequests pulumi.IntInput
	// Specifies the maximum number of times the API can be accessed by an app within
	// the same period.
	// The value of this parameter must be less than or equal to the value of `maxUserRequests`.
	MaxAppRequests pulumi.IntPtrInput
	// Specifies the maximum number of times the API can be accessed by an IP address
	// within the same period.
	// The value of this parameter must be less than or equal to the value of `maxApiRequests`.
	MaxIpRequests pulumi.IntPtrInput
	// Specifies the maximum number of times the API can be accessed by a user within
	// the same period.
	// The value of this parameter must be less than or equal to the value of `maxApiRequests`.
	MaxUserRequests pulumi.IntPtrInput
	// Specifies the name of the throttling policy.\
	// The valid length is limited from `3` to `64`, only Chinese and English letters, digits and underscores (_) are
	// allowed.
	// The name must start with a Chinese or English letter.
	Name pulumi.StringPtrInput
	// Specifies the period of time for limiting the number of API calls.
	// This parameter applies with each of the API call limits: `maxApiRequests`, `maxAppRequests`, `maxIpRequests`
	// and `maxUserRequests`.
	Period pulumi.IntInput
	// Specifies the time unit for limiting the number of API calls.
	// The valid values are **SECOND**, **MINUTE**, **HOUR** and **DAY**, defaults to **MINUTE**.
	PeriodUnit pulumi.StringPtrInput
	// Specifies the region where the throttling policy is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the type of the request throttling policy.\
	// The valid values are as follows:
	// + **API-based**: limiting the maximum number of times a single API bound to the policy can be called within the
	//   specified period.
	// + **API-shared**: limiting the maximum number of times all APIs bound to the policy can be called within the specified
	//   period.
	Type pulumi.StringPtrInput
	// Specifies the array of one or more special throttling policies for IAM user limit.
	// The object structure is documented below.
	UserThrottles ThrottlingPolicyUserThrottleArrayInput
}

The set of arguments for constructing a ThrottlingPolicy resource.

func (ThrottlingPolicyArgs) ElementType 

func (ThrottlingPolicyArgs) ElementType() reflect.Type

type ThrottlingPolicyArray 

type ThrottlingPolicyArray []ThrottlingPolicyInput

func (ThrottlingPolicyArray) ElementType 

func (ThrottlingPolicyArray) ElementType() reflect.Type

func (ThrottlingPolicyArray) ToThrottlingPolicyArrayOutput 

func (i ThrottlingPolicyArray) ToThrottlingPolicyArrayOutput() ThrottlingPolicyArrayOutput

func (ThrottlingPolicyArray) ToThrottlingPolicyArrayOutputWithContext 

func (i ThrottlingPolicyArray) ToThrottlingPolicyArrayOutputWithContext(ctx context.Context) ThrottlingPolicyArrayOutput

type ThrottlingPolicyArrayInput 

type ThrottlingPolicyArrayInput interface {
	pulumi.Input

	ToThrottlingPolicyArrayOutput() ThrottlingPolicyArrayOutput
	ToThrottlingPolicyArrayOutputWithContext(context.Context) ThrottlingPolicyArrayOutput
}

ThrottlingPolicyArrayInput is an input type that accepts ThrottlingPolicyArray and ThrottlingPolicyArrayOutput values. You can construct a concrete instance of `ThrottlingPolicyArrayInput` via: 

ThrottlingPolicyArray{ ThrottlingPolicyArgs{...} }

type ThrottlingPolicyArrayOutput 

type ThrottlingPolicyArrayOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyArrayOutput) ElementType 

func (ThrottlingPolicyArrayOutput) ElementType() reflect.Type

func (ThrottlingPolicyArrayOutput) Index 

func (o ThrottlingPolicyArrayOutput) Index(i pulumi.IntInput) ThrottlingPolicyOutput

func (ThrottlingPolicyArrayOutput) ToThrottlingPolicyArrayOutput 

func (o ThrottlingPolicyArrayOutput) ToThrottlingPolicyArrayOutput() ThrottlingPolicyArrayOutput

func (ThrottlingPolicyArrayOutput) ToThrottlingPolicyArrayOutputWithContext 

func (o ThrottlingPolicyArrayOutput) ToThrottlingPolicyArrayOutputWithContext(ctx context.Context) ThrottlingPolicyArrayOutput

type ThrottlingPolicyAssociate 

type ThrottlingPolicyAssociate struct {
	pulumi.CustomResourceState

	// Specifies the ID of the dedicated instance to which the APIs and the
	// throttling policy belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the ID of the throttling policy.\
	// Changing this will create a new resource.
	PolicyId pulumi.StringOutput `pulumi:"policyId"`
	// Specifies the publish IDs corresponding to the APIs bound by the throttling policy.
	PublishIds pulumi.StringArrayOutput `pulumi:"publishIds"`
	// Specifies the region where the dedicated instance and the throttling policy
	// are located.
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
}

Use this resource to bind the APIs to the throttling policy within HuaweiCloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		policyId := cfg.RequireObject("policyId")
		apiPublishIds := cfg.Require("apiPublishIds")
		_, err := DedicatedApig.NewThrottlingPolicyAssociate(ctx, "test", &DedicatedApig.ThrottlingPolicyAssociateArgs{
			InstanceId: pulumi.Any(instanceId),
			PolicyId:   pulumi.Any(policyId),
			PublishIds: apiPublishIds,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Associate resources can be imported using their `policy_id` and the APIG dedicated instance ID to which the policy belongs, separated by a slash, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/throttlingPolicyAssociate:ThrottlingPolicyAssociate test <instance_id>/<policy_id>

```

func GetThrottlingPolicyAssociate 

func GetThrottlingPolicyAssociate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ThrottlingPolicyAssociateState, opts ...pulumi.ResourceOption) (*ThrottlingPolicyAssociate, error)

GetThrottlingPolicyAssociate gets an existing ThrottlingPolicyAssociate 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 NewThrottlingPolicyAssociate 

func NewThrottlingPolicyAssociate(ctx *pulumi.Context,
	name string, args *ThrottlingPolicyAssociateArgs, opts ...pulumi.ResourceOption) (*ThrottlingPolicyAssociate, error)

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

func (*ThrottlingPolicyAssociate) ElementType 

func (*ThrottlingPolicyAssociate) ElementType() reflect.Type

func (*ThrottlingPolicyAssociate) ToThrottlingPolicyAssociateOutput 

func (i *ThrottlingPolicyAssociate) ToThrottlingPolicyAssociateOutput() ThrottlingPolicyAssociateOutput

func (*ThrottlingPolicyAssociate) ToThrottlingPolicyAssociateOutputWithContext 

func (i *ThrottlingPolicyAssociate) ToThrottlingPolicyAssociateOutputWithContext(ctx context.Context) ThrottlingPolicyAssociateOutput

type ThrottlingPolicyAssociateArgs 

type ThrottlingPolicyAssociateArgs struct {
	// Specifies the ID of the dedicated instance to which the APIs and the
	// throttling policy belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringInput
	// Specifies the ID of the throttling policy.\
	// Changing this will create a new resource.
	PolicyId pulumi.StringInput
	// Specifies the publish IDs corresponding to the APIs bound by the throttling policy.
	PublishIds pulumi.StringArrayInput
	// Specifies the region where the dedicated instance and the throttling policy
	// are located.
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
}

The set of arguments for constructing a ThrottlingPolicyAssociate resource.

func (ThrottlingPolicyAssociateArgs) ElementType 

func (ThrottlingPolicyAssociateArgs) ElementType() reflect.Type

type ThrottlingPolicyAssociateArray 

type ThrottlingPolicyAssociateArray []ThrottlingPolicyAssociateInput

func (ThrottlingPolicyAssociateArray) ElementType 

func (ThrottlingPolicyAssociateArray) ElementType() reflect.Type

func (ThrottlingPolicyAssociateArray) ToThrottlingPolicyAssociateArrayOutput 

func (i ThrottlingPolicyAssociateArray) ToThrottlingPolicyAssociateArrayOutput() ThrottlingPolicyAssociateArrayOutput

func (ThrottlingPolicyAssociateArray) ToThrottlingPolicyAssociateArrayOutputWithContext 

func (i ThrottlingPolicyAssociateArray) ToThrottlingPolicyAssociateArrayOutputWithContext(ctx context.Context) ThrottlingPolicyAssociateArrayOutput

type ThrottlingPolicyAssociateArrayInput 

type ThrottlingPolicyAssociateArrayInput interface {
	pulumi.Input

	ToThrottlingPolicyAssociateArrayOutput() ThrottlingPolicyAssociateArrayOutput
	ToThrottlingPolicyAssociateArrayOutputWithContext(context.Context) ThrottlingPolicyAssociateArrayOutput
}

ThrottlingPolicyAssociateArrayInput is an input type that accepts ThrottlingPolicyAssociateArray and ThrottlingPolicyAssociateArrayOutput values. You can construct a concrete instance of `ThrottlingPolicyAssociateArrayInput` via: 

ThrottlingPolicyAssociateArray{ ThrottlingPolicyAssociateArgs{...} }

type ThrottlingPolicyAssociateArrayOutput 

type ThrottlingPolicyAssociateArrayOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyAssociateArrayOutput) ElementType 

func (ThrottlingPolicyAssociateArrayOutput) ElementType() reflect.Type

func (ThrottlingPolicyAssociateArrayOutput) Index 

func (o ThrottlingPolicyAssociateArrayOutput) Index(i pulumi.IntInput) ThrottlingPolicyAssociateOutput

func (ThrottlingPolicyAssociateArrayOutput) ToThrottlingPolicyAssociateArrayOutput 

func (o ThrottlingPolicyAssociateArrayOutput) ToThrottlingPolicyAssociateArrayOutput() ThrottlingPolicyAssociateArrayOutput

func (ThrottlingPolicyAssociateArrayOutput) ToThrottlingPolicyAssociateArrayOutputWithContext 

func (o ThrottlingPolicyAssociateArrayOutput) ToThrottlingPolicyAssociateArrayOutputWithContext(ctx context.Context) ThrottlingPolicyAssociateArrayOutput

type ThrottlingPolicyAssociateInput 

type ThrottlingPolicyAssociateInput interface {
	pulumi.Input

	ToThrottlingPolicyAssociateOutput() ThrottlingPolicyAssociateOutput
	ToThrottlingPolicyAssociateOutputWithContext(ctx context.Context) ThrottlingPolicyAssociateOutput
}

type ThrottlingPolicyAssociateMap 

type ThrottlingPolicyAssociateMap map[string]ThrottlingPolicyAssociateInput

func (ThrottlingPolicyAssociateMap) ElementType 

func (ThrottlingPolicyAssociateMap) ElementType() reflect.Type

func (ThrottlingPolicyAssociateMap) ToThrottlingPolicyAssociateMapOutput 

func (i ThrottlingPolicyAssociateMap) ToThrottlingPolicyAssociateMapOutput() ThrottlingPolicyAssociateMapOutput

func (ThrottlingPolicyAssociateMap) ToThrottlingPolicyAssociateMapOutputWithContext 

func (i ThrottlingPolicyAssociateMap) ToThrottlingPolicyAssociateMapOutputWithContext(ctx context.Context) ThrottlingPolicyAssociateMapOutput

type ThrottlingPolicyAssociateMapInput 

type ThrottlingPolicyAssociateMapInput interface {
	pulumi.Input

	ToThrottlingPolicyAssociateMapOutput() ThrottlingPolicyAssociateMapOutput
	ToThrottlingPolicyAssociateMapOutputWithContext(context.Context) ThrottlingPolicyAssociateMapOutput
}

ThrottlingPolicyAssociateMapInput is an input type that accepts ThrottlingPolicyAssociateMap and ThrottlingPolicyAssociateMapOutput values. You can construct a concrete instance of `ThrottlingPolicyAssociateMapInput` via: 

ThrottlingPolicyAssociateMap{ "key": ThrottlingPolicyAssociateArgs{...} }

type ThrottlingPolicyAssociateMapOutput 

type ThrottlingPolicyAssociateMapOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyAssociateMapOutput) ElementType 

func (ThrottlingPolicyAssociateMapOutput) ElementType() reflect.Type

func (ThrottlingPolicyAssociateMapOutput) MapIndex 

func (o ThrottlingPolicyAssociateMapOutput) MapIndex(k pulumi.StringInput) ThrottlingPolicyAssociateOutput

func (ThrottlingPolicyAssociateMapOutput) ToThrottlingPolicyAssociateMapOutput 

func (o ThrottlingPolicyAssociateMapOutput) ToThrottlingPolicyAssociateMapOutput() ThrottlingPolicyAssociateMapOutput

func (ThrottlingPolicyAssociateMapOutput) ToThrottlingPolicyAssociateMapOutputWithContext 

func (o ThrottlingPolicyAssociateMapOutput) ToThrottlingPolicyAssociateMapOutputWithContext(ctx context.Context) ThrottlingPolicyAssociateMapOutput

type ThrottlingPolicyAssociateOutput 

type ThrottlingPolicyAssociateOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyAssociateOutput) ElementType 

func (ThrottlingPolicyAssociateOutput) ElementType() reflect.Type

func (ThrottlingPolicyAssociateOutput) InstanceId 

func (o ThrottlingPolicyAssociateOutput) InstanceId() pulumi.StringOutput

Specifies the ID of the dedicated instance to which the APIs and the throttling policy belongs. Changing this will create a new resource.

func (ThrottlingPolicyAssociateOutput) PolicyId 

func (o ThrottlingPolicyAssociateOutput) PolicyId() pulumi.StringOutput

Specifies the ID of the throttling policy.\ Changing this will create a new resource.

func (ThrottlingPolicyAssociateOutput) PublishIds 

func (o ThrottlingPolicyAssociateOutput) PublishIds() pulumi.StringArrayOutput

Specifies the publish IDs corresponding to the APIs bound by the throttling policy.

func (ThrottlingPolicyAssociateOutput) Region 

func (o ThrottlingPolicyAssociateOutput) Region() pulumi.StringOutput

Specifies the region where the dedicated instance and the throttling policy are located. If omitted, the provider-level region will be used. Changing this will create a new resource.

func (ThrottlingPolicyAssociateOutput) ToThrottlingPolicyAssociateOutput 

func (o ThrottlingPolicyAssociateOutput) ToThrottlingPolicyAssociateOutput() ThrottlingPolicyAssociateOutput

func (ThrottlingPolicyAssociateOutput) ToThrottlingPolicyAssociateOutputWithContext 

func (o ThrottlingPolicyAssociateOutput) ToThrottlingPolicyAssociateOutputWithContext(ctx context.Context) ThrottlingPolicyAssociateOutput

type ThrottlingPolicyAssociateState 

type ThrottlingPolicyAssociateState struct {
	// Specifies the ID of the dedicated instance to which the APIs and the
	// throttling policy belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringPtrInput
	// Specifies the ID of the throttling policy.\
	// Changing this will create a new resource.
	PolicyId pulumi.StringPtrInput
	// Specifies the publish IDs corresponding to the APIs bound by the throttling policy.
	PublishIds pulumi.StringArrayInput
	// Specifies the region where the dedicated instance and the throttling policy
	// are located.
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
}

func (ThrottlingPolicyAssociateState) ElementType 

func (ThrottlingPolicyAssociateState) ElementType() reflect.Type

type ThrottlingPolicyInput 

type ThrottlingPolicyInput interface {
	pulumi.Input

	ToThrottlingPolicyOutput() ThrottlingPolicyOutput
	ToThrottlingPolicyOutputWithContext(ctx context.Context) ThrottlingPolicyOutput
}

type ThrottlingPolicyMap 

type ThrottlingPolicyMap map[string]ThrottlingPolicyInput

func (ThrottlingPolicyMap) ElementType 

func (ThrottlingPolicyMap) ElementType() reflect.Type

func (ThrottlingPolicyMap) ToThrottlingPolicyMapOutput 

func (i ThrottlingPolicyMap) ToThrottlingPolicyMapOutput() ThrottlingPolicyMapOutput

func (ThrottlingPolicyMap) ToThrottlingPolicyMapOutputWithContext 

func (i ThrottlingPolicyMap) ToThrottlingPolicyMapOutputWithContext(ctx context.Context) ThrottlingPolicyMapOutput

type ThrottlingPolicyMapInput 

type ThrottlingPolicyMapInput interface {
	pulumi.Input

	ToThrottlingPolicyMapOutput() ThrottlingPolicyMapOutput
	ToThrottlingPolicyMapOutputWithContext(context.Context) ThrottlingPolicyMapOutput
}

ThrottlingPolicyMapInput is an input type that accepts ThrottlingPolicyMap and ThrottlingPolicyMapOutput values. You can construct a concrete instance of `ThrottlingPolicyMapInput` via: 

ThrottlingPolicyMap{ "key": ThrottlingPolicyArgs{...} }

type ThrottlingPolicyMapOutput 

type ThrottlingPolicyMapOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyMapOutput) ElementType 

func (ThrottlingPolicyMapOutput) ElementType() reflect.Type

func (ThrottlingPolicyMapOutput) MapIndex 

func (o ThrottlingPolicyMapOutput) MapIndex(k pulumi.StringInput) ThrottlingPolicyOutput

func (ThrottlingPolicyMapOutput) ToThrottlingPolicyMapOutput 

func (o ThrottlingPolicyMapOutput) ToThrottlingPolicyMapOutput() ThrottlingPolicyMapOutput

func (ThrottlingPolicyMapOutput) ToThrottlingPolicyMapOutputWithContext 

func (o ThrottlingPolicyMapOutput) ToThrottlingPolicyMapOutputWithContext(ctx context.Context) ThrottlingPolicyMapOutput

type ThrottlingPolicyOutput 

type ThrottlingPolicyOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyOutput) AppThrottles 

func (o ThrottlingPolicyOutput) AppThrottles() ThrottlingPolicyAppThrottleArrayOutput

Specifies the array of one or more special throttling policies for APP limit. The object structure is documented below.

func (ThrottlingPolicyOutput) CreatedAt added in v0.0.8 

func (o ThrottlingPolicyOutput) CreatedAt() pulumi.StringOutput

The creation time of the throttling policy.

func (ThrottlingPolicyOutput) Description 

func (o ThrottlingPolicyOutput) Description() pulumi.StringPtrOutput

Specifies the description about the API throttling policy. The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.

func (ThrottlingPolicyOutput) ElementType 

func (ThrottlingPolicyOutput) ElementType() reflect.Type

func (ThrottlingPolicyOutput) InstanceId 

func (o ThrottlingPolicyOutput) InstanceId() pulumi.StringOutput

Specifies the ID of the dedicated instance to which the throttling policy belongs. Changing this will create a new resource.

func (ThrottlingPolicyOutput) MaxApiRequests 

func (o ThrottlingPolicyOutput) MaxApiRequests() pulumi.IntOutput

Specifies the maximum number of times an API can be accessed within a specified period.

func (ThrottlingPolicyOutput) MaxAppRequests 

func (o ThrottlingPolicyOutput) MaxAppRequests() pulumi.IntPtrOutput

Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of `maxUserRequests`.

func (ThrottlingPolicyOutput) MaxIpRequests 

func (o ThrottlingPolicyOutput) MaxIpRequests() pulumi.IntPtrOutput

Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of `maxApiRequests`.

func (ThrottlingPolicyOutput) MaxUserRequests 

func (o ThrottlingPolicyOutput) MaxUserRequests() pulumi.IntPtrOutput

Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of `maxApiRequests`.

func (ThrottlingPolicyOutput) Name 

func (o ThrottlingPolicyOutput) Name() pulumi.StringOutput

Specifies the name of the throttling policy.\ The valid length is limited from `3` to `64`, only Chinese and English letters, digits and underscores (_) are allowed. The name must start with a Chinese or English letter.

func (ThrottlingPolicyOutput) Period 

func (o ThrottlingPolicyOutput) Period() pulumi.IntOutput

Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: `maxApiRequests`, `maxAppRequests`, `maxIpRequests` and `maxUserRequests`.

func (ThrottlingPolicyOutput) PeriodUnit 

func (o ThrottlingPolicyOutput) PeriodUnit() pulumi.StringPtrOutput

Specifies the time unit for limiting the number of API calls. The valid values are **SECOND**, **MINUTE**, **HOUR** and **DAY**, defaults to **MINUTE**.

func (ThrottlingPolicyOutput) Region 

func (o ThrottlingPolicyOutput) Region() pulumi.StringOutput

Specifies the region where the throttling policy is located.\ If omitted, the provider-level region will be used. Changing this will create a new resource.

func (ThrottlingPolicyOutput) ToThrottlingPolicyOutput 

func (o ThrottlingPolicyOutput) ToThrottlingPolicyOutput() ThrottlingPolicyOutput

func (ThrottlingPolicyOutput) ToThrottlingPolicyOutputWithContext 

func (o ThrottlingPolicyOutput) ToThrottlingPolicyOutputWithContext(ctx context.Context) ThrottlingPolicyOutput

func (ThrottlingPolicyOutput) Type 

func (o ThrottlingPolicyOutput) Type() pulumi.StringPtrOutput

Specifies the type of the request throttling policy.\ The valid values are as follows:

  • **API-based**: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
  • **API-shared**: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

func (ThrottlingPolicyOutput) UserThrottles 

func (o ThrottlingPolicyOutput) UserThrottles() ThrottlingPolicyUserThrottleArrayOutput

Specifies the array of one or more special throttling policies for IAM user limit. The object structure is documented below.

type ThrottlingPolicyState 

type ThrottlingPolicyState struct {
	// Specifies the array of one or more special throttling policies for APP limit.
	// The object structure is documented below.
	AppThrottles ThrottlingPolicyAppThrottleArrayInput
	// The creation time of the throttling policy.
	CreatedAt pulumi.StringPtrInput
	// Specifies the description about the API throttling policy.
	// The description contain a maximum of `255` characters and the angle brackets (< and >) are not allowed.
	Description pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the throttling
	// policy belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringPtrInput
	// Specifies the maximum number of times an API can be accessed within a specified
	// period.
	MaxApiRequests pulumi.IntPtrInput
	// Specifies the maximum number of times the API can be accessed by an app within
	// the same period.
	// The value of this parameter must be less than or equal to the value of `maxUserRequests`.
	MaxAppRequests pulumi.IntPtrInput
	// Specifies the maximum number of times the API can be accessed by an IP address
	// within the same period.
	// The value of this parameter must be less than or equal to the value of `maxApiRequests`.
	MaxIpRequests pulumi.IntPtrInput
	// Specifies the maximum number of times the API can be accessed by a user within
	// the same period.
	// The value of this parameter must be less than or equal to the value of `maxApiRequests`.
	MaxUserRequests pulumi.IntPtrInput
	// Specifies the name of the throttling policy.\
	// The valid length is limited from `3` to `64`, only Chinese and English letters, digits and underscores (_) are
	// allowed.
	// The name must start with a Chinese or English letter.
	Name pulumi.StringPtrInput
	// Specifies the period of time for limiting the number of API calls.
	// This parameter applies with each of the API call limits: `maxApiRequests`, `maxAppRequests`, `maxIpRequests`
	// and `maxUserRequests`.
	Period pulumi.IntPtrInput
	// Specifies the time unit for limiting the number of API calls.
	// The valid values are **SECOND**, **MINUTE**, **HOUR** and **DAY**, defaults to **MINUTE**.
	PeriodUnit pulumi.StringPtrInput
	// Specifies the region where the throttling policy is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the type of the request throttling policy.\
	// The valid values are as follows:
	// + **API-based**: limiting the maximum number of times a single API bound to the policy can be called within the
	//   specified period.
	// + **API-shared**: limiting the maximum number of times all APIs bound to the policy can be called within the specified
	//   period.
	Type pulumi.StringPtrInput
	// Specifies the array of one or more special throttling policies for IAM user limit.
	// The object structure is documented below.
	UserThrottles ThrottlingPolicyUserThrottleArrayInput
}

func (ThrottlingPolicyState) ElementType 

func (ThrottlingPolicyState) ElementType() reflect.Type

type ThrottlingPolicyUserThrottle 

type ThrottlingPolicyUserThrottle struct {
	// ID of the special user/application throttling policy.
	Id *string `pulumi:"id"`
	// Specifies the maximum number of times an API can be accessed within a specified
	// period.
	MaxApiRequests int `pulumi:"maxApiRequests"`
	// Specifies the object ID which the special throttling policy belongs.
	ThrottlingObjectId string `pulumi:"throttlingObjectId"`
	// The object name which the special user/application throttling policy belongs.
	ThrottlingObjectName *string `pulumi:"throttlingObjectName"`
}

type ThrottlingPolicyUserThrottleArgs 

type ThrottlingPolicyUserThrottleArgs struct {
	// ID of the special user/application throttling policy.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Specifies the maximum number of times an API can be accessed within a specified
	// period.
	MaxApiRequests pulumi.IntInput `pulumi:"maxApiRequests"`
	// Specifies the object ID which the special throttling policy belongs.
	ThrottlingObjectId pulumi.StringInput `pulumi:"throttlingObjectId"`
	// The object name which the special user/application throttling policy belongs.
	ThrottlingObjectName pulumi.StringPtrInput `pulumi:"throttlingObjectName"`
}

func (ThrottlingPolicyUserThrottleArgs) ElementType 

func (ThrottlingPolicyUserThrottleArgs) ElementType() reflect.Type

func (ThrottlingPolicyUserThrottleArgs) ToThrottlingPolicyUserThrottleOutput 

func (i ThrottlingPolicyUserThrottleArgs) ToThrottlingPolicyUserThrottleOutput() ThrottlingPolicyUserThrottleOutput

func (ThrottlingPolicyUserThrottleArgs) ToThrottlingPolicyUserThrottleOutputWithContext 

func (i ThrottlingPolicyUserThrottleArgs) ToThrottlingPolicyUserThrottleOutputWithContext(ctx context.Context) ThrottlingPolicyUserThrottleOutput

type ThrottlingPolicyUserThrottleArray 

type ThrottlingPolicyUserThrottleArray []ThrottlingPolicyUserThrottleInput

func (ThrottlingPolicyUserThrottleArray) ElementType 

func (ThrottlingPolicyUserThrottleArray) ElementType() reflect.Type

func (ThrottlingPolicyUserThrottleArray) ToThrottlingPolicyUserThrottleArrayOutput 

func (i ThrottlingPolicyUserThrottleArray) ToThrottlingPolicyUserThrottleArrayOutput() ThrottlingPolicyUserThrottleArrayOutput

func (ThrottlingPolicyUserThrottleArray) ToThrottlingPolicyUserThrottleArrayOutputWithContext 

func (i ThrottlingPolicyUserThrottleArray) ToThrottlingPolicyUserThrottleArrayOutputWithContext(ctx context.Context) ThrottlingPolicyUserThrottleArrayOutput

type ThrottlingPolicyUserThrottleArrayInput 

type ThrottlingPolicyUserThrottleArrayInput interface {
	pulumi.Input

	ToThrottlingPolicyUserThrottleArrayOutput() ThrottlingPolicyUserThrottleArrayOutput
	ToThrottlingPolicyUserThrottleArrayOutputWithContext(context.Context) ThrottlingPolicyUserThrottleArrayOutput
}

ThrottlingPolicyUserThrottleArrayInput is an input type that accepts ThrottlingPolicyUserThrottleArray and ThrottlingPolicyUserThrottleArrayOutput values. You can construct a concrete instance of `ThrottlingPolicyUserThrottleArrayInput` via: 

ThrottlingPolicyUserThrottleArray{ ThrottlingPolicyUserThrottleArgs{...} }

type ThrottlingPolicyUserThrottleArrayOutput 

type ThrottlingPolicyUserThrottleArrayOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyUserThrottleArrayOutput) ElementType 

func (ThrottlingPolicyUserThrottleArrayOutput) ElementType() reflect.Type

func (ThrottlingPolicyUserThrottleArrayOutput) Index 

func (o ThrottlingPolicyUserThrottleArrayOutput) Index(i pulumi.IntInput) ThrottlingPolicyUserThrottleOutput

func (ThrottlingPolicyUserThrottleArrayOutput) ToThrottlingPolicyUserThrottleArrayOutput 

func (o ThrottlingPolicyUserThrottleArrayOutput) ToThrottlingPolicyUserThrottleArrayOutput() ThrottlingPolicyUserThrottleArrayOutput

func (ThrottlingPolicyUserThrottleArrayOutput) ToThrottlingPolicyUserThrottleArrayOutputWithContext 

func (o ThrottlingPolicyUserThrottleArrayOutput) ToThrottlingPolicyUserThrottleArrayOutputWithContext(ctx context.Context) ThrottlingPolicyUserThrottleArrayOutput

type ThrottlingPolicyUserThrottleInput 

type ThrottlingPolicyUserThrottleInput interface {
	pulumi.Input

	ToThrottlingPolicyUserThrottleOutput() ThrottlingPolicyUserThrottleOutput
	ToThrottlingPolicyUserThrottleOutputWithContext(context.Context) ThrottlingPolicyUserThrottleOutput
}

ThrottlingPolicyUserThrottleInput is an input type that accepts ThrottlingPolicyUserThrottleArgs and ThrottlingPolicyUserThrottleOutput values. You can construct a concrete instance of `ThrottlingPolicyUserThrottleInput` via: 

ThrottlingPolicyUserThrottleArgs{...}

type ThrottlingPolicyUserThrottleOutput 

type ThrottlingPolicyUserThrottleOutput struct{ *pulumi.OutputState }

func (ThrottlingPolicyUserThrottleOutput) ElementType 

func (ThrottlingPolicyUserThrottleOutput) ElementType() reflect.Type

func (ThrottlingPolicyUserThrottleOutput) Id 

func (o ThrottlingPolicyUserThrottleOutput) Id() pulumi.StringPtrOutput

ID of the special user/application throttling policy.

func (ThrottlingPolicyUserThrottleOutput) MaxApiRequests 

func (o ThrottlingPolicyUserThrottleOutput) MaxApiRequests() pulumi.IntOutput

Specifies the maximum number of times an API can be accessed within a specified period.

func (ThrottlingPolicyUserThrottleOutput) ThrottlingObjectId 

func (o ThrottlingPolicyUserThrottleOutput) ThrottlingObjectId() pulumi.StringOutput

Specifies the object ID which the special throttling policy belongs.

func (ThrottlingPolicyUserThrottleOutput) ThrottlingObjectName 

func (o ThrottlingPolicyUserThrottleOutput) ThrottlingObjectName() pulumi.StringPtrOutput

The object name which the special user/application throttling policy belongs.

func (ThrottlingPolicyUserThrottleOutput) ToThrottlingPolicyUserThrottleOutput 

func (o ThrottlingPolicyUserThrottleOutput) ToThrottlingPolicyUserThrottleOutput() ThrottlingPolicyUserThrottleOutput

func (ThrottlingPolicyUserThrottleOutput) ToThrottlingPolicyUserThrottleOutputWithContext 

func (o ThrottlingPolicyUserThrottleOutput) ToThrottlingPolicyUserThrottleOutputWithContext(ctx context.Context) ThrottlingPolicyUserThrottleOutput

type VpcChannel 

type VpcChannel struct {
	pulumi.CustomResourceState

	// Specifies the distribution algorithm.\
	// The valid types are **WRR**, **WLC**, **SH** and **URI hashing**, defaults to **WRR**.
	Algorithm pulumi.StringPtrOutput `pulumi:"algorithm"`
	// The time when the VPC channel was created.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Specifies the healthy threshold, which refers to the number of consecutive
	// successful checks required for a backend server to be considered healthy.
	// The valid value ranges from `2` to `10`, defaults to `2`.
	HealthyThreshold pulumi.IntPtrOutput `pulumi:"healthyThreshold"`
	// Specifies the response codes for determining a successful HTTP response.\
	// The valid value ranges from `100` to `599` and the valid formats are as follows:
	// + The multiple values, for example, **200,201,202**.
	// + The range, for example, **200-299**.
	// + Both multiple values and ranges, for example, **201,202,210-299**.
	HttpCode pulumi.StringPtrOutput `pulumi:"httpCode"`
	// Specifies the ID of the dedicated instance to which the VPC channel
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the interval between consecutive checks, in second.\
	// The valid value ranges from `5` to `300`, defaults to `10`.
	Interval pulumi.IntPtrOutput `pulumi:"interval"`
	// Specifies the member type of the VPC channel.\
	// The valid types are **ECS** and **EIP**, defaults to **ECS**.
	MemberType pulumi.StringPtrOutput `pulumi:"memberType"`
	// Specifies the configuration of the backend servers that bind the VPC channel.\
	// The object structure is documented below.
	Members VpcChannelMemberArrayOutput `pulumi:"members"`
	// Specifies the name of the VPC channel.\
	// The valid length is limited from `3` to `64`, only chinese and english letters, digits, hyphens (-), underscores (_)
	// and dots (.) are allowed.
	// The name must start with a chinese or english letter, and the Chinese characters must be in **UTF-8** or **Unicode**
	// format.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the destination path for health checks.\
	// Required if the `protocol` is **HTTP** or **HTTPS**.
	Path pulumi.StringPtrOutput `pulumi:"path"`
	// Specifies the host port of the VPC channel.\
	// The valid value ranges from `1` to `65,535`.
	Port pulumi.IntOutput `pulumi:"port"`
	// Specifies the protocol for performing health checks on backend servers in the VPC
	// channel.
	// The valid values are **TCP**, **HTTP** and **HTTPS**, defaults to **TCP**.
	Protocol pulumi.StringPtrOutput `pulumi:"protocol"`
	// Specifies the region where the VPC channel is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringOutput `pulumi:"region"`
	// The current status of the VPC channel, supports **Normal** and **Abnormal**.
	Status pulumi.StringOutput `pulumi:"status"`
	// Specifies the timeout for determining whether a health check fails, in second.\
	// The value must be less than the value of the time `interval`.
	// The valid value ranges from `2` to `30`, defaults to `5`.
	Timeout pulumi.IntPtrOutput `pulumi:"timeout"`
	// Specifies the unhealthy threshold, which refers to the number of consecutive
	// failed checks required for a backend server to be considered unhealthy.
	// The valid value ranges from `2` to `10`, defaults to `5`.
	UnhealthyThreshold pulumi.IntPtrOutput `pulumi:"unhealthyThreshold"`
}

!> **WARNING:** It has been deprecated.

Manages a VPC channel resource within HuaweiCloud.

## Example Usage

```go package main

import ( 

"github.com/huaweicloud/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi-huaweicloud/sdk/go/huaweicloud/DedicatedApig"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		channelName := cfg.RequireObject("channelName")
		ecsId1 := cfg.RequireObject("ecsId1")
		ecsId2 := cfg.RequireObject("ecsId2")
		_, err := DedicatedApig.NewVpcChannel(ctx, "test", &DedicatedApig.VpcChannelArgs{
			InstanceId: pulumi.Any(instanceId),
			Port:       pulumi.Int(8080),
			Protocol:   pulumi.String("HTTPS"),
			Path:       pulumi.String("/"),
			HttpCode:   pulumi.String("201,202,203"),
			Members: dedicatedapig.VpcChannelMemberArray{
				&dedicatedapig.VpcChannelMemberArgs{
					Id:     pulumi.Any(ecsId1),
					Weight: pulumi.Int(30),
				},
				&dedicatedapig.VpcChannelMemberArgs{
					Id:     pulumi.Any(ecsId2),
					Weight: pulumi.Int(70),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

VPC Channels can be imported using their `name` and the ID of the related dedicated instance, separated by a slash, e.g.

```sh 

$ pulumi import huaweicloud:DedicatedApig/vpcChannel:VpcChannel test <instance_id>/<name>

```

func GetVpcChannel 

func GetVpcChannel(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VpcChannelState, opts ...pulumi.ResourceOption) (*VpcChannel, error)

GetVpcChannel gets an existing VpcChannel 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 NewVpcChannel 

func NewVpcChannel(ctx *pulumi.Context,
	name string, args *VpcChannelArgs, opts ...pulumi.ResourceOption) (*VpcChannel, error)

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

func (*VpcChannel) ElementType 

func (*VpcChannel) ElementType() reflect.Type

func (*VpcChannel) ToVpcChannelOutput 

func (i *VpcChannel) ToVpcChannelOutput() VpcChannelOutput

func (*VpcChannel) ToVpcChannelOutputWithContext 

func (i *VpcChannel) ToVpcChannelOutputWithContext(ctx context.Context) VpcChannelOutput

type VpcChannelArgs 

type VpcChannelArgs struct {
	// Specifies the distribution algorithm.\
	// The valid types are **WRR**, **WLC**, **SH** and **URI hashing**, defaults to **WRR**.
	Algorithm pulumi.StringPtrInput
	// Specifies the healthy threshold, which refers to the number of consecutive
	// successful checks required for a backend server to be considered healthy.
	// The valid value ranges from `2` to `10`, defaults to `2`.
	HealthyThreshold pulumi.IntPtrInput
	// Specifies the response codes for determining a successful HTTP response.\
	// The valid value ranges from `100` to `599` and the valid formats are as follows:
	// + The multiple values, for example, **200,201,202**.
	// + The range, for example, **200-299**.
	// + Both multiple values and ranges, for example, **201,202,210-299**.
	HttpCode pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the VPC channel
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringInput
	// Specifies the interval between consecutive checks, in second.\
	// The valid value ranges from `5` to `300`, defaults to `10`.
	Interval pulumi.IntPtrInput
	// Specifies the member type of the VPC channel.\
	// The valid types are **ECS** and **EIP**, defaults to **ECS**.
	MemberType pulumi.StringPtrInput
	// Specifies the configuration of the backend servers that bind the VPC channel.\
	// The object structure is documented below.
	Members VpcChannelMemberArrayInput
	// Specifies the name of the VPC channel.\
	// The valid length is limited from `3` to `64`, only chinese and english letters, digits, hyphens (-), underscores (_)
	// and dots (.) are allowed.
	// The name must start with a chinese or english letter, and the Chinese characters must be in **UTF-8** or **Unicode**
	// format.
	Name pulumi.StringPtrInput
	// Specifies the destination path for health checks.\
	// Required if the `protocol` is **HTTP** or **HTTPS**.
	Path pulumi.StringPtrInput
	// Specifies the host port of the VPC channel.\
	// The valid value ranges from `1` to `65,535`.
	Port pulumi.IntInput
	// Specifies the protocol for performing health checks on backend servers in the VPC
	// channel.
	// The valid values are **TCP**, **HTTP** and **HTTPS**, defaults to **TCP**.
	Protocol pulumi.StringPtrInput
	// Specifies the region where the VPC channel is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// Specifies the timeout for determining whether a health check fails, in second.\
	// The value must be less than the value of the time `interval`.
	// The valid value ranges from `2` to `30`, defaults to `5`.
	Timeout pulumi.IntPtrInput
	// Specifies the unhealthy threshold, which refers to the number of consecutive
	// failed checks required for a backend server to be considered unhealthy.
	// The valid value ranges from `2` to `10`, defaults to `5`.
	UnhealthyThreshold pulumi.IntPtrInput
}

The set of arguments for constructing a VpcChannel resource.

func (VpcChannelArgs) ElementType 

func (VpcChannelArgs) ElementType() reflect.Type

type VpcChannelArray 

type VpcChannelArray []VpcChannelInput

func (VpcChannelArray) ElementType 

func (VpcChannelArray) ElementType() reflect.Type

func (VpcChannelArray) ToVpcChannelArrayOutput 

func (i VpcChannelArray) ToVpcChannelArrayOutput() VpcChannelArrayOutput

func (VpcChannelArray) ToVpcChannelArrayOutputWithContext 

func (i VpcChannelArray) ToVpcChannelArrayOutputWithContext(ctx context.Context) VpcChannelArrayOutput

type VpcChannelArrayInput 

type VpcChannelArrayInput interface {
	pulumi.Input

	ToVpcChannelArrayOutput() VpcChannelArrayOutput
	ToVpcChannelArrayOutputWithContext(context.Context) VpcChannelArrayOutput
}

VpcChannelArrayInput is an input type that accepts VpcChannelArray and VpcChannelArrayOutput values. You can construct a concrete instance of `VpcChannelArrayInput` via: 

VpcChannelArray{ VpcChannelArgs{...} }

type VpcChannelArrayOutput 

type VpcChannelArrayOutput struct{ *pulumi.OutputState }

func (VpcChannelArrayOutput) ElementType 

func (VpcChannelArrayOutput) ElementType() reflect.Type

func (VpcChannelArrayOutput) Index 

func (o VpcChannelArrayOutput) Index(i pulumi.IntInput) VpcChannelOutput

func (VpcChannelArrayOutput) ToVpcChannelArrayOutput 

func (o VpcChannelArrayOutput) ToVpcChannelArrayOutput() VpcChannelArrayOutput

func (VpcChannelArrayOutput) ToVpcChannelArrayOutputWithContext 

func (o VpcChannelArrayOutput) ToVpcChannelArrayOutputWithContext(ctx context.Context) VpcChannelArrayOutput

type VpcChannelInput 

type VpcChannelInput interface {
	pulumi.Input

	ToVpcChannelOutput() VpcChannelOutput
	ToVpcChannelOutputWithContext(ctx context.Context) VpcChannelOutput
}

type VpcChannelMap 

type VpcChannelMap map[string]VpcChannelInput

func (VpcChannelMap) ElementType 

func (VpcChannelMap) ElementType() reflect.Type

func (VpcChannelMap) ToVpcChannelMapOutput 

func (i VpcChannelMap) ToVpcChannelMapOutput() VpcChannelMapOutput

func (VpcChannelMap) ToVpcChannelMapOutputWithContext 

func (i VpcChannelMap) ToVpcChannelMapOutputWithContext(ctx context.Context) VpcChannelMapOutput

type VpcChannelMapInput 

type VpcChannelMapInput interface {
	pulumi.Input

	ToVpcChannelMapOutput() VpcChannelMapOutput
	ToVpcChannelMapOutputWithContext(context.Context) VpcChannelMapOutput
}

VpcChannelMapInput is an input type that accepts VpcChannelMap and VpcChannelMapOutput values. You can construct a concrete instance of `VpcChannelMapInput` via: 

VpcChannelMap{ "key": VpcChannelArgs{...} }

type VpcChannelMapOutput 

type VpcChannelMapOutput struct{ *pulumi.OutputState }

func (VpcChannelMapOutput) ElementType 

func (VpcChannelMapOutput) ElementType() reflect.Type

func (VpcChannelMapOutput) MapIndex 

func (o VpcChannelMapOutput) MapIndex(k pulumi.StringInput) VpcChannelOutput

func (VpcChannelMapOutput) ToVpcChannelMapOutput 

func (o VpcChannelMapOutput) ToVpcChannelMapOutput() VpcChannelMapOutput

func (VpcChannelMapOutput) ToVpcChannelMapOutputWithContext 

func (o VpcChannelMapOutput) ToVpcChannelMapOutputWithContext(ctx context.Context) VpcChannelMapOutput

type VpcChannelMember 

type VpcChannelMember struct {
	// Specifies the ECS ID for each backend servers.
	// Required if the `memberType` is **ECS**.
	// This parameter and `ipAddress` are alternative.
	Id *string `pulumi:"id"`
	// Specifies the IP address each backend servers.
	// Required if the `memberType` is **EIP**.
	IpAddress *string `pulumi:"ipAddress"`
	// Specifies the backend server weight.
	// The valid value ranges from `1` to `100`, defaults to `1`.
	Weight *int `pulumi:"weight"`
}

type VpcChannelMemberArgs 

type VpcChannelMemberArgs struct {
	// Specifies the ECS ID for each backend servers.
	// Required if the `memberType` is **ECS**.
	// This parameter and `ipAddress` are alternative.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Specifies the IP address each backend servers.
	// Required if the `memberType` is **EIP**.
	IpAddress pulumi.StringPtrInput `pulumi:"ipAddress"`
	// Specifies the backend server weight.
	// The valid value ranges from `1` to `100`, defaults to `1`.
	Weight pulumi.IntPtrInput `pulumi:"weight"`
}

func (VpcChannelMemberArgs) ElementType 

func (VpcChannelMemberArgs) ElementType() reflect.Type

func (VpcChannelMemberArgs) ToVpcChannelMemberOutput 

func (i VpcChannelMemberArgs) ToVpcChannelMemberOutput() VpcChannelMemberOutput

func (VpcChannelMemberArgs) ToVpcChannelMemberOutputWithContext 

func (i VpcChannelMemberArgs) ToVpcChannelMemberOutputWithContext(ctx context.Context) VpcChannelMemberOutput

type VpcChannelMemberArray 

type VpcChannelMemberArray []VpcChannelMemberInput

func (VpcChannelMemberArray) ElementType 

func (VpcChannelMemberArray) ElementType() reflect.Type

func (VpcChannelMemberArray) ToVpcChannelMemberArrayOutput 

func (i VpcChannelMemberArray) ToVpcChannelMemberArrayOutput() VpcChannelMemberArrayOutput

func (VpcChannelMemberArray) ToVpcChannelMemberArrayOutputWithContext 

func (i VpcChannelMemberArray) ToVpcChannelMemberArrayOutputWithContext(ctx context.Context) VpcChannelMemberArrayOutput

type VpcChannelMemberArrayInput 

type VpcChannelMemberArrayInput interface {
	pulumi.Input

	ToVpcChannelMemberArrayOutput() VpcChannelMemberArrayOutput
	ToVpcChannelMemberArrayOutputWithContext(context.Context) VpcChannelMemberArrayOutput
}

VpcChannelMemberArrayInput is an input type that accepts VpcChannelMemberArray and VpcChannelMemberArrayOutput values. You can construct a concrete instance of `VpcChannelMemberArrayInput` via: 

VpcChannelMemberArray{ VpcChannelMemberArgs{...} }

type VpcChannelMemberArrayOutput 

type VpcChannelMemberArrayOutput struct{ *pulumi.OutputState }

func (VpcChannelMemberArrayOutput) ElementType 

func (VpcChannelMemberArrayOutput) ElementType() reflect.Type

func (VpcChannelMemberArrayOutput) Index 

func (o VpcChannelMemberArrayOutput) Index(i pulumi.IntInput) VpcChannelMemberOutput

func (VpcChannelMemberArrayOutput) ToVpcChannelMemberArrayOutput 

func (o VpcChannelMemberArrayOutput) ToVpcChannelMemberArrayOutput() VpcChannelMemberArrayOutput

func (VpcChannelMemberArrayOutput) ToVpcChannelMemberArrayOutputWithContext 

func (o VpcChannelMemberArrayOutput) ToVpcChannelMemberArrayOutputWithContext(ctx context.Context) VpcChannelMemberArrayOutput

type VpcChannelMemberInput 

type VpcChannelMemberInput interface {
	pulumi.Input

	ToVpcChannelMemberOutput() VpcChannelMemberOutput
	ToVpcChannelMemberOutputWithContext(context.Context) VpcChannelMemberOutput
}

VpcChannelMemberInput is an input type that accepts VpcChannelMemberArgs and VpcChannelMemberOutput values. You can construct a concrete instance of `VpcChannelMemberInput` via: 

VpcChannelMemberArgs{...}

type VpcChannelMemberOutput 

type VpcChannelMemberOutput struct{ *pulumi.OutputState }

func (VpcChannelMemberOutput) ElementType 

func (VpcChannelMemberOutput) ElementType() reflect.Type

func (VpcChannelMemberOutput) Id 

func (o VpcChannelMemberOutput) Id() pulumi.StringPtrOutput

Specifies the ECS ID for each backend servers. Required if the `memberType` is **ECS**. This parameter and `ipAddress` are alternative.

func (VpcChannelMemberOutput) IpAddress 

func (o VpcChannelMemberOutput) IpAddress() pulumi.StringPtrOutput

Specifies the IP address each backend servers. Required if the `memberType` is **EIP**.

func (VpcChannelMemberOutput) ToVpcChannelMemberOutput 

func (o VpcChannelMemberOutput) ToVpcChannelMemberOutput() VpcChannelMemberOutput

func (VpcChannelMemberOutput) ToVpcChannelMemberOutputWithContext 

func (o VpcChannelMemberOutput) ToVpcChannelMemberOutputWithContext(ctx context.Context) VpcChannelMemberOutput

func (VpcChannelMemberOutput) Weight 

func (o VpcChannelMemberOutput) Weight() pulumi.IntPtrOutput

Specifies the backend server weight. The valid value ranges from `1` to `100`, defaults to `1`.

type VpcChannelOutput 

type VpcChannelOutput struct{ *pulumi.OutputState }

func (VpcChannelOutput) Algorithm 

func (o VpcChannelOutput) Algorithm() pulumi.StringPtrOutput

Specifies the distribution algorithm.\ The valid types are **WRR**, **WLC**, **SH** and **URI hashing**, defaults to **WRR**.

func (VpcChannelOutput) CreatedAt added in v0.0.8 

func (o VpcChannelOutput) CreatedAt() pulumi.StringOutput

The time when the VPC channel was created.

func (VpcChannelOutput) ElementType 

func (VpcChannelOutput) ElementType() reflect.Type

func (VpcChannelOutput) HealthyThreshold 

func (o VpcChannelOutput) HealthyThreshold() pulumi.IntPtrOutput

Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value ranges from `2` to `10`, defaults to `2`.

func (VpcChannelOutput) HttpCode 

func (o VpcChannelOutput) HttpCode() pulumi.StringPtrOutput

Specifies the response codes for determining a successful HTTP response.\ The valid value ranges from `100` to `599` and the valid formats are as follows: + The multiple values, for example, **200,201,202**. + The range, for example, **200-299**. + Both multiple values and ranges, for example, **201,202,210-299**.

func (VpcChannelOutput) InstanceId 

func (o VpcChannelOutput) InstanceId() pulumi.StringOutput

Specifies the ID of the dedicated instance to which the VPC channel belongs. Changing this will create a new resource.

func (VpcChannelOutput) Interval 

func (o VpcChannelOutput) Interval() pulumi.IntPtrOutput

Specifies the interval between consecutive checks, in second.\ The valid value ranges from `5` to `300`, defaults to `10`.

func (VpcChannelOutput) MemberType 

func (o VpcChannelOutput) MemberType() pulumi.StringPtrOutput

Specifies the member type of the VPC channel.\ The valid types are **ECS** and **EIP**, defaults to **ECS**.

func (VpcChannelOutput) Members 

func (o VpcChannelOutput) Members() VpcChannelMemberArrayOutput

Specifies the configuration of the backend servers that bind the VPC channel.\ The object structure is documented below.

func (VpcChannelOutput) Name 

func (o VpcChannelOutput) Name() pulumi.StringOutput

Specifies the name of the VPC channel.\ The valid length is limited from `3` to `64`, only chinese and english letters, digits, hyphens (-), underscores (_) and dots (.) are allowed. The name must start with a chinese or english letter, and the Chinese characters must be in **UTF-8** or **Unicode** format.

func (VpcChannelOutput) Path 

func (o VpcChannelOutput) Path() pulumi.StringPtrOutput

Specifies the destination path for health checks.\ Required if the `protocol` is **HTTP** or **HTTPS**.

func (VpcChannelOutput) Port 

func (o VpcChannelOutput) Port() pulumi.IntOutput

Specifies the host port of the VPC channel.\ The valid value ranges from `1` to `65,535`.

func (VpcChannelOutput) Protocol 

func (o VpcChannelOutput) Protocol() pulumi.StringPtrOutput

Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are **TCP**, **HTTP** and **HTTPS**, defaults to **TCP**.

func (VpcChannelOutput) Region 

func (o VpcChannelOutput) Region() pulumi.StringOutput

Specifies the region where the VPC channel is located.\ If omitted, the provider-level region will be used. Changing this will create a new resource.

func (VpcChannelOutput) Status 

func (o VpcChannelOutput) Status() pulumi.StringOutput

The current status of the VPC channel, supports **Normal** and **Abnormal**.

func (VpcChannelOutput) Timeout 

func (o VpcChannelOutput) Timeout() pulumi.IntPtrOutput

Specifies the timeout for determining whether a health check fails, in second.\ The value must be less than the value of the time `interval`. The valid value ranges from `2` to `30`, defaults to `5`.

func (VpcChannelOutput) ToVpcChannelOutput 

func (o VpcChannelOutput) ToVpcChannelOutput() VpcChannelOutput

func (VpcChannelOutput) ToVpcChannelOutputWithContext 

func (o VpcChannelOutput) ToVpcChannelOutputWithContext(ctx context.Context) VpcChannelOutput

func (VpcChannelOutput) UnhealthyThreshold 

func (o VpcChannelOutput) UnhealthyThreshold() pulumi.IntPtrOutput

Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value ranges from `2` to `10`, defaults to `5`.

type VpcChannelState 

type VpcChannelState struct {
	// Specifies the distribution algorithm.\
	// The valid types are **WRR**, **WLC**, **SH** and **URI hashing**, defaults to **WRR**.
	Algorithm pulumi.StringPtrInput
	// The time when the VPC channel was created.
	CreatedAt pulumi.StringPtrInput
	// Specifies the healthy threshold, which refers to the number of consecutive
	// successful checks required for a backend server to be considered healthy.
	// The valid value ranges from `2` to `10`, defaults to `2`.
	HealthyThreshold pulumi.IntPtrInput
	// Specifies the response codes for determining a successful HTTP response.\
	// The valid value ranges from `100` to `599` and the valid formats are as follows:
	// + The multiple values, for example, **200,201,202**.
	// + The range, for example, **200-299**.
	// + Both multiple values and ranges, for example, **201,202,210-299**.
	HttpCode pulumi.StringPtrInput
	// Specifies the ID of the dedicated instance to which the VPC channel
	// belongs.
	// Changing this will create a new resource.
	InstanceId pulumi.StringPtrInput
	// Specifies the interval between consecutive checks, in second.\
	// The valid value ranges from `5` to `300`, defaults to `10`.
	Interval pulumi.IntPtrInput
	// Specifies the member type of the VPC channel.\
	// The valid types are **ECS** and **EIP**, defaults to **ECS**.
	MemberType pulumi.StringPtrInput
	// Specifies the configuration of the backend servers that bind the VPC channel.\
	// The object structure is documented below.
	Members VpcChannelMemberArrayInput
	// Specifies the name of the VPC channel.\
	// The valid length is limited from `3` to `64`, only chinese and english letters, digits, hyphens (-), underscores (_)
	// and dots (.) are allowed.
	// The name must start with a chinese or english letter, and the Chinese characters must be in **UTF-8** or **Unicode**
	// format.
	Name pulumi.StringPtrInput
	// Specifies the destination path for health checks.\
	// Required if the `protocol` is **HTTP** or **HTTPS**.
	Path pulumi.StringPtrInput
	// Specifies the host port of the VPC channel.\
	// The valid value ranges from `1` to `65,535`.
	Port pulumi.IntPtrInput
	// Specifies the protocol for performing health checks on backend servers in the VPC
	// channel.
	// The valid values are **TCP**, **HTTP** and **HTTPS**, defaults to **TCP**.
	Protocol pulumi.StringPtrInput
	// Specifies the region where the VPC channel is located.\
	// If omitted, the provider-level region will be used. Changing this will create a new resource.
	Region pulumi.StringPtrInput
	// The current status of the VPC channel, supports **Normal** and **Abnormal**.
	Status pulumi.StringPtrInput
	// Specifies the timeout for determining whether a health check fails, in second.\
	// The value must be less than the value of the time `interval`.
	// The valid value ranges from `2` to `30`, defaults to `5`.
	Timeout pulumi.IntPtrInput
	// Specifies the unhealthy threshold, which refers to the number of consecutive
	// failed checks required for a backend server to be considered unhealthy.
	// The valid value ranges from `2` to `10`, defaults to `5`.
	UnhealthyThreshold pulumi.IntPtrInput
}

func (VpcChannelState) ElementType 

func (VpcChannelState) 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.