apigateway

package
v2.6.1 Latest Latest
Warning

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

 Go to latest Published: Oct 2, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Overview

Pulumi Amazon Web Services (AWS) API Gateway Components.

Index

Constants

View Source 
const (
	APIKeySourceHEADER     = APIKeySource("HEADER")
	APIKeySourceAUTHORIZER = APIKeySource("AUTHORIZER")
)
View Source 
const (
	IntegrationConnectionTypeINTERNET  = IntegrationConnectionType("INTERNET")
	IntegrationConnectionType_VPC_LINK = IntegrationConnectionType("VPC_LINK")
)
View Source 
const (
	IntegrationPassthroughBehavior_When_no_match     = IntegrationPassthroughBehavior("when_no_match")
	IntegrationPassthroughBehavior_When_no_templates = IntegrationPassthroughBehavior("when_no_templates")
	IntegrationPassthroughBehaviorNever              = IntegrationPassthroughBehavior("never")
)
View Source 
const (
	IntegrationTypeAws         = IntegrationType("aws")
	IntegrationType_Aws_proxy  = IntegrationType("aws_proxy")
	IntegrationTypeHttp        = IntegrationType("http")
	IntegrationType_Http_proxy = IntegrationType("http_proxy")
	IntegrationTypeMock        = IntegrationType("mock")
)
View Source 
const (
	MethodANY     = Method("ANY")
	MethodGET     = Method("GET")
	MethodPUT     = Method("PUT")
	MethodPOST    = Method("POST")
	MethodDELETE  = Method("DELETE")
	MethodPATCH   = Method("PATCH")
	MethodOPTIONS = Method("OPTIONS")
	MethodHEAD    = Method("HEAD")
)
View Source 
const (
	RequestValidatorALL          = RequestValidator("ALL")
	RequestValidator_PARAMS_ONLY = RequestValidator("PARAMS_ONLY")
	RequestValidator_BODY_ONLY   = RequestValidator("BODY_ONLY")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKeySource 

type APIKeySource string

func (APIKeySource) ElementType 

func (APIKeySource) ElementType() reflect.Type

func (APIKeySource) ToAPIKeySourceOutput 

func (e APIKeySource) ToAPIKeySourceOutput() APIKeySourceOutput

func (APIKeySource) ToAPIKeySourceOutputWithContext 

func (e APIKeySource) ToAPIKeySourceOutputWithContext(ctx context.Context) APIKeySourceOutput

func (APIKeySource) ToAPIKeySourcePtrOutput 

func (e APIKeySource) ToAPIKeySourcePtrOutput() APIKeySourcePtrOutput

func (APIKeySource) ToAPIKeySourcePtrOutputWithContext 

func (e APIKeySource) ToAPIKeySourcePtrOutputWithContext(ctx context.Context) APIKeySourcePtrOutput

func (APIKeySource) ToStringOutput 

func (e APIKeySource) ToStringOutput() pulumi.StringOutput

func (APIKeySource) ToStringOutputWithContext 

func (e APIKeySource) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (APIKeySource) ToStringPtrOutput 

func (e APIKeySource) ToStringPtrOutput() pulumi.StringPtrOutput

func (APIKeySource) ToStringPtrOutputWithContext 

func (e APIKeySource) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type APIKeySourceInput 

type APIKeySourceInput interface {
	pulumi.Input

	ToAPIKeySourceOutput() APIKeySourceOutput
	ToAPIKeySourceOutputWithContext(context.Context) APIKeySourceOutput
}

APIKeySourceInput is an input type that accepts values of the APIKeySource enum A concrete instance of `APIKeySourceInput` can be one of the following: 

APIKeySourceHEADER
APIKeySourceAUTHORIZER

type APIKeySourceOutput 

type APIKeySourceOutput struct{ *pulumi.OutputState }

func (APIKeySourceOutput) ElementType 

func (APIKeySourceOutput) ElementType() reflect.Type

func (APIKeySourceOutput) ToAPIKeySourceOutput 

func (o APIKeySourceOutput) ToAPIKeySourceOutput() APIKeySourceOutput

func (APIKeySourceOutput) ToAPIKeySourceOutputWithContext 

func (o APIKeySourceOutput) ToAPIKeySourceOutputWithContext(ctx context.Context) APIKeySourceOutput

func (APIKeySourceOutput) ToAPIKeySourcePtrOutput 

func (o APIKeySourceOutput) ToAPIKeySourcePtrOutput() APIKeySourcePtrOutput

func (APIKeySourceOutput) ToAPIKeySourcePtrOutputWithContext 

func (o APIKeySourceOutput) ToAPIKeySourcePtrOutputWithContext(ctx context.Context) APIKeySourcePtrOutput

func (APIKeySourceOutput) ToStringOutput 

func (o APIKeySourceOutput) ToStringOutput() pulumi.StringOutput

func (APIKeySourceOutput) ToStringOutputWithContext 

func (o APIKeySourceOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (APIKeySourceOutput) ToStringPtrOutput 

func (o APIKeySourceOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (APIKeySourceOutput) ToStringPtrOutputWithContext 

func (o APIKeySourceOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type APIKeySourcePtrInput 

type APIKeySourcePtrInput interface {
	pulumi.Input

	ToAPIKeySourcePtrOutput() APIKeySourcePtrOutput
	ToAPIKeySourcePtrOutputWithContext(context.Context) APIKeySourcePtrOutput
}

func APIKeySourcePtr 

func APIKeySourcePtr(v string) APIKeySourcePtrInput

type APIKeySourcePtrOutput 

type APIKeySourcePtrOutput struct{ *pulumi.OutputState }

func (APIKeySourcePtrOutput) Elem 

func (o APIKeySourcePtrOutput) Elem() APIKeySourceOutput

func (APIKeySourcePtrOutput) ElementType 

func (APIKeySourcePtrOutput) ElementType() reflect.Type

func (APIKeySourcePtrOutput) ToAPIKeySourcePtrOutput 

func (o APIKeySourcePtrOutput) ToAPIKeySourcePtrOutput() APIKeySourcePtrOutput

func (APIKeySourcePtrOutput) ToAPIKeySourcePtrOutputWithContext 

func (o APIKeySourcePtrOutput) ToAPIKeySourcePtrOutputWithContext(ctx context.Context) APIKeySourcePtrOutput

func (APIKeySourcePtrOutput) ToStringPtrOutput 

func (o APIKeySourcePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (APIKeySourcePtrOutput) ToStringPtrOutputWithContext 

func (o APIKeySourcePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Authorizer 

type Authorizer struct {
	// Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".
	AuthType *string `pulumi:"authType"`
	// The name for the Authorizer to be referenced as. This must be unique for each unique
	// authorizer within the API. If no name if specified, a name will be generated for you.
	AuthorizerName *string `pulumi:"authorizerName"`
	// The number of seconds during which the resulting IAM policy is cached. Default is 300s. You
	// can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an
	// authorizer across more than one route you will want to disable the cache or else it will
	// cause problems for you.
	AuthorizerResultTtlInSeconds *float64 `pulumi:"authorizerResultTtlInSeconds"`
	// The authorizerHandler specifies information about the authorizing Lambda.
	Handler *lambda.Function `pulumi:"handler"`
	// List of mapping expressions of the request parameters as the identity source. This indicates
	// where in the request identity information is expected. Applicable for the authorizer of the
	// "request" type only. Example: ["method.request.header.HeaderAuth1",
	// "method.request.querystring.QueryString1"]
	IdentitySource []string `pulumi:"identitySource"`
	// A regular expression for validating the token as the incoming identity. It only invokes the
	// authorizer's lambda if there is a match, else it will return a 401. This does not apply to
	// REQUEST Lambda Authorizers. Example: "^x-[a-z]+".
	IdentityValidationExpression *string `pulumi:"identityValidationExpression"`
	// For method authorization, you can define resource servers and custom scopes by specifying the
	// "resource-server/scope". e.g. ["com.hamuta.movies/drama.view",
	// "http://my.resource.com/file.read"] For more information on resource servers and custom
	// scopes visit the AWS documentation -
	// https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html
	MethodsToAuthorize []string `pulumi:"methodsToAuthorize"`
	// Defines where in the request API Gateway should look for identity information. The value must
	// be "header" or "query". If there are multiple identity sources, the value must be "header".
	ParameterLocation *string `pulumi:"parameterLocation"`
	// parameterName is the name of the header or query parameter containing the authorization
	// token. Must be "Unused" for multiple identity sources.
	ParameterName string `pulumi:"parameterName"`
	// The ARNs of the Cognito User Pools to use.
	ProviderARNs []string `pulumi:"providerARNs"`
	// The type of the authorizer. This value must be one of the following:
	// - "token", for an authorizer with the caller identity embedded in an authorization token
	// - "request", for an authorizer with the caller identity contained in request parameters
	Type *string `pulumi:"type"`
}

LambdaAuthorizer provides the definition for a custom Authorizer for API Gateway.

type AuthorizerArgs 

type AuthorizerArgs struct {
	// Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".
	AuthType *string `pulumi:"authType"`
	// The name for the Authorizer to be referenced as. This must be unique for each unique
	// authorizer within the API. If no name if specified, a name will be generated for you.
	AuthorizerName *string `pulumi:"authorizerName"`
	// The number of seconds during which the resulting IAM policy is cached. Default is 300s. You
	// can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an
	// authorizer across more than one route you will want to disable the cache or else it will
	// cause problems for you.
	AuthorizerResultTtlInSeconds *float64 `pulumi:"authorizerResultTtlInSeconds"`
	// The authorizerHandler specifies information about the authorizing Lambda.
	Handler lambda.FunctionInput `pulumi:"handler"`
	// List of mapping expressions of the request parameters as the identity source. This indicates
	// where in the request identity information is expected. Applicable for the authorizer of the
	// "request" type only. Example: ["method.request.header.HeaderAuth1",
	// "method.request.querystring.QueryString1"]
	IdentitySource []string `pulumi:"identitySource"`
	// A regular expression for validating the token as the incoming identity. It only invokes the
	// authorizer's lambda if there is a match, else it will return a 401. This does not apply to
	// REQUEST Lambda Authorizers. Example: "^x-[a-z]+".
	IdentityValidationExpression *string `pulumi:"identityValidationExpression"`
	// For method authorization, you can define resource servers and custom scopes by specifying the
	// "resource-server/scope". e.g. ["com.hamuta.movies/drama.view",
	// "http://my.resource.com/file.read"] For more information on resource servers and custom
	// scopes visit the AWS documentation -
	// https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html
	MethodsToAuthorize []string `pulumi:"methodsToAuthorize"`
	// Defines where in the request API Gateway should look for identity information. The value must
	// be "header" or "query". If there are multiple identity sources, the value must be "header".
	ParameterLocation *string `pulumi:"parameterLocation"`
	// parameterName is the name of the header or query parameter containing the authorization
	// token. Must be "Unused" for multiple identity sources.
	ParameterName string `pulumi:"parameterName"`
	// The ARNs of the Cognito User Pools to use.
	ProviderARNs []pulumi.StringInput `pulumi:"providerARNs"`
	// The type of the authorizer. This value must be one of the following:
	// - "token", for an authorizer with the caller identity embedded in an authorization token
	// - "request", for an authorizer with the caller identity contained in request parameters
	Type *string `pulumi:"type"`
}

LambdaAuthorizer provides the definition for a custom Authorizer for API Gateway.

func (AuthorizerArgs) ElementType 

func (AuthorizerArgs) ElementType() reflect.Type

func (AuthorizerArgs) ToAuthorizerOutput 

func (i AuthorizerArgs) ToAuthorizerOutput() AuthorizerOutput

func (AuthorizerArgs) ToAuthorizerOutputWithContext 

func (i AuthorizerArgs) ToAuthorizerOutputWithContext(ctx context.Context) AuthorizerOutput

type AuthorizerArray 

type AuthorizerArray []AuthorizerInput

func (AuthorizerArray) ElementType 

func (AuthorizerArray) ElementType() reflect.Type

func (AuthorizerArray) ToAuthorizerArrayOutput 

func (i AuthorizerArray) ToAuthorizerArrayOutput() AuthorizerArrayOutput

func (AuthorizerArray) ToAuthorizerArrayOutputWithContext 

func (i AuthorizerArray) ToAuthorizerArrayOutputWithContext(ctx context.Context) AuthorizerArrayOutput

type AuthorizerArrayInput 

type AuthorizerArrayInput interface {
	pulumi.Input

	ToAuthorizerArrayOutput() AuthorizerArrayOutput
	ToAuthorizerArrayOutputWithContext(context.Context) AuthorizerArrayOutput
}

AuthorizerArrayInput is an input type that accepts AuthorizerArray and AuthorizerArrayOutput values. You can construct a concrete instance of `AuthorizerArrayInput` via: 

AuthorizerArray{ AuthorizerArgs{...} }

type AuthorizerArrayOutput 

type AuthorizerArrayOutput struct{ *pulumi.OutputState }

func (AuthorizerArrayOutput) ElementType 

func (AuthorizerArrayOutput) ElementType() reflect.Type

func (AuthorizerArrayOutput) Index 

func (o AuthorizerArrayOutput) Index(i pulumi.IntInput) AuthorizerOutput

func (AuthorizerArrayOutput) ToAuthorizerArrayOutput 

func (o AuthorizerArrayOutput) ToAuthorizerArrayOutput() AuthorizerArrayOutput

func (AuthorizerArrayOutput) ToAuthorizerArrayOutputWithContext 

func (o AuthorizerArrayOutput) ToAuthorizerArrayOutputWithContext(ctx context.Context) AuthorizerArrayOutput

type AuthorizerInput 

type AuthorizerInput interface {
	pulumi.Input

	ToAuthorizerOutput() AuthorizerOutput
	ToAuthorizerOutputWithContext(context.Context) AuthorizerOutput
}

AuthorizerInput is an input type that accepts AuthorizerArgs and AuthorizerOutput values. You can construct a concrete instance of `AuthorizerInput` via: 

AuthorizerArgs{...}

type AuthorizerOutput 

type AuthorizerOutput struct{ *pulumi.OutputState }

LambdaAuthorizer provides the definition for a custom Authorizer for API Gateway.

func (AuthorizerOutput) AuthType 

func (o AuthorizerOutput) AuthType() pulumi.StringPtrOutput

Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".

func (AuthorizerOutput) AuthorizerName 

func (o AuthorizerOutput) AuthorizerName() pulumi.StringPtrOutput

The name for the Authorizer to be referenced as. This must be unique for each unique authorizer within the API. If no name if specified, a name will be generated for you.

func (AuthorizerOutput) AuthorizerResultTtlInSeconds 

func (o AuthorizerOutput) AuthorizerResultTtlInSeconds() pulumi.Float64PtrOutput

The number of seconds during which the resulting IAM policy is cached. Default is 300s. You can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an authorizer across more than one route you will want to disable the cache or else it will cause problems for you.

func (AuthorizerOutput) ElementType 

func (AuthorizerOutput) ElementType() reflect.Type

func (AuthorizerOutput) Handler 

func (o AuthorizerOutput) Handler() lambda.FunctionOutput

The authorizerHandler specifies information about the authorizing Lambda.

func (AuthorizerOutput) IdentitySource 

func (o AuthorizerOutput) IdentitySource() pulumi.StringArrayOutput

List of mapping expressions of the request parameters as the identity source. This indicates where in the request identity information is expected. Applicable for the authorizer of the "request" type only. Example: ["method.request.header.HeaderAuth1", "method.request.querystring.QueryString1"]

func (AuthorizerOutput) IdentityValidationExpression 

func (o AuthorizerOutput) IdentityValidationExpression() pulumi.StringPtrOutput

A regular expression for validating the token as the incoming identity. It only invokes the authorizer's lambda if there is a match, else it will return a 401. This does not apply to REQUEST Lambda Authorizers. Example: "^x-[a-z]+".

func (AuthorizerOutput) MethodsToAuthorize 

func (o AuthorizerOutput) MethodsToAuthorize() pulumi.StringArrayOutput

For method authorization, you can define resource servers and custom scopes by specifying the "resource-server/scope". e.g. ["com.hamuta.movies/drama.view", "http://my.resource.com/file.read"] For more information on resource servers and custom scopes visit the AWS documentation - https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html

func (AuthorizerOutput) ParameterLocation 

func (o AuthorizerOutput) ParameterLocation() pulumi.StringPtrOutput

Defines where in the request API Gateway should look for identity information. The value must be "header" or "query". If there are multiple identity sources, the value must be "header".

func (AuthorizerOutput) ParameterName 

func (o AuthorizerOutput) ParameterName() pulumi.StringOutput

parameterName is the name of the header or query parameter containing the authorization token. Must be "Unused" for multiple identity sources.

func (AuthorizerOutput) ProviderARNs 

func (o AuthorizerOutput) ProviderARNs() pulumi.StringArrayOutput

The ARNs of the Cognito User Pools to use.

func (AuthorizerOutput) ToAuthorizerOutput 

func (o AuthorizerOutput) ToAuthorizerOutput() AuthorizerOutput

func (AuthorizerOutput) ToAuthorizerOutputWithContext 

func (o AuthorizerOutput) ToAuthorizerOutputWithContext(ctx context.Context) AuthorizerOutput

func (AuthorizerOutput) Type 

func (o AuthorizerOutput) Type() pulumi.StringPtrOutput

The type of the authorizer. This value must be one of the following: - "token", for an authorizer with the caller identity embedded in an authorization token - "request", for an authorizer with the caller identity contained in request parameters

type IntegrationConnectionType 

type IntegrationConnectionType string

func (IntegrationConnectionType) ElementType 

func (IntegrationConnectionType) ElementType() reflect.Type

func (IntegrationConnectionType) ToIntegrationConnectionTypeOutput 

func (e IntegrationConnectionType) ToIntegrationConnectionTypeOutput() IntegrationConnectionTypeOutput

func (IntegrationConnectionType) ToIntegrationConnectionTypeOutputWithContext 

func (e IntegrationConnectionType) ToIntegrationConnectionTypeOutputWithContext(ctx context.Context) IntegrationConnectionTypeOutput

func (IntegrationConnectionType) ToIntegrationConnectionTypePtrOutput 

func (e IntegrationConnectionType) ToIntegrationConnectionTypePtrOutput() IntegrationConnectionTypePtrOutput

func (IntegrationConnectionType) ToIntegrationConnectionTypePtrOutputWithContext 

func (e IntegrationConnectionType) ToIntegrationConnectionTypePtrOutputWithContext(ctx context.Context) IntegrationConnectionTypePtrOutput

func (IntegrationConnectionType) ToStringOutput 

func (e IntegrationConnectionType) ToStringOutput() pulumi.StringOutput

func (IntegrationConnectionType) ToStringOutputWithContext 

func (e IntegrationConnectionType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (IntegrationConnectionType) ToStringPtrOutput 

func (e IntegrationConnectionType) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationConnectionType) ToStringPtrOutputWithContext 

func (e IntegrationConnectionType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IntegrationConnectionTypeInput 

type IntegrationConnectionTypeInput interface {
	pulumi.Input

	ToIntegrationConnectionTypeOutput() IntegrationConnectionTypeOutput
	ToIntegrationConnectionTypeOutputWithContext(context.Context) IntegrationConnectionTypeOutput
}

IntegrationConnectionTypeInput is an input type that accepts values of the IntegrationConnectionType enum A concrete instance of `IntegrationConnectionTypeInput` can be one of the following: 

IntegrationConnectionTypeINTERNET
IntegrationConnectionType_VPC_LINK

type IntegrationConnectionTypeOutput 

type IntegrationConnectionTypeOutput struct{ *pulumi.OutputState }

func (IntegrationConnectionTypeOutput) ElementType 

func (IntegrationConnectionTypeOutput) ElementType() reflect.Type

func (IntegrationConnectionTypeOutput) ToIntegrationConnectionTypeOutput 

func (o IntegrationConnectionTypeOutput) ToIntegrationConnectionTypeOutput() IntegrationConnectionTypeOutput

func (IntegrationConnectionTypeOutput) ToIntegrationConnectionTypeOutputWithContext 

func (o IntegrationConnectionTypeOutput) ToIntegrationConnectionTypeOutputWithContext(ctx context.Context) IntegrationConnectionTypeOutput

func (IntegrationConnectionTypeOutput) ToIntegrationConnectionTypePtrOutput 

func (o IntegrationConnectionTypeOutput) ToIntegrationConnectionTypePtrOutput() IntegrationConnectionTypePtrOutput

func (IntegrationConnectionTypeOutput) ToIntegrationConnectionTypePtrOutputWithContext 

func (o IntegrationConnectionTypeOutput) ToIntegrationConnectionTypePtrOutputWithContext(ctx context.Context) IntegrationConnectionTypePtrOutput

func (IntegrationConnectionTypeOutput) ToStringOutput 

func (o IntegrationConnectionTypeOutput) ToStringOutput() pulumi.StringOutput

func (IntegrationConnectionTypeOutput) ToStringOutputWithContext 

func (o IntegrationConnectionTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (IntegrationConnectionTypeOutput) ToStringPtrOutput 

func (o IntegrationConnectionTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationConnectionTypeOutput) ToStringPtrOutputWithContext 

func (o IntegrationConnectionTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IntegrationConnectionTypePtrInput 

type IntegrationConnectionTypePtrInput interface {
	pulumi.Input

	ToIntegrationConnectionTypePtrOutput() IntegrationConnectionTypePtrOutput
	ToIntegrationConnectionTypePtrOutputWithContext(context.Context) IntegrationConnectionTypePtrOutput
}

func IntegrationConnectionTypePtr 

func IntegrationConnectionTypePtr(v string) IntegrationConnectionTypePtrInput

type IntegrationConnectionTypePtrOutput 

type IntegrationConnectionTypePtrOutput struct{ *pulumi.OutputState }

func (IntegrationConnectionTypePtrOutput) Elem 

func (o IntegrationConnectionTypePtrOutput) Elem() IntegrationConnectionTypeOutput

func (IntegrationConnectionTypePtrOutput) ElementType 

func (IntegrationConnectionTypePtrOutput) ElementType() reflect.Type

func (IntegrationConnectionTypePtrOutput) ToIntegrationConnectionTypePtrOutput 

func (o IntegrationConnectionTypePtrOutput) ToIntegrationConnectionTypePtrOutput() IntegrationConnectionTypePtrOutput

func (IntegrationConnectionTypePtrOutput) ToIntegrationConnectionTypePtrOutputWithContext 

func (o IntegrationConnectionTypePtrOutput) ToIntegrationConnectionTypePtrOutputWithContext(ctx context.Context) IntegrationConnectionTypePtrOutput

func (IntegrationConnectionTypePtrOutput) ToStringPtrOutput 

func (o IntegrationConnectionTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationConnectionTypePtrOutput) ToStringPtrOutputWithContext 

func (o IntegrationConnectionTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IntegrationPassthroughBehavior 

type IntegrationPassthroughBehavior string

func (IntegrationPassthroughBehavior) ElementType 

func (IntegrationPassthroughBehavior) ElementType() reflect.Type

func (IntegrationPassthroughBehavior) ToIntegrationPassthroughBehaviorOutput 

func (e IntegrationPassthroughBehavior) ToIntegrationPassthroughBehaviorOutput() IntegrationPassthroughBehaviorOutput

func (IntegrationPassthroughBehavior) ToIntegrationPassthroughBehaviorOutputWithContext 

func (e IntegrationPassthroughBehavior) ToIntegrationPassthroughBehaviorOutputWithContext(ctx context.Context) IntegrationPassthroughBehaviorOutput

func (IntegrationPassthroughBehavior) ToIntegrationPassthroughBehaviorPtrOutput 

func (e IntegrationPassthroughBehavior) ToIntegrationPassthroughBehaviorPtrOutput() IntegrationPassthroughBehaviorPtrOutput

func (IntegrationPassthroughBehavior) ToIntegrationPassthroughBehaviorPtrOutputWithContext 

func (e IntegrationPassthroughBehavior) ToIntegrationPassthroughBehaviorPtrOutputWithContext(ctx context.Context) IntegrationPassthroughBehaviorPtrOutput

func (IntegrationPassthroughBehavior) ToStringOutput 

func (e IntegrationPassthroughBehavior) ToStringOutput() pulumi.StringOutput

func (IntegrationPassthroughBehavior) ToStringOutputWithContext 

func (e IntegrationPassthroughBehavior) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (IntegrationPassthroughBehavior) ToStringPtrOutput 

func (e IntegrationPassthroughBehavior) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationPassthroughBehavior) ToStringPtrOutputWithContext 

func (e IntegrationPassthroughBehavior) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IntegrationPassthroughBehaviorInput 

type IntegrationPassthroughBehaviorInput interface {
	pulumi.Input

	ToIntegrationPassthroughBehaviorOutput() IntegrationPassthroughBehaviorOutput
	ToIntegrationPassthroughBehaviorOutputWithContext(context.Context) IntegrationPassthroughBehaviorOutput
}

IntegrationPassthroughBehaviorInput is an input type that accepts values of the IntegrationPassthroughBehavior enum A concrete instance of `IntegrationPassthroughBehaviorInput` can be one of the following: 

IntegrationPassthroughBehavior_When_no_match
IntegrationPassthroughBehavior_When_no_templates
IntegrationPassthroughBehaviorNever

type IntegrationPassthroughBehaviorOutput 

type IntegrationPassthroughBehaviorOutput struct{ *pulumi.OutputState }

func (IntegrationPassthroughBehaviorOutput) ElementType 

func (IntegrationPassthroughBehaviorOutput) ElementType() reflect.Type

func (IntegrationPassthroughBehaviorOutput) ToIntegrationPassthroughBehaviorOutput 

func (o IntegrationPassthroughBehaviorOutput) ToIntegrationPassthroughBehaviorOutput() IntegrationPassthroughBehaviorOutput

func (IntegrationPassthroughBehaviorOutput) ToIntegrationPassthroughBehaviorOutputWithContext 

func (o IntegrationPassthroughBehaviorOutput) ToIntegrationPassthroughBehaviorOutputWithContext(ctx context.Context) IntegrationPassthroughBehaviorOutput

func (IntegrationPassthroughBehaviorOutput) ToIntegrationPassthroughBehaviorPtrOutput 

func (o IntegrationPassthroughBehaviorOutput) ToIntegrationPassthroughBehaviorPtrOutput() IntegrationPassthroughBehaviorPtrOutput

func (IntegrationPassthroughBehaviorOutput) ToIntegrationPassthroughBehaviorPtrOutputWithContext 

func (o IntegrationPassthroughBehaviorOutput) ToIntegrationPassthroughBehaviorPtrOutputWithContext(ctx context.Context) IntegrationPassthroughBehaviorPtrOutput

func (IntegrationPassthroughBehaviorOutput) ToStringOutput 

func (o IntegrationPassthroughBehaviorOutput) ToStringOutput() pulumi.StringOutput

func (IntegrationPassthroughBehaviorOutput) ToStringOutputWithContext 

func (o IntegrationPassthroughBehaviorOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (IntegrationPassthroughBehaviorOutput) ToStringPtrOutput 

func (o IntegrationPassthroughBehaviorOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationPassthroughBehaviorOutput) ToStringPtrOutputWithContext 

func (o IntegrationPassthroughBehaviorOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IntegrationPassthroughBehaviorPtrInput 

type IntegrationPassthroughBehaviorPtrInput interface {
	pulumi.Input

	ToIntegrationPassthroughBehaviorPtrOutput() IntegrationPassthroughBehaviorPtrOutput
	ToIntegrationPassthroughBehaviorPtrOutputWithContext(context.Context) IntegrationPassthroughBehaviorPtrOutput
}

func IntegrationPassthroughBehaviorPtr 

func IntegrationPassthroughBehaviorPtr(v string) IntegrationPassthroughBehaviorPtrInput

type IntegrationPassthroughBehaviorPtrOutput 

type IntegrationPassthroughBehaviorPtrOutput struct{ *pulumi.OutputState }

func (IntegrationPassthroughBehaviorPtrOutput) Elem 

func (o IntegrationPassthroughBehaviorPtrOutput) Elem() IntegrationPassthroughBehaviorOutput

func (IntegrationPassthroughBehaviorPtrOutput) ElementType 

func (IntegrationPassthroughBehaviorPtrOutput) ElementType() reflect.Type

func (IntegrationPassthroughBehaviorPtrOutput) ToIntegrationPassthroughBehaviorPtrOutput 

func (o IntegrationPassthroughBehaviorPtrOutput) ToIntegrationPassthroughBehaviorPtrOutput() IntegrationPassthroughBehaviorPtrOutput

func (IntegrationPassthroughBehaviorPtrOutput) ToIntegrationPassthroughBehaviorPtrOutputWithContext 

func (o IntegrationPassthroughBehaviorPtrOutput) ToIntegrationPassthroughBehaviorPtrOutputWithContext(ctx context.Context) IntegrationPassthroughBehaviorPtrOutput

func (IntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutput 

func (o IntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutputWithContext 

func (o IntegrationPassthroughBehaviorPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IntegrationType 

type IntegrationType string

func (IntegrationType) ElementType 

func (IntegrationType) ElementType() reflect.Type

func (IntegrationType) ToIntegrationTypeOutput 

func (e IntegrationType) ToIntegrationTypeOutput() IntegrationTypeOutput

func (IntegrationType) ToIntegrationTypeOutputWithContext 

func (e IntegrationType) ToIntegrationTypeOutputWithContext(ctx context.Context) IntegrationTypeOutput

func (IntegrationType) ToIntegrationTypePtrOutput 

func (e IntegrationType) ToIntegrationTypePtrOutput() IntegrationTypePtrOutput

func (IntegrationType) ToIntegrationTypePtrOutputWithContext 

func (e IntegrationType) ToIntegrationTypePtrOutputWithContext(ctx context.Context) IntegrationTypePtrOutput

func (IntegrationType) ToStringOutput 

func (e IntegrationType) ToStringOutput() pulumi.StringOutput

func (IntegrationType) ToStringOutputWithContext 

func (e IntegrationType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (IntegrationType) ToStringPtrOutput 

func (e IntegrationType) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationType) ToStringPtrOutputWithContext 

func (e IntegrationType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IntegrationTypeInput 

type IntegrationTypeInput interface {
	pulumi.Input

	ToIntegrationTypeOutput() IntegrationTypeOutput
	ToIntegrationTypeOutputWithContext(context.Context) IntegrationTypeOutput
}

IntegrationTypeInput is an input type that accepts values of the IntegrationType enum A concrete instance of `IntegrationTypeInput` can be one of the following: 

IntegrationTypeAws
IntegrationType_Aws_proxy
IntegrationTypeHttp
IntegrationType_Http_proxy
IntegrationTypeMock

type IntegrationTypeOutput 

type IntegrationTypeOutput struct{ *pulumi.OutputState }

func (IntegrationTypeOutput) ElementType 

func (IntegrationTypeOutput) ElementType() reflect.Type

func (IntegrationTypeOutput) ToIntegrationTypeOutput 

func (o IntegrationTypeOutput) ToIntegrationTypeOutput() IntegrationTypeOutput

func (IntegrationTypeOutput) ToIntegrationTypeOutputWithContext 

func (o IntegrationTypeOutput) ToIntegrationTypeOutputWithContext(ctx context.Context) IntegrationTypeOutput

func (IntegrationTypeOutput) ToIntegrationTypePtrOutput 

func (o IntegrationTypeOutput) ToIntegrationTypePtrOutput() IntegrationTypePtrOutput

func (IntegrationTypeOutput) ToIntegrationTypePtrOutputWithContext 

func (o IntegrationTypeOutput) ToIntegrationTypePtrOutputWithContext(ctx context.Context) IntegrationTypePtrOutput

func (IntegrationTypeOutput) ToStringOutput 

func (o IntegrationTypeOutput) ToStringOutput() pulumi.StringOutput

func (IntegrationTypeOutput) ToStringOutputWithContext 

func (o IntegrationTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (IntegrationTypeOutput) ToStringPtrOutput 

func (o IntegrationTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationTypeOutput) ToStringPtrOutputWithContext 

func (o IntegrationTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IntegrationTypePtrInput 

type IntegrationTypePtrInput interface {
	pulumi.Input

	ToIntegrationTypePtrOutput() IntegrationTypePtrOutput
	ToIntegrationTypePtrOutputWithContext(context.Context) IntegrationTypePtrOutput
}

func IntegrationTypePtr 

func IntegrationTypePtr(v string) IntegrationTypePtrInput

type IntegrationTypePtrOutput 

type IntegrationTypePtrOutput struct{ *pulumi.OutputState }

func (IntegrationTypePtrOutput) Elem 

func (o IntegrationTypePtrOutput) Elem() IntegrationTypeOutput

func (IntegrationTypePtrOutput) ElementType 

func (IntegrationTypePtrOutput) ElementType() reflect.Type

func (IntegrationTypePtrOutput) ToIntegrationTypePtrOutput 

func (o IntegrationTypePtrOutput) ToIntegrationTypePtrOutput() IntegrationTypePtrOutput

func (IntegrationTypePtrOutput) ToIntegrationTypePtrOutputWithContext 

func (o IntegrationTypePtrOutput) ToIntegrationTypePtrOutputWithContext(ctx context.Context) IntegrationTypePtrOutput

func (IntegrationTypePtrOutput) ToStringPtrOutput 

func (o IntegrationTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (IntegrationTypePtrOutput) ToStringPtrOutputWithContext 

func (o IntegrationTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Method 

type Method string

func (Method) ElementType 

func (Method) ElementType() reflect.Type

func (Method) ToMethodOutput 

func (e Method) ToMethodOutput() MethodOutput

func (Method) ToMethodOutputWithContext 

func (e Method) ToMethodOutputWithContext(ctx context.Context) MethodOutput

func (Method) ToMethodPtrOutput 

func (e Method) ToMethodPtrOutput() MethodPtrOutput

func (Method) ToMethodPtrOutputWithContext 

func (e Method) ToMethodPtrOutputWithContext(ctx context.Context) MethodPtrOutput

func (Method) ToStringOutput 

func (e Method) ToStringOutput() pulumi.StringOutput

func (Method) ToStringOutputWithContext 

func (e Method) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (Method) ToStringPtrOutput 

func (e Method) ToStringPtrOutput() pulumi.StringPtrOutput

func (Method) ToStringPtrOutputWithContext 

func (e Method) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodInput 

type MethodInput interface {
	pulumi.Input

	ToMethodOutput() MethodOutput
	ToMethodOutputWithContext(context.Context) MethodOutput
}

MethodInput is an input type that accepts values of the Method enum A concrete instance of `MethodInput` can be one of the following: 

MethodANY
MethodGET
MethodPUT
MethodPOST
MethodDELETE
MethodPATCH
MethodOPTIONS
MethodHEAD

type MethodOutput 

type MethodOutput struct{ *pulumi.OutputState }

func (MethodOutput) ElementType 

func (MethodOutput) ElementType() reflect.Type

func (MethodOutput) ToMethodOutput 

func (o MethodOutput) ToMethodOutput() MethodOutput

func (MethodOutput) ToMethodOutputWithContext 

func (o MethodOutput) ToMethodOutputWithContext(ctx context.Context) MethodOutput

func (MethodOutput) ToMethodPtrOutput 

func (o MethodOutput) ToMethodPtrOutput() MethodPtrOutput

func (MethodOutput) ToMethodPtrOutputWithContext 

func (o MethodOutput) ToMethodPtrOutputWithContext(ctx context.Context) MethodPtrOutput

func (MethodOutput) ToStringOutput 

func (o MethodOutput) ToStringOutput() pulumi.StringOutput

func (MethodOutput) ToStringOutputWithContext 

func (o MethodOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (MethodOutput) ToStringPtrOutput 

func (o MethodOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodOutput) ToStringPtrOutputWithContext 

func (o MethodOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type MethodPtrInput 

type MethodPtrInput interface {
	pulumi.Input

	ToMethodPtrOutput() MethodPtrOutput
	ToMethodPtrOutputWithContext(context.Context) MethodPtrOutput
}

func MethodPtr 

func MethodPtr(v string) MethodPtrInput

type MethodPtrOutput 

type MethodPtrOutput struct{ *pulumi.OutputState }

func (MethodPtrOutput) Elem 

func (o MethodPtrOutput) Elem() MethodOutput

func (MethodPtrOutput) ElementType 

func (MethodPtrOutput) ElementType() reflect.Type

func (MethodPtrOutput) ToMethodPtrOutput 

func (o MethodPtrOutput) ToMethodPtrOutput() MethodPtrOutput

func (MethodPtrOutput) ToMethodPtrOutputWithContext 

func (o MethodPtrOutput) ToMethodPtrOutputWithContext(ctx context.Context) MethodPtrOutput

func (MethodPtrOutput) ToStringPtrOutput 

func (o MethodPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (MethodPtrOutput) ToStringPtrOutputWithContext 

func (o MethodPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Provider 

type Provider struct {
	pulumi.ProviderResourceState
}

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

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

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs 

type ProviderArgs struct {
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type RequestValidator 

type RequestValidator string

func (RequestValidator) ElementType 

func (RequestValidator) ElementType() reflect.Type

func (RequestValidator) ToRequestValidatorOutput 

func (e RequestValidator) ToRequestValidatorOutput() RequestValidatorOutput

func (RequestValidator) ToRequestValidatorOutputWithContext 

func (e RequestValidator) ToRequestValidatorOutputWithContext(ctx context.Context) RequestValidatorOutput

func (RequestValidator) ToRequestValidatorPtrOutput 

func (e RequestValidator) ToRequestValidatorPtrOutput() RequestValidatorPtrOutput

func (RequestValidator) ToRequestValidatorPtrOutputWithContext 

func (e RequestValidator) ToRequestValidatorPtrOutputWithContext(ctx context.Context) RequestValidatorPtrOutput

func (RequestValidator) ToStringOutput 

func (e RequestValidator) ToStringOutput() pulumi.StringOutput

func (RequestValidator) ToStringOutputWithContext 

func (e RequestValidator) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RequestValidator) ToStringPtrOutput 

func (e RequestValidator) ToStringPtrOutput() pulumi.StringPtrOutput

func (RequestValidator) ToStringPtrOutputWithContext 

func (e RequestValidator) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RequestValidatorInput 

type RequestValidatorInput interface {
	pulumi.Input

	ToRequestValidatorOutput() RequestValidatorOutput
	ToRequestValidatorOutputWithContext(context.Context) RequestValidatorOutput
}

RequestValidatorInput is an input type that accepts values of the RequestValidator enum A concrete instance of `RequestValidatorInput` can be one of the following: 

RequestValidatorALL
RequestValidator_PARAMS_ONLY
RequestValidator_BODY_ONLY

type RequestValidatorOutput 

type RequestValidatorOutput struct{ *pulumi.OutputState }

func (RequestValidatorOutput) ElementType 

func (RequestValidatorOutput) ElementType() reflect.Type

func (RequestValidatorOutput) ToRequestValidatorOutput 

func (o RequestValidatorOutput) ToRequestValidatorOutput() RequestValidatorOutput

func (RequestValidatorOutput) ToRequestValidatorOutputWithContext 

func (o RequestValidatorOutput) ToRequestValidatorOutputWithContext(ctx context.Context) RequestValidatorOutput

func (RequestValidatorOutput) ToRequestValidatorPtrOutput 

func (o RequestValidatorOutput) ToRequestValidatorPtrOutput() RequestValidatorPtrOutput

func (RequestValidatorOutput) ToRequestValidatorPtrOutputWithContext 

func (o RequestValidatorOutput) ToRequestValidatorPtrOutputWithContext(ctx context.Context) RequestValidatorPtrOutput

func (RequestValidatorOutput) ToStringOutput 

func (o RequestValidatorOutput) ToStringOutput() pulumi.StringOutput

func (RequestValidatorOutput) ToStringOutputWithContext 

func (o RequestValidatorOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RequestValidatorOutput) ToStringPtrOutput 

func (o RequestValidatorOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RequestValidatorOutput) ToStringPtrOutputWithContext 

func (o RequestValidatorOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RequestValidatorPtrInput 

type RequestValidatorPtrInput interface {
	pulumi.Input

	ToRequestValidatorPtrOutput() RequestValidatorPtrOutput
	ToRequestValidatorPtrOutputWithContext(context.Context) RequestValidatorPtrOutput
}

func RequestValidatorPtr 

func RequestValidatorPtr(v string) RequestValidatorPtrInput

type RequestValidatorPtrOutput 

type RequestValidatorPtrOutput struct{ *pulumi.OutputState }

func (RequestValidatorPtrOutput) Elem 

func (o RequestValidatorPtrOutput) Elem() RequestValidatorOutput

func (RequestValidatorPtrOutput) ElementType 

func (RequestValidatorPtrOutput) ElementType() reflect.Type

func (RequestValidatorPtrOutput) ToRequestValidatorPtrOutput 

func (o RequestValidatorPtrOutput) ToRequestValidatorPtrOutput() RequestValidatorPtrOutput

func (RequestValidatorPtrOutput) ToRequestValidatorPtrOutputWithContext 

func (o RequestValidatorPtrOutput) ToRequestValidatorPtrOutputWithContext(ctx context.Context) RequestValidatorPtrOutput

func (RequestValidatorPtrOutput) ToStringPtrOutput 

func (o RequestValidatorPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RequestValidatorPtrOutput) ToStringPtrOutputWithContext 

func (o RequestValidatorPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RequiredParameter 

type RequiredParameter struct {
	In   *string `pulumi:"in"`
	Name *string `pulumi:"name"`
}

type RequiredParameterArgs 

type RequiredParameterArgs struct {
	In   pulumi.StringPtrInput `pulumi:"in"`
	Name pulumi.StringPtrInput `pulumi:"name"`
}

func (RequiredParameterArgs) ElementType 

func (RequiredParameterArgs) ElementType() reflect.Type

func (RequiredParameterArgs) ToRequiredParameterOutput 

func (i RequiredParameterArgs) ToRequiredParameterOutput() RequiredParameterOutput

func (RequiredParameterArgs) ToRequiredParameterOutputWithContext 

func (i RequiredParameterArgs) ToRequiredParameterOutputWithContext(ctx context.Context) RequiredParameterOutput

type RequiredParameterArray 

type RequiredParameterArray []RequiredParameterInput

func (RequiredParameterArray) ElementType 

func (RequiredParameterArray) ElementType() reflect.Type

func (RequiredParameterArray) ToRequiredParameterArrayOutput 

func (i RequiredParameterArray) ToRequiredParameterArrayOutput() RequiredParameterArrayOutput

func (RequiredParameterArray) ToRequiredParameterArrayOutputWithContext 

func (i RequiredParameterArray) ToRequiredParameterArrayOutputWithContext(ctx context.Context) RequiredParameterArrayOutput

type RequiredParameterArrayInput 

type RequiredParameterArrayInput interface {
	pulumi.Input

	ToRequiredParameterArrayOutput() RequiredParameterArrayOutput
	ToRequiredParameterArrayOutputWithContext(context.Context) RequiredParameterArrayOutput
}

RequiredParameterArrayInput is an input type that accepts RequiredParameterArray and RequiredParameterArrayOutput values. You can construct a concrete instance of `RequiredParameterArrayInput` via: 

RequiredParameterArray{ RequiredParameterArgs{...} }

type RequiredParameterArrayOutput 

type RequiredParameterArrayOutput struct{ *pulumi.OutputState }

func (RequiredParameterArrayOutput) ElementType 

func (RequiredParameterArrayOutput) ElementType() reflect.Type

func (RequiredParameterArrayOutput) Index 

func (o RequiredParameterArrayOutput) Index(i pulumi.IntInput) RequiredParameterOutput

func (RequiredParameterArrayOutput) ToRequiredParameterArrayOutput 

func (o RequiredParameterArrayOutput) ToRequiredParameterArrayOutput() RequiredParameterArrayOutput

func (RequiredParameterArrayOutput) ToRequiredParameterArrayOutputWithContext 

func (o RequiredParameterArrayOutput) ToRequiredParameterArrayOutputWithContext(ctx context.Context) RequiredParameterArrayOutput

type RequiredParameterInput 

type RequiredParameterInput interface {
	pulumi.Input

	ToRequiredParameterOutput() RequiredParameterOutput
	ToRequiredParameterOutputWithContext(context.Context) RequiredParameterOutput
}

RequiredParameterInput is an input type that accepts RequiredParameterArgs and RequiredParameterOutput values. You can construct a concrete instance of `RequiredParameterInput` via: 

RequiredParameterArgs{...}

type RequiredParameterOutput 

type RequiredParameterOutput struct{ *pulumi.OutputState }

func (RequiredParameterOutput) ElementType 

func (RequiredParameterOutput) ElementType() reflect.Type

func (RequiredParameterOutput) In 

func (o RequiredParameterOutput) In() pulumi.StringPtrOutput

func (RequiredParameterOutput) Name 

func (o RequiredParameterOutput) Name() pulumi.StringPtrOutput

func (RequiredParameterOutput) ToRequiredParameterOutput 

func (o RequiredParameterOutput) ToRequiredParameterOutput() RequiredParameterOutput

func (RequiredParameterOutput) ToRequiredParameterOutputWithContext 

func (o RequiredParameterOutput) ToRequiredParameterOutputWithContext(ctx context.Context) RequiredParameterOutput

type RestAPI 

type RestAPI struct {
	pulumi.ResourceState

	// The underlying RestAPI resource.
	Api apigateway.RestApiOutput `pulumi:"api"`
	// The underlying RestAPIPolicy resource.
	ApiPolicy apigateway.RestApiPolicyOutput `pulumi:"apiPolicy"`
	// The underlying Deployment resource.
	Deployment apigateway.DeploymentOutput `pulumi:"deployment"`
	// The underlying Stage resource.
	Stage apigateway.StageOutput `pulumi:"stage"`
	// The URL where the Rest API is exposed.
	Url pulumi.StringOutput `pulumi:"url"`
}

The RestAPI component offers a simple interface for creating a fully functional API Gateway REST API. The REST API can define any number of routes, each of which maps a path and HTTP method to one of (1) an event hander route that invokes a Lambda Function (2) a local path route which uploads local files into an S3 bucket and serves them or (3) an integration target such as an HTTP proxy or service integration.

func NewRestAPI 

func NewRestAPI(ctx *pulumi.Context,
	name string, args *RestAPIArgs, opts ...pulumi.ResourceOption) (*RestAPI, error)

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

func (*RestAPI) ElementType 

func (*RestAPI) ElementType() reflect.Type

func (*RestAPI) ToRestAPIOutput 

func (i *RestAPI) ToRestAPIOutput() RestAPIOutput

func (*RestAPI) ToRestAPIOutputWithContext 

func (i *RestAPI) ToRestAPIOutputWithContext(ctx context.Context) RestAPIOutput

type RestAPIArgs 

type RestAPIArgs struct {
	// The source for the apikey. This can either be a HEADER or AUTHORIZER. If `apiKeyRequired` is
	// set to true on a route, and this is not defined the value will default to HEADER.
	ApiKeySource *APIKeySource
	// List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads.
	// If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-binary-media-types extension.
	// If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
	BinaryMediaTypes []pulumi.StringInput
	// Description of the REST API.
	Description pulumi.StringPtrInput
	// Whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke
	// your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
	// clients use a custom domain name to invoke your API, disable the default endpoint. Defaults to false.
	DisableExecuteApiEndpoint pulumi.BoolPtrInput
	// Define custom gateway responses for the API. This can be used to properly enable
	// CORS for Lambda Authorizers.
	GatewayResponses map[string]SwaggerGatewayResponseInput
	// Request Validator specifies the validator to use at the API level. Note method level validators
	// override this.
	RequestValidator *RequestValidator
	// Routes to use to initialize the APIGateway.  These will be used to create the Swagger
	// specification for the API.
	//
	// Either `swaggerString` or `routes` must be specified.
	Routes []RouteArgs
	// The stage name for your API. This will get added as a base path to your API url.
	StageName pulumi.StringPtrInput
	// Bucket to use for placing resources for static resources.  If not provided a default one will
	// be created on your behalf if any `StaticRoute`s are provided.
	StaticRoutesBucket s3.BucketInput
	// A Swagger specification already in string form to use to initialize the APIGateway.  Note
	// that you must manually provide permission for any route targets to be invoked by API Gateway
	// when using `swaggerString`.
	//
	// Either `swaggerString` or `routes` must be specified.
	SwaggerString pulumi.StringPtrInput
	// 'Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present,
	// tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a RestAPI resource.

func (RestAPIArgs) ElementType 

func (RestAPIArgs) ElementType() reflect.Type

type RestAPIInput 

type RestAPIInput interface {
	pulumi.Input

	ToRestAPIOutput() RestAPIOutput
	ToRestAPIOutputWithContext(ctx context.Context) RestAPIOutput
}

type RestAPIOutput 

type RestAPIOutput struct{ *pulumi.OutputState }

func (RestAPIOutput) Api 

func (o RestAPIOutput) Api() apigateway.RestApiOutput

The underlying RestAPI resource.

func (RestAPIOutput) ApiPolicy 

func (o RestAPIOutput) ApiPolicy() apigateway.RestApiPolicyOutput

The underlying RestAPIPolicy resource.

func (RestAPIOutput) Deployment 

func (o RestAPIOutput) Deployment() apigateway.DeploymentOutput

The underlying Deployment resource.

func (RestAPIOutput) ElementType 

func (RestAPIOutput) ElementType() reflect.Type

func (RestAPIOutput) Stage 

func (o RestAPIOutput) Stage() apigateway.StageOutput

The underlying Stage resource.

func (RestAPIOutput) ToRestAPIOutput 

func (o RestAPIOutput) ToRestAPIOutput() RestAPIOutput

func (RestAPIOutput) ToRestAPIOutputWithContext 

func (o RestAPIOutput) ToRestAPIOutputWithContext(ctx context.Context) RestAPIOutput

func (RestAPIOutput) Url 

func (o RestAPIOutput) Url() pulumi.StringOutput

The URL where the Rest API is exposed.

type Route 

type Route struct {
	// If true, an API key will be required for this route. The source for the API Key can be set at
	// the API level and by default, the source will be the HEADER.
	ApiKeyRequired *bool `pulumi:"apiKeyRequired"`
	// Authorizers allows you to define Lambda authorizers be applied for authorization when the
	// the route is called.
	Authorizers []Authorizer `pulumi:"authorizers"`
	// The `content-type` to serve the file as.  Only valid when `localPath` points to a file.  If
	// `localPath` points to a directory, the content types for all files will be inferred.
	ContentType *string `pulumi:"contentType"`
	// A raw Swagger object to include verbatim in the integration for this path.
	Data interface{} `pulumi:"data"`
	// A Lambda function which will handle the route for the given path and method.
	EventHandler *lambda.Function `pulumi:"eventHandler"`
	// By default, the route method auth type is set to `NONE`. If true, the auth type will be
	// set to `AWS_IAM`.
	IamAuthEnabled *bool `pulumi:"iamAuthEnabled"`
	// By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory.
	// To disable this pass `false` or supply a new index document name.
	Index interface{} `pulumi:"index"`
	// The local path on disk to create static S3 resources for.  Files will be uploaded into S3
	// objects, and directories will be recursively walked into.
	LocalPath *string `pulumi:"localPath"`
	// The REST method of the route to match.  Only valid with `eventHandler` or `data` routes.
	Method *Method `pulumi:"method"`
	// The path on the API that will serve this route.  If not prefixed with `/`,
	// then a `/` will be added automatically to the beginning.
	Path string `pulumi:"path"`
	// Request Validator specifies the validator to use at the method level. This will override anything
	// defined at the API level.
	RequestValidator *RequestValidator `pulumi:"requestValidator"`
	// Required Parameters to validate. If the request validator is set to ALL or PARAMS_ONLY, api
	// gateway will validate these before sending traffic to the event handler.
	RequiredParameters []RequiredParameter `pulumi:"requiredParameters"`
	// The target for an integration route (see https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-integration-types.html).
	Target *Target `pulumi:"target"`
}

A route that that APIGateway should accept and forward to some type of destination. All routes have an incoming path that they match against. However, destinations are determined by the kind of the route.

type RouteArgs 

type RouteArgs struct {
	// If true, an API key will be required for this route. The source for the API Key can be set at
	// the API level and by default, the source will be the HEADER.
	ApiKeyRequired *bool `pulumi:"apiKeyRequired"`
	// Authorizers allows you to define Lambda authorizers be applied for authorization when the
	// the route is called.
	Authorizers []AuthorizerArgs `pulumi:"authorizers"`
	// The `content-type` to serve the file as.  Only valid when `localPath` points to a file.  If
	// `localPath` points to a directory, the content types for all files will be inferred.
	ContentType *string `pulumi:"contentType"`
	// A raw Swagger object to include verbatim in the integration for this path.
	Data interface{} `pulumi:"data"`
	// A Lambda function which will handle the route for the given path and method.
	EventHandler lambda.FunctionInput `pulumi:"eventHandler"`
	// By default, the route method auth type is set to `NONE`. If true, the auth type will be
	// set to `AWS_IAM`.
	IamAuthEnabled *bool `pulumi:"iamAuthEnabled"`
	// By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory.
	// To disable this pass `false` or supply a new index document name.
	Index interface{} `pulumi:"index"`
	// The local path on disk to create static S3 resources for.  Files will be uploaded into S3
	// objects, and directories will be recursively walked into.
	LocalPath *string `pulumi:"localPath"`
	// The REST method of the route to match.  Only valid with `eventHandler` or `data` routes.
	Method *Method `pulumi:"method"`
	// The path on the API that will serve this route.  If not prefixed with `/`,
	// then a `/` will be added automatically to the beginning.
	Path string `pulumi:"path"`
	// Request Validator specifies the validator to use at the method level. This will override anything
	// defined at the API level.
	RequestValidator *RequestValidator `pulumi:"requestValidator"`
	// Required Parameters to validate. If the request validator is set to ALL or PARAMS_ONLY, api
	// gateway will validate these before sending traffic to the event handler.
	RequiredParameters []RequiredParameterArgs `pulumi:"requiredParameters"`
	// The target for an integration route (see https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-integration-types.html).
	Target TargetPtrInput `pulumi:"target"`
}

A route that that APIGateway should accept and forward to some type of destination. All routes have an incoming path that they match against. However, destinations are determined by the kind of the route.

func (RouteArgs) ElementType 

func (RouteArgs) ElementType() reflect.Type

func (RouteArgs) ToRouteOutput 

func (i RouteArgs) ToRouteOutput() RouteOutput

func (RouteArgs) ToRouteOutputWithContext 

func (i RouteArgs) ToRouteOutputWithContext(ctx context.Context) RouteOutput

type RouteArray 

type RouteArray []RouteInput

func (RouteArray) ElementType 

func (RouteArray) ElementType() reflect.Type

func (RouteArray) ToRouteArrayOutput 

func (i RouteArray) ToRouteArrayOutput() RouteArrayOutput

func (RouteArray) ToRouteArrayOutputWithContext 

func (i RouteArray) ToRouteArrayOutputWithContext(ctx context.Context) RouteArrayOutput

type RouteArrayInput 

type RouteArrayInput interface {
	pulumi.Input

	ToRouteArrayOutput() RouteArrayOutput
	ToRouteArrayOutputWithContext(context.Context) RouteArrayOutput
}

RouteArrayInput is an input type that accepts RouteArray and RouteArrayOutput values. You can construct a concrete instance of `RouteArrayInput` via: 

RouteArray{ RouteArgs{...} }

type RouteArrayOutput 

type RouteArrayOutput struct{ *pulumi.OutputState }

func (RouteArrayOutput) ElementType 

func (RouteArrayOutput) ElementType() reflect.Type

func (RouteArrayOutput) Index 

func (o RouteArrayOutput) Index(i pulumi.IntInput) RouteOutput

func (RouteArrayOutput) ToRouteArrayOutput 

func (o RouteArrayOutput) ToRouteArrayOutput() RouteArrayOutput

func (RouteArrayOutput) ToRouteArrayOutputWithContext 

func (o RouteArrayOutput) ToRouteArrayOutputWithContext(ctx context.Context) RouteArrayOutput

type RouteInput 

type RouteInput interface {
	pulumi.Input

	ToRouteOutput() RouteOutput
	ToRouteOutputWithContext(context.Context) RouteOutput
}

RouteInput is an input type that accepts RouteArgs and RouteOutput values. You can construct a concrete instance of `RouteInput` via: 

RouteArgs{...}

type RouteOutput 

type RouteOutput struct{ *pulumi.OutputState }

A route that that APIGateway should accept and forward to some type of destination. All routes have an incoming path that they match against. However, destinations are determined by the kind of the route.

func (RouteOutput) ApiKeyRequired 

func (o RouteOutput) ApiKeyRequired() pulumi.BoolPtrOutput

If true, an API key will be required for this route. The source for the API Key can be set at the API level and by default, the source will be the HEADER.

func (RouteOutput) Authorizers 

func (o RouteOutput) Authorizers() AuthorizerArrayOutput

Authorizers allows you to define Lambda authorizers be applied for authorization when the the route is called.

func (RouteOutput) ContentType 

func (o RouteOutput) ContentType() pulumi.StringPtrOutput

The `content-type` to serve the file as. Only valid when `localPath` points to a file. If `localPath` points to a directory, the content types for all files will be inferred.

func (RouteOutput) Data 

func (o RouteOutput) Data() pulumi.AnyOutput

A raw Swagger object to include verbatim in the integration for this path.

func (RouteOutput) ElementType 

func (RouteOutput) ElementType() reflect.Type

func (RouteOutput) EventHandler 

func (o RouteOutput) EventHandler() lambda.FunctionOutput

A Lambda function which will handle the route for the given path and method.

func (RouteOutput) IamAuthEnabled 

func (o RouteOutput) IamAuthEnabled() pulumi.BoolPtrOutput

By default, the route method auth type is set to `NONE`. If true, the auth type will be set to `AWS_IAM`.

func (RouteOutput) Index 

func (o RouteOutput) Index() pulumi.AnyOutput

By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory. To disable this pass `false` or supply a new index document name.

func (RouteOutput) LocalPath 

func (o RouteOutput) LocalPath() pulumi.StringPtrOutput

The local path on disk to create static S3 resources for. Files will be uploaded into S3 objects, and directories will be recursively walked into.

func (RouteOutput) Method 

func (o RouteOutput) Method() MethodPtrOutput

The REST method of the route to match. Only valid with `eventHandler` or `data` routes.

func (RouteOutput) Path 

func (o RouteOutput) Path() pulumi.StringOutput

The path on the API that will serve this route. If not prefixed with `/`, then a `/` will be added automatically to the beginning.

func (RouteOutput) RequestValidator 

func (o RouteOutput) RequestValidator() RequestValidatorPtrOutput

Request Validator specifies the validator to use at the method level. This will override anything defined at the API level.

func (RouteOutput) RequiredParameters 

func (o RouteOutput) RequiredParameters() RequiredParameterArrayOutput

Required Parameters to validate. If the request validator is set to ALL or PARAMS_ONLY, api gateway will validate these before sending traffic to the event handler.

func (RouteOutput) Target 

func (o RouteOutput) Target() TargetPtrOutput

The target for an integration route (see https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-integration-types.html).

func (RouteOutput) ToRouteOutput 

func (o RouteOutput) ToRouteOutput() RouteOutput

func (RouteOutput) ToRouteOutputWithContext 

func (o RouteOutput) ToRouteOutputWithContext(ctx context.Context) RouteOutput

type SwaggerGatewayResponse 

type SwaggerGatewayResponse struct {
	ResponseParameters map[string]string `pulumi:"responseParameters"`
	ResponseTemplates  map[string]string `pulumi:"responseTemplates"`
	StatusCode         *float64          `pulumi:"statusCode"`
}

type SwaggerGatewayResponseArgs 

type SwaggerGatewayResponseArgs struct {
	ResponseParameters pulumi.StringMapInput  `pulumi:"responseParameters"`
	ResponseTemplates  pulumi.StringMapInput  `pulumi:"responseTemplates"`
	StatusCode         pulumi.Float64PtrInput `pulumi:"statusCode"`
}

func (SwaggerGatewayResponseArgs) ElementType 

func (SwaggerGatewayResponseArgs) ElementType() reflect.Type

func (SwaggerGatewayResponseArgs) ToSwaggerGatewayResponseOutput 

func (i SwaggerGatewayResponseArgs) ToSwaggerGatewayResponseOutput() SwaggerGatewayResponseOutput

func (SwaggerGatewayResponseArgs) ToSwaggerGatewayResponseOutputWithContext 

func (i SwaggerGatewayResponseArgs) ToSwaggerGatewayResponseOutputWithContext(ctx context.Context) SwaggerGatewayResponseOutput

type SwaggerGatewayResponseInput 

type SwaggerGatewayResponseInput interface {
	pulumi.Input

	ToSwaggerGatewayResponseOutput() SwaggerGatewayResponseOutput
	ToSwaggerGatewayResponseOutputWithContext(context.Context) SwaggerGatewayResponseOutput
}

SwaggerGatewayResponseInput is an input type that accepts SwaggerGatewayResponseArgs and SwaggerGatewayResponseOutput values. You can construct a concrete instance of `SwaggerGatewayResponseInput` via: 

SwaggerGatewayResponseArgs{...}

type SwaggerGatewayResponseMap 

type SwaggerGatewayResponseMap map[string]SwaggerGatewayResponseInput

func (SwaggerGatewayResponseMap) ElementType 

func (SwaggerGatewayResponseMap) ElementType() reflect.Type

func (SwaggerGatewayResponseMap) ToSwaggerGatewayResponseMapOutput 

func (i SwaggerGatewayResponseMap) ToSwaggerGatewayResponseMapOutput() SwaggerGatewayResponseMapOutput

func (SwaggerGatewayResponseMap) ToSwaggerGatewayResponseMapOutputWithContext 

func (i SwaggerGatewayResponseMap) ToSwaggerGatewayResponseMapOutputWithContext(ctx context.Context) SwaggerGatewayResponseMapOutput

type SwaggerGatewayResponseMapInput 

type SwaggerGatewayResponseMapInput interface {
	pulumi.Input

	ToSwaggerGatewayResponseMapOutput() SwaggerGatewayResponseMapOutput
	ToSwaggerGatewayResponseMapOutputWithContext(context.Context) SwaggerGatewayResponseMapOutput
}

SwaggerGatewayResponseMapInput is an input type that accepts SwaggerGatewayResponseMap and SwaggerGatewayResponseMapOutput values. You can construct a concrete instance of `SwaggerGatewayResponseMapInput` via: 

SwaggerGatewayResponseMap{ "key": SwaggerGatewayResponseArgs{...} }

type SwaggerGatewayResponseMapOutput 

type SwaggerGatewayResponseMapOutput struct{ *pulumi.OutputState }

func (SwaggerGatewayResponseMapOutput) ElementType 

func (SwaggerGatewayResponseMapOutput) ElementType() reflect.Type

func (SwaggerGatewayResponseMapOutput) MapIndex 

func (o SwaggerGatewayResponseMapOutput) MapIndex(k pulumi.StringInput) SwaggerGatewayResponseOutput

func (SwaggerGatewayResponseMapOutput) ToSwaggerGatewayResponseMapOutput 

func (o SwaggerGatewayResponseMapOutput) ToSwaggerGatewayResponseMapOutput() SwaggerGatewayResponseMapOutput

func (SwaggerGatewayResponseMapOutput) ToSwaggerGatewayResponseMapOutputWithContext 

func (o SwaggerGatewayResponseMapOutput) ToSwaggerGatewayResponseMapOutputWithContext(ctx context.Context) SwaggerGatewayResponseMapOutput

type SwaggerGatewayResponseOutput 

type SwaggerGatewayResponseOutput struct{ *pulumi.OutputState }

func (SwaggerGatewayResponseOutput) ElementType 

func (SwaggerGatewayResponseOutput) ElementType() reflect.Type

func (SwaggerGatewayResponseOutput) ResponseParameters 

func (o SwaggerGatewayResponseOutput) ResponseParameters() pulumi.StringMapOutput

func (SwaggerGatewayResponseOutput) ResponseTemplates 

func (o SwaggerGatewayResponseOutput) ResponseTemplates() pulumi.StringMapOutput

func (SwaggerGatewayResponseOutput) StatusCode 

func (o SwaggerGatewayResponseOutput) StatusCode() pulumi.Float64PtrOutput

func (SwaggerGatewayResponseOutput) ToSwaggerGatewayResponseOutput 

func (o SwaggerGatewayResponseOutput) ToSwaggerGatewayResponseOutput() SwaggerGatewayResponseOutput

func (SwaggerGatewayResponseOutput) ToSwaggerGatewayResponseOutputWithContext 

func (o SwaggerGatewayResponseOutput) ToSwaggerGatewayResponseOutputWithContext(ctx context.Context) SwaggerGatewayResponseOutput

type Target 

type Target struct {
	// The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
	// otherwise.
	ConnectionId *string `pulumi:"connectionId"`
	// The type of the network connection to the integration endpoint. The valid value is `INTERNET`
	// for connections through the public routable internet or `VPC_LINK` for private connections
	// between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.
	ConnectionType *IntegrationConnectionType `pulumi:"connectionType"`
	// Specifies the integration's HTTP method type.  Currently, the only supported type is 'ANY'.
	HttpMethod *string `pulumi:"httpMethod"`
	// Specifies how the method request body of an unmapped content type will be passed through the
	// integration request to the back end without transformation.
	//
	// The valid value is one of the following:
	//
	// * `WHEN_NO_MATCH`: passes the method request body through the integration request to the back end
	// without transformation when the method request content type does not match any content type
	// associated with the mapping templates defined in the integration request.
	//
	// * `WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back
	// end without transformation when no mapping template is defined in the integration request. If
	// a template is defined when this option is selected, the method request of an unmapped
	// content-type will be rejected with an HTTP 415 Unsupported Media Type response.
	//
	// * `NEVER`: rejects the method request with an HTTP 415 Unsupported Media Type response when
	// either the method request content type does not match any content type associated with the
	// mapping templates defined in the integration request or no mapping template is defined in the
	// integration request.
	//
	// Defaults to `WHEN_NO_MATCH` if unspecified.
	PassthroughBehaviour *IntegrationPassthroughBehavior `pulumi:"passthroughBehaviour"`
	// Specifies an API method integration type. The valid value is one of the following:
	//
	// * `aws`: for integrating the API method request with an AWS service action, including the Lambda
	// function-invoking action. With the Lambda function-invoking action, this is referred to as
	// the Lambda custom integration. With any other AWS service action, this is known as AWS
	// integration.
	//
	// * `aws_proxy`: for integrating the API method request with the Lambda function-invoking action
	// with the client request passed through as-is. This integration is also referred to as the
	// Lambda proxy integration.
	//
	// * `http`: for integrating the API method request with an HTTP endpoint, including a private HTTP
	// endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
	//
	// * `http_proxy`: for integrating the API method request with an HTTP endpoint, including a private
	// HTTP endpoint within a VPC, with the client request passed through as-is. This is also
	// referred to as the HTTP proxy integration.
	//
	// * `mock`: for integrating the API method request with API Gateway as a "loop-back" endpoint
	// without invoking any backend.
	Type IntegrationType `pulumi:"type"`
	// Specifies Uniform Resource Identifier (URI) of the integration endpoint.
	//
	// For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL
	// according to the RFC-3986 specification, for either standard integration, where
	// connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For
	// a private HTTP integration, the URI is not used for routing.
	//
	// For AWS or AWS_PROXY integrations, the URI is of the form
	// arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here,
	// {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated
	// AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS
	// service for fast host-name lookup. action can be used for an AWS service action-based API,
	// using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to
	// a supported action {name} plus any required input parameters. Alternatively, path can be used
	// for an AWS service path-based API. The ensuing service_api refers to the path to an AWS
	// service resource, including the region of the integrated AWS service, if applicable. For
	// example, for integration with the S3 API of GetObject, the uri can be either
	// arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or
	// arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.
	Uri *string `pulumi:"uri"`
}

type TargetArgs 

type TargetArgs struct {
	// The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
	// otherwise.
	ConnectionId pulumi.StringPtrInput `pulumi:"connectionId"`
	// The type of the network connection to the integration endpoint. The valid value is `INTERNET`
	// for connections through the public routable internet or `VPC_LINK` for private connections
	// between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.
	ConnectionType IntegrationConnectionTypePtrInput `pulumi:"connectionType"`
	// Specifies the integration's HTTP method type.  Currently, the only supported type is 'ANY'.
	HttpMethod pulumi.StringPtrInput `pulumi:"httpMethod"`
	// Specifies how the method request body of an unmapped content type will be passed through the
	// integration request to the back end without transformation.
	//
	// The valid value is one of the following:
	//
	// * `WHEN_NO_MATCH`: passes the method request body through the integration request to the back end
	// without transformation when the method request content type does not match any content type
	// associated with the mapping templates defined in the integration request.
	//
	// * `WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back
	// end without transformation when no mapping template is defined in the integration request. If
	// a template is defined when this option is selected, the method request of an unmapped
	// content-type will be rejected with an HTTP 415 Unsupported Media Type response.
	//
	// * `NEVER`: rejects the method request with an HTTP 415 Unsupported Media Type response when
	// either the method request content type does not match any content type associated with the
	// mapping templates defined in the integration request or no mapping template is defined in the
	// integration request.
	//
	// Defaults to `WHEN_NO_MATCH` if unspecified.
	PassthroughBehaviour IntegrationPassthroughBehaviorPtrInput `pulumi:"passthroughBehaviour"`
	// Specifies an API method integration type. The valid value is one of the following:
	//
	// * `aws`: for integrating the API method request with an AWS service action, including the Lambda
	// function-invoking action. With the Lambda function-invoking action, this is referred to as
	// the Lambda custom integration. With any other AWS service action, this is known as AWS
	// integration.
	//
	// * `aws_proxy`: for integrating the API method request with the Lambda function-invoking action
	// with the client request passed through as-is. This integration is also referred to as the
	// Lambda proxy integration.
	//
	// * `http`: for integrating the API method request with an HTTP endpoint, including a private HTTP
	// endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
	//
	// * `http_proxy`: for integrating the API method request with an HTTP endpoint, including a private
	// HTTP endpoint within a VPC, with the client request passed through as-is. This is also
	// referred to as the HTTP proxy integration.
	//
	// * `mock`: for integrating the API method request with API Gateway as a "loop-back" endpoint
	// without invoking any backend.
	Type IntegrationTypeInput `pulumi:"type"`
	// Specifies Uniform Resource Identifier (URI) of the integration endpoint.
	//
	// For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL
	// according to the RFC-3986 specification, for either standard integration, where
	// connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For
	// a private HTTP integration, the URI is not used for routing.
	//
	// For AWS or AWS_PROXY integrations, the URI is of the form
	// arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here,
	// {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated
	// AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS
	// service for fast host-name lookup. action can be used for an AWS service action-based API,
	// using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to
	// a supported action {name} plus any required input parameters. Alternatively, path can be used
	// for an AWS service path-based API. The ensuing service_api refers to the path to an AWS
	// service resource, including the region of the integrated AWS service, if applicable. For
	// example, for integration with the S3 API of GetObject, the uri can be either
	// arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or
	// arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.
	Uri pulumi.StringPtrInput `pulumi:"uri"`
}

func (TargetArgs) ElementType 

func (TargetArgs) ElementType() reflect.Type

func (TargetArgs) ToTargetOutput 

func (i TargetArgs) ToTargetOutput() TargetOutput

func (TargetArgs) ToTargetOutputWithContext 

func (i TargetArgs) ToTargetOutputWithContext(ctx context.Context) TargetOutput

func (TargetArgs) ToTargetPtrOutput 

func (i TargetArgs) ToTargetPtrOutput() TargetPtrOutput

func (TargetArgs) ToTargetPtrOutputWithContext 

func (i TargetArgs) ToTargetPtrOutputWithContext(ctx context.Context) TargetPtrOutput

type TargetInput 

type TargetInput interface {
	pulumi.Input

	ToTargetOutput() TargetOutput
	ToTargetOutputWithContext(context.Context) TargetOutput
}

TargetInput is an input type that accepts TargetArgs and TargetOutput values. You can construct a concrete instance of `TargetInput` via: 

TargetArgs{...}

type TargetOutput 

type TargetOutput struct{ *pulumi.OutputState }

func (TargetOutput) ConnectionId 

func (o TargetOutput) ConnectionId() pulumi.StringPtrOutput

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

func (TargetOutput) ConnectionType 

func (o TargetOutput) ConnectionType() IntegrationConnectionTypePtrOutput

The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.

func (TargetOutput) ElementType 

func (TargetOutput) ElementType() reflect.Type

func (TargetOutput) HttpMethod 

func (o TargetOutput) HttpMethod() pulumi.StringPtrOutput

Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.

func (TargetOutput) PassthroughBehaviour 

func (o TargetOutput) PassthroughBehaviour() IntegrationPassthroughBehaviorPtrOutput

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation.

The valid value is one of the following:

* `WHEN_NO_MATCH`: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.

* `WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.

* `NEVER`: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Defaults to `WHEN_NO_MATCH` if unspecified.

func (TargetOutput) ToTargetOutput 

func (o TargetOutput) ToTargetOutput() TargetOutput

func (TargetOutput) ToTargetOutputWithContext 

func (o TargetOutput) ToTargetOutputWithContext(ctx context.Context) TargetOutput

func (TargetOutput) ToTargetPtrOutput 

func (o TargetOutput) ToTargetPtrOutput() TargetPtrOutput

func (TargetOutput) ToTargetPtrOutputWithContext 

func (o TargetOutput) ToTargetPtrOutputWithContext(ctx context.Context) TargetPtrOutput

func (TargetOutput) Type 

func (o TargetOutput) Type() IntegrationTypeOutput

Specifies an API method integration type. The valid value is one of the following:

* `aws`: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

* `aws_proxy`: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.

* `http`: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.

* `http_proxy`: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.

* `mock`: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

func (TargetOutput) Uri 

func (o TargetOutput) Uri() pulumi.StringPtrOutput

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

type TargetPtrInput 

type TargetPtrInput interface {
	pulumi.Input

	ToTargetPtrOutput() TargetPtrOutput
	ToTargetPtrOutputWithContext(context.Context) TargetPtrOutput
}

TargetPtrInput is an input type that accepts TargetArgs, TargetPtr and TargetPtrOutput values. You can construct a concrete instance of `TargetPtrInput` via: 

        TargetArgs{...}

or:

        nil

func TargetPtr 

func TargetPtr(v *TargetArgs) TargetPtrInput

type TargetPtrOutput 

type TargetPtrOutput struct{ *pulumi.OutputState }

func (TargetPtrOutput) ConnectionId 

func (o TargetPtrOutput) ConnectionId() pulumi.StringPtrOutput

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

func (TargetPtrOutput) ConnectionType 

func (o TargetPtrOutput) ConnectionType() IntegrationConnectionTypePtrOutput

The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.

func (TargetPtrOutput) Elem 

func (o TargetPtrOutput) Elem() TargetOutput

func (TargetPtrOutput) ElementType 

func (TargetPtrOutput) ElementType() reflect.Type

func (TargetPtrOutput) HttpMethod 

func (o TargetPtrOutput) HttpMethod() pulumi.StringPtrOutput

Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.

func (TargetPtrOutput) PassthroughBehaviour 

func (o TargetPtrOutput) PassthroughBehaviour() IntegrationPassthroughBehaviorPtrOutput

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation.

The valid value is one of the following:

* `WHEN_NO_MATCH`: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.

* `WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.

* `NEVER`: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Defaults to `WHEN_NO_MATCH` if unspecified.

func (TargetPtrOutput) ToTargetPtrOutput 

func (o TargetPtrOutput) ToTargetPtrOutput() TargetPtrOutput

func (TargetPtrOutput) ToTargetPtrOutputWithContext 

func (o TargetPtrOutput) ToTargetPtrOutputWithContext(ctx context.Context) TargetPtrOutput

func (TargetPtrOutput) Type 

func (o TargetPtrOutput) Type() IntegrationTypePtrOutput

Specifies an API method integration type. The valid value is one of the following:

* `aws`: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

* `aws_proxy`: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.

* `http`: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.

* `http_proxy`: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.

* `mock`: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

func (TargetPtrOutput) Uri 

func (o TargetPtrOutput) Uri() pulumi.StringPtrOutput

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

Source Files

View all Source files

Directories

Path Synopsis

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.