apigateway

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Jun 3, 2021 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package apigateway exports types, functions, subpackages for provisioning apigateway resources.

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

func PkgVersion 

func PkgVersion() (semver.Version, error)

PkgVersion uses reflection to determine the version of the current package.

Types

type APIKeySource 

type APIKeySource pulumi.String

func (APIKeySource) ElementType 

func (APIKeySource) ElementType() reflect.Type

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 IntegrationConnectionType 

type IntegrationConnectionType pulumi.String

func (IntegrationConnectionType) ElementType 

func (IntegrationConnectionType) ElementType() reflect.Type

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 IntegrationPassthroughBehavior 

type IntegrationPassthroughBehavior pulumi.String

func (IntegrationPassthroughBehavior) ElementType 

func (IntegrationPassthroughBehavior) ElementType() reflect.Type

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 IntegrationType 

type IntegrationType pulumi.String

func (IntegrationType) ElementType 

func (IntegrationType) ElementType() reflect.Type

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 Method 

type Method pulumi.String

func (Method) ElementType 

func (Method) ElementType() reflect.Type

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 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

func (*Provider) ToProviderPtrOutput 

func (i *Provider) ToProviderPtrOutput() ProviderPtrOutput

func (*Provider) ToProviderPtrOutputWithContext 

func (i *Provider) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

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

func (ProviderOutput) ToProviderPtrOutput 

func (o ProviderOutput) ToProviderPtrOutput() ProviderPtrOutput

func (ProviderOutput) ToProviderPtrOutputWithContext 

func (o ProviderOutput) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type ProviderPtrInput 

type ProviderPtrInput interface {
	pulumi.Input

	ToProviderPtrOutput() ProviderPtrOutput
	ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput
}

type ProviderPtrOutput 

type ProviderPtrOutput struct {
	*pulumi.OutputState
}

func (ProviderPtrOutput) ElementType 

func (ProviderPtrOutput) ElementType() reflect.Type

func (ProviderPtrOutput) ToProviderPtrOutput 

func (o ProviderPtrOutput) ToProviderPtrOutput() ProviderPtrOutput

func (ProviderPtrOutput) ToProviderPtrOutputWithContext 

func (o ProviderPtrOutput) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type RequestValidator 

type RequestValidator pulumi.String

func (RequestValidator) ElementType 

func (RequestValidator) ElementType() reflect.Type

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 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"`
}

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

func (*RestAPI) ToRestAPIPtrOutput 

func (i *RestAPI) ToRestAPIPtrOutput() RestAPIPtrOutput

func (*RestAPI) ToRestAPIPtrOutputWithContext 

func (i *RestAPI) ToRestAPIPtrOutputWithContext(ctx context.Context) RestAPIPtrOutput

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 *string
	// Define custom gateway responses for the API. This can be used to properly enable
	// CORS for Lambda Authorizers.
	GatewayResponses map[string]SwaggerGatewayResponse
	// Request Validator specifies the validator to use at the API level. Note method level validators
	// override this.
	RequestValidator *string
	// 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 RouteArrayInput
	// 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
}

The set of arguments for constructing a RestAPI resource.

func (RestAPIArgs) ElementType 

func (RestAPIArgs) ElementType() reflect.Type

type RestAPIArray 

type RestAPIArray []RestAPIInput

func (RestAPIArray) ElementType 

func (RestAPIArray) ElementType() reflect.Type

func (RestAPIArray) ToRestAPIArrayOutput 

func (i RestAPIArray) ToRestAPIArrayOutput() RestAPIArrayOutput

func (RestAPIArray) ToRestAPIArrayOutputWithContext 

func (i RestAPIArray) ToRestAPIArrayOutputWithContext(ctx context.Context) RestAPIArrayOutput

type RestAPIArrayInput 

type RestAPIArrayInput interface {
	pulumi.Input

	ToRestAPIArrayOutput() RestAPIArrayOutput
	ToRestAPIArrayOutputWithContext(context.Context) RestAPIArrayOutput
}

RestAPIArrayInput is an input type that accepts RestAPIArray and RestAPIArrayOutput values. You can construct a concrete instance of `RestAPIArrayInput` via: 

RestAPIArray{ RestAPIArgs{...} }

type RestAPIArrayOutput 

type RestAPIArrayOutput struct{ *pulumi.OutputState }

func (RestAPIArrayOutput) ElementType 

func (RestAPIArrayOutput) ElementType() reflect.Type

func (RestAPIArrayOutput) Index 

func (o RestAPIArrayOutput) Index(i pulumi.IntInput) RestAPIOutput

func (RestAPIArrayOutput) ToRestAPIArrayOutput 

func (o RestAPIArrayOutput) ToRestAPIArrayOutput() RestAPIArrayOutput

func (RestAPIArrayOutput) ToRestAPIArrayOutputWithContext 

func (o RestAPIArrayOutput) ToRestAPIArrayOutputWithContext(ctx context.Context) RestAPIArrayOutput

type RestAPIInput 

type RestAPIInput interface {
	pulumi.Input

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

type RestAPIMap 

type RestAPIMap map[string]RestAPIInput

func (RestAPIMap) ElementType 

func (RestAPIMap) ElementType() reflect.Type

func (RestAPIMap) ToRestAPIMapOutput 

func (i RestAPIMap) ToRestAPIMapOutput() RestAPIMapOutput

func (RestAPIMap) ToRestAPIMapOutputWithContext 

func (i RestAPIMap) ToRestAPIMapOutputWithContext(ctx context.Context) RestAPIMapOutput

type RestAPIMapInput 

type RestAPIMapInput interface {
	pulumi.Input

	ToRestAPIMapOutput() RestAPIMapOutput
	ToRestAPIMapOutputWithContext(context.Context) RestAPIMapOutput
}

RestAPIMapInput is an input type that accepts RestAPIMap and RestAPIMapOutput values. You can construct a concrete instance of `RestAPIMapInput` via: 

RestAPIMap{ "key": RestAPIArgs{...} }

type RestAPIMapOutput 

type RestAPIMapOutput struct{ *pulumi.OutputState }

func (RestAPIMapOutput) ElementType 

func (RestAPIMapOutput) ElementType() reflect.Type

func (RestAPIMapOutput) MapIndex 

func (o RestAPIMapOutput) MapIndex(k pulumi.StringInput) RestAPIOutput

func (RestAPIMapOutput) ToRestAPIMapOutput 

func (o RestAPIMapOutput) ToRestAPIMapOutput() RestAPIMapOutput

func (RestAPIMapOutput) ToRestAPIMapOutputWithContext 

func (o RestAPIMapOutput) ToRestAPIMapOutputWithContext(ctx context.Context) RestAPIMapOutput

type RestAPIOutput 

type RestAPIOutput struct {
	*pulumi.OutputState
}

func (RestAPIOutput) ElementType 

func (RestAPIOutput) ElementType() reflect.Type

func (RestAPIOutput) ToRestAPIOutput 

func (o RestAPIOutput) ToRestAPIOutput() RestAPIOutput

func (RestAPIOutput) ToRestAPIOutputWithContext 

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

func (RestAPIOutput) ToRestAPIPtrOutput 

func (o RestAPIOutput) ToRestAPIPtrOutput() RestAPIPtrOutput

func (RestAPIOutput) ToRestAPIPtrOutputWithContext 

func (o RestAPIOutput) ToRestAPIPtrOutputWithContext(ctx context.Context) RestAPIPtrOutput

type RestAPIPtrInput 

type RestAPIPtrInput interface {
	pulumi.Input

	ToRestAPIPtrOutput() RestAPIPtrOutput
	ToRestAPIPtrOutputWithContext(ctx context.Context) RestAPIPtrOutput
}

type RestAPIPtrOutput 

type RestAPIPtrOutput struct {
	*pulumi.OutputState
}

func (RestAPIPtrOutput) ElementType 

func (RestAPIPtrOutput) ElementType() reflect.Type

func (RestAPIPtrOutput) ToRestAPIPtrOutput 

func (o RestAPIPtrOutput) ToRestAPIPtrOutput() RestAPIPtrOutput

func (RestAPIPtrOutput) ToRestAPIPtrOutputWithContext 

func (o RestAPIPtrOutput) ToRestAPIPtrOutputWithContext(ctx context.Context) RestAPIPtrOutput

type Route 

type Route struct {
	// 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 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 *string `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"`
	// 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 {
	// 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 pulumi.StringPtrInput `pulumi:"contentType"`
	// A raw Swagger object to include verbatim in the integration for this path.
	Data pulumi.Input `pulumi:"data"`
	// A Lambda function which will handle the route for the given path and method.
	EventHandler lambda.FunctionInput `pulumi:"eventHandler"`
	// 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 pulumi.Input `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 pulumi.StringPtrInput `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 pulumi.StringInput `pulumi:"path"`
	// 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) 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) 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() pulumi.StringPtrOutput

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) 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 *string `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 *string `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 string `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 *IntegrationConnectionType `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 *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 pulumi.StringInput `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() pulumi.StringPtrOutput

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() pulumi.StringPtrOutput

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() pulumi.StringOutput

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.StringOutput

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() pulumi.StringPtrOutput

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() pulumi.StringPtrOutput

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() pulumi.StringPtrOutput

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

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.