apigatewayv2

package
v0.106.0 Latest Latest
Warning

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

 Go to latest Published: May 20, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Api 

type Api struct {
	pulumi.CustomResourceState

	// The default endpoint for an API. For example: `https://abcdef.execute-api.us-west-2.amazonaws.com` .
	ApiEndpoint pulumi.StringOutput `pulumi:"apiEndpoint"`
	// The API identifier.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
	ApiKeySelectionExpression pulumi.StringPtrOutput `pulumi:"apiKeySelectionExpression"`
	// Specifies how to interpret the base path of the API during import. Valid values are “ignore“, “prepend“, and “split“. The default value is “ignore“. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
	BasePath pulumi.StringPtrOutput `pulumi:"basePath"`
	// The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a “Body“ or “BodyS3Location“. If you specify a “Body“ or “BodyS3Location“, don't specify CloudFormation resources such as “AWS::ApiGatewayV2::Authorizer“ or “AWS::ApiGatewayV2::Route“. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Api` for more information about the expected schema for this property.
	Body pulumi.AnyOutput `pulumi:"body"`
	// The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a “Body“ or “BodyS3Location“. If you specify a “Body“ or “BodyS3Location“, don't specify CloudFormation resources such as “AWS::ApiGatewayV2::Authorizer“ or “AWS::ApiGatewayV2::Route“. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
	BodyS3Location ApiBodyS3LocationPtrOutput `pulumi:"bodyS3Location"`
	// A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
	CorsConfiguration ApiCorsPtrOutput `pulumi:"corsConfiguration"`
	// This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify “arn:aws:iam::*:user/*“. To use resource-based permissions on supported AWS services, specify “null“. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
	CredentialsArn pulumi.StringPtrOutput `pulumi:"credentialsArn"`
	// The description of the API.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Specifies 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.
	DisableExecuteApiEndpoint pulumi.BoolPtrOutput `pulumi:"disableExecuteApiEndpoint"`
	// Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
	DisableSchemaValidation pulumi.BoolPtrOutput `pulumi:"disableSchemaValidation"`
	// Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
	FailOnWarnings pulumi.BoolPtrOutput `pulumi:"failOnWarnings"`
	// The name of the API. Required unless you specify an OpenAPI definition for “Body“ or “S3BodyLocation“.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// The API protocol. Valid values are “WEBSOCKET“ or “HTTP“. Required unless you specify an OpenAPI definition for “Body“ or “S3BodyLocation“.
	ProtocolType pulumi.StringPtrOutput `pulumi:"protocolType"`
	// This property is part of quick create. If you don't specify a “routeKey“, a default route of “$default“ is created. The “$default“ route acts as a catch-all for any request made to your API, for a particular stage. The “$default“ route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
	RouteKey pulumi.StringPtrOutput `pulumi:"routeKey"`
	// The route selection expression for the API. For HTTP APIs, the “routeSelectionExpression“ must be “${request.method} ${request.path}“. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
	RouteSelectionExpression pulumi.StringPtrOutput `pulumi:"routeSelectionExpression"`
	// The collection of tags. Each tag element is associated with a given resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
	Target pulumi.StringPtrOutput `pulumi:"target"`
	// A version identifier for the API.
	Version pulumi.StringPtrOutput `pulumi:"version"`
}

The “AWS::ApiGatewayV2::Api“ resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*

func GetApi 

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

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

func NewApi 

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

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

func (*Api) ElementType 

func (*Api) ElementType() reflect.Type

func (*Api) ToApiOutput 

func (i *Api) ToApiOutput() ApiOutput

func (*Api) ToApiOutputWithContext 

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

type ApiArgs 

type ApiArgs struct {
	// An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
	ApiKeySelectionExpression pulumi.StringPtrInput
	// Specifies how to interpret the base path of the API during import. Valid values are “ignore“, “prepend“, and “split“. The default value is “ignore“. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
	BasePath pulumi.StringPtrInput
	// The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a “Body“ or “BodyS3Location“. If you specify a “Body“ or “BodyS3Location“, don't specify CloudFormation resources such as “AWS::ApiGatewayV2::Authorizer“ or “AWS::ApiGatewayV2::Route“. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Api` for more information about the expected schema for this property.
	Body pulumi.Input
	// The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a “Body“ or “BodyS3Location“. If you specify a “Body“ or “BodyS3Location“, don't specify CloudFormation resources such as “AWS::ApiGatewayV2::Authorizer“ or “AWS::ApiGatewayV2::Route“. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
	BodyS3Location ApiBodyS3LocationPtrInput
	// A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
	CorsConfiguration ApiCorsPtrInput
	// This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify “arn:aws:iam::*:user/*“. To use resource-based permissions on supported AWS services, specify “null“. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
	CredentialsArn pulumi.StringPtrInput
	// The description of the API.
	Description pulumi.StringPtrInput
	// Specifies 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.
	DisableExecuteApiEndpoint pulumi.BoolPtrInput
	// Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
	DisableSchemaValidation pulumi.BoolPtrInput
	// Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
	FailOnWarnings pulumi.BoolPtrInput
	// The name of the API. Required unless you specify an OpenAPI definition for “Body“ or “S3BodyLocation“.
	Name pulumi.StringPtrInput
	// The API protocol. Valid values are “WEBSOCKET“ or “HTTP“. Required unless you specify an OpenAPI definition for “Body“ or “S3BodyLocation“.
	ProtocolType pulumi.StringPtrInput
	// This property is part of quick create. If you don't specify a “routeKey“, a default route of “$default“ is created. The “$default“ route acts as a catch-all for any request made to your API, for a particular stage. The “$default“ route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
	RouteKey pulumi.StringPtrInput
	// The route selection expression for the API. For HTTP APIs, the “routeSelectionExpression“ must be “${request.method} ${request.path}“. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
	RouteSelectionExpression pulumi.StringPtrInput
	// The collection of tags. Each tag element is associated with a given resource.
	Tags pulumi.StringMapInput
	// This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
	Target pulumi.StringPtrInput
	// A version identifier for the API.
	Version pulumi.StringPtrInput
}

The set of arguments for constructing a Api resource.

func (ApiArgs) ElementType 

func (ApiArgs) ElementType() reflect.Type

type ApiBodyS3Location 

type ApiBodyS3Location struct {
	// The S3 bucket that contains the OpenAPI definition to import. Required if you specify a “BodyS3Location“ for an API.
	Bucket *string `pulumi:"bucket"`
	// The Etag of the S3 object.
	Etag *string `pulumi:"etag"`
	// The key of the S3 object. Required if you specify a “BodyS3Location“ for an API.
	Key *string `pulumi:"key"`
	// The version of the S3 object.
	Version *string `pulumi:"version"`
}

The “BodyS3Location“ property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs.

type ApiBodyS3LocationArgs 

type ApiBodyS3LocationArgs struct {
	// The S3 bucket that contains the OpenAPI definition to import. Required if you specify a “BodyS3Location“ for an API.
	Bucket pulumi.StringPtrInput `pulumi:"bucket"`
	// The Etag of the S3 object.
	Etag pulumi.StringPtrInput `pulumi:"etag"`
	// The key of the S3 object. Required if you specify a “BodyS3Location“ for an API.
	Key pulumi.StringPtrInput `pulumi:"key"`
	// The version of the S3 object.
	Version pulumi.StringPtrInput `pulumi:"version"`
}

The “BodyS3Location“ property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs.

func (ApiBodyS3LocationArgs) ElementType 

func (ApiBodyS3LocationArgs) ElementType() reflect.Type

func (ApiBodyS3LocationArgs) ToApiBodyS3LocationOutput 

func (i ApiBodyS3LocationArgs) ToApiBodyS3LocationOutput() ApiBodyS3LocationOutput

func (ApiBodyS3LocationArgs) ToApiBodyS3LocationOutputWithContext 

func (i ApiBodyS3LocationArgs) ToApiBodyS3LocationOutputWithContext(ctx context.Context) ApiBodyS3LocationOutput

func (ApiBodyS3LocationArgs) ToApiBodyS3LocationPtrOutput 

func (i ApiBodyS3LocationArgs) ToApiBodyS3LocationPtrOutput() ApiBodyS3LocationPtrOutput

func (ApiBodyS3LocationArgs) ToApiBodyS3LocationPtrOutputWithContext 

func (i ApiBodyS3LocationArgs) ToApiBodyS3LocationPtrOutputWithContext(ctx context.Context) ApiBodyS3LocationPtrOutput

type ApiBodyS3LocationInput 

type ApiBodyS3LocationInput interface {
	pulumi.Input

	ToApiBodyS3LocationOutput() ApiBodyS3LocationOutput
	ToApiBodyS3LocationOutputWithContext(context.Context) ApiBodyS3LocationOutput
}

ApiBodyS3LocationInput is an input type that accepts ApiBodyS3LocationArgs and ApiBodyS3LocationOutput values. You can construct a concrete instance of `ApiBodyS3LocationInput` via: 

ApiBodyS3LocationArgs{...}

type ApiBodyS3LocationOutput 

type ApiBodyS3LocationOutput struct{ *pulumi.OutputState }

The “BodyS3Location“ property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs.

func (ApiBodyS3LocationOutput) Bucket 

func (o ApiBodyS3LocationOutput) Bucket() pulumi.StringPtrOutput

The S3 bucket that contains the OpenAPI definition to import. Required if you specify a “BodyS3Location“ for an API.

func (ApiBodyS3LocationOutput) ElementType 

func (ApiBodyS3LocationOutput) ElementType() reflect.Type

func (ApiBodyS3LocationOutput) Etag 

func (o ApiBodyS3LocationOutput) Etag() pulumi.StringPtrOutput

The Etag of the S3 object.

func (ApiBodyS3LocationOutput) Key 

func (o ApiBodyS3LocationOutput) Key() pulumi.StringPtrOutput

The key of the S3 object. Required if you specify a “BodyS3Location“ for an API.

func (ApiBodyS3LocationOutput) ToApiBodyS3LocationOutput 

func (o ApiBodyS3LocationOutput) ToApiBodyS3LocationOutput() ApiBodyS3LocationOutput

func (ApiBodyS3LocationOutput) ToApiBodyS3LocationOutputWithContext 

func (o ApiBodyS3LocationOutput) ToApiBodyS3LocationOutputWithContext(ctx context.Context) ApiBodyS3LocationOutput

func (ApiBodyS3LocationOutput) ToApiBodyS3LocationPtrOutput 

func (o ApiBodyS3LocationOutput) ToApiBodyS3LocationPtrOutput() ApiBodyS3LocationPtrOutput

func (ApiBodyS3LocationOutput) ToApiBodyS3LocationPtrOutputWithContext 

func (o ApiBodyS3LocationOutput) ToApiBodyS3LocationPtrOutputWithContext(ctx context.Context) ApiBodyS3LocationPtrOutput

func (ApiBodyS3LocationOutput) Version 

func (o ApiBodyS3LocationOutput) Version() pulumi.StringPtrOutput

The version of the S3 object.

type ApiBodyS3LocationPtrInput 

type ApiBodyS3LocationPtrInput interface {
	pulumi.Input

	ToApiBodyS3LocationPtrOutput() ApiBodyS3LocationPtrOutput
	ToApiBodyS3LocationPtrOutputWithContext(context.Context) ApiBodyS3LocationPtrOutput
}

ApiBodyS3LocationPtrInput is an input type that accepts ApiBodyS3LocationArgs, ApiBodyS3LocationPtr and ApiBodyS3LocationPtrOutput values. You can construct a concrete instance of `ApiBodyS3LocationPtrInput` via: 

        ApiBodyS3LocationArgs{...}

or:

        nil

func ApiBodyS3LocationPtr 

func ApiBodyS3LocationPtr(v *ApiBodyS3LocationArgs) ApiBodyS3LocationPtrInput

type ApiBodyS3LocationPtrOutput 

type ApiBodyS3LocationPtrOutput struct{ *pulumi.OutputState }

func (ApiBodyS3LocationPtrOutput) Bucket 

func (o ApiBodyS3LocationPtrOutput) Bucket() pulumi.StringPtrOutput

The S3 bucket that contains the OpenAPI definition to import. Required if you specify a “BodyS3Location“ for an API.

func (ApiBodyS3LocationPtrOutput) Elem 

func (o ApiBodyS3LocationPtrOutput) Elem() ApiBodyS3LocationOutput

func (ApiBodyS3LocationPtrOutput) ElementType 

func (ApiBodyS3LocationPtrOutput) ElementType() reflect.Type

func (ApiBodyS3LocationPtrOutput) Etag 

func (o ApiBodyS3LocationPtrOutput) Etag() pulumi.StringPtrOutput

The Etag of the S3 object.

func (ApiBodyS3LocationPtrOutput) Key 

func (o ApiBodyS3LocationPtrOutput) Key() pulumi.StringPtrOutput

The key of the S3 object. Required if you specify a “BodyS3Location“ for an API.

func (ApiBodyS3LocationPtrOutput) ToApiBodyS3LocationPtrOutput 

func (o ApiBodyS3LocationPtrOutput) ToApiBodyS3LocationPtrOutput() ApiBodyS3LocationPtrOutput

func (ApiBodyS3LocationPtrOutput) ToApiBodyS3LocationPtrOutputWithContext 

func (o ApiBodyS3LocationPtrOutput) ToApiBodyS3LocationPtrOutputWithContext(ctx context.Context) ApiBodyS3LocationPtrOutput

func (ApiBodyS3LocationPtrOutput) Version 

func (o ApiBodyS3LocationPtrOutput) Version() pulumi.StringPtrOutput

The version of the S3 object.

type ApiCors 

type ApiCors struct {
	// Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
	AllowCredentials *bool `pulumi:"allowCredentials"`
	// Represents a collection of allowed headers. Supported only for HTTP APIs.
	AllowHeaders []string `pulumi:"allowHeaders"`
	// Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
	AllowMethods []string `pulumi:"allowMethods"`
	// Represents a collection of allowed origins. Supported only for HTTP APIs.
	AllowOrigins []string `pulumi:"allowOrigins"`
	// Represents a collection of exposed headers. Supported only for HTTP APIs.
	ExposeHeaders []string `pulumi:"exposeHeaders"`
	// The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
	MaxAge *int `pulumi:"maxAge"`
}

The “Cors“ property specifies a CORS configuration for an API. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.

type ApiCorsArgs 

type ApiCorsArgs struct {
	// Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
	AllowCredentials pulumi.BoolPtrInput `pulumi:"allowCredentials"`
	// Represents a collection of allowed headers. Supported only for HTTP APIs.
	AllowHeaders pulumi.StringArrayInput `pulumi:"allowHeaders"`
	// Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
	AllowMethods pulumi.StringArrayInput `pulumi:"allowMethods"`
	// Represents a collection of allowed origins. Supported only for HTTP APIs.
	AllowOrigins pulumi.StringArrayInput `pulumi:"allowOrigins"`
	// Represents a collection of exposed headers. Supported only for HTTP APIs.
	ExposeHeaders pulumi.StringArrayInput `pulumi:"exposeHeaders"`
	// The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
	MaxAge pulumi.IntPtrInput `pulumi:"maxAge"`
}

The “Cors“ property specifies a CORS configuration for an API. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.

func (ApiCorsArgs) ElementType 

func (ApiCorsArgs) ElementType() reflect.Type

func (ApiCorsArgs) ToApiCorsOutput 

func (i ApiCorsArgs) ToApiCorsOutput() ApiCorsOutput

func (ApiCorsArgs) ToApiCorsOutputWithContext 

func (i ApiCorsArgs) ToApiCorsOutputWithContext(ctx context.Context) ApiCorsOutput

func (ApiCorsArgs) ToApiCorsPtrOutput 

func (i ApiCorsArgs) ToApiCorsPtrOutput() ApiCorsPtrOutput

func (ApiCorsArgs) ToApiCorsPtrOutputWithContext 

func (i ApiCorsArgs) ToApiCorsPtrOutputWithContext(ctx context.Context) ApiCorsPtrOutput

type ApiCorsInput 

type ApiCorsInput interface {
	pulumi.Input

	ToApiCorsOutput() ApiCorsOutput
	ToApiCorsOutputWithContext(context.Context) ApiCorsOutput
}

ApiCorsInput is an input type that accepts ApiCorsArgs and ApiCorsOutput values. You can construct a concrete instance of `ApiCorsInput` via: 

ApiCorsArgs{...}

type ApiCorsOutput 

type ApiCorsOutput struct{ *pulumi.OutputState }

The “Cors“ property specifies a CORS configuration for an API. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.

func (ApiCorsOutput) AllowCredentials 

func (o ApiCorsOutput) AllowCredentials() pulumi.BoolPtrOutput

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

func (ApiCorsOutput) AllowHeaders 

func (o ApiCorsOutput) AllowHeaders() pulumi.StringArrayOutput

Represents a collection of allowed headers. Supported only for HTTP APIs.

func (ApiCorsOutput) AllowMethods 

func (o ApiCorsOutput) AllowMethods() pulumi.StringArrayOutput

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

func (ApiCorsOutput) AllowOrigins 

func (o ApiCorsOutput) AllowOrigins() pulumi.StringArrayOutput

Represents a collection of allowed origins. Supported only for HTTP APIs.

func (ApiCorsOutput) ElementType 

func (ApiCorsOutput) ElementType() reflect.Type

func (ApiCorsOutput) ExposeHeaders 

func (o ApiCorsOutput) ExposeHeaders() pulumi.StringArrayOutput

Represents a collection of exposed headers. Supported only for HTTP APIs.

func (ApiCorsOutput) MaxAge 

func (o ApiCorsOutput) MaxAge() pulumi.IntPtrOutput

The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

func (ApiCorsOutput) ToApiCorsOutput 

func (o ApiCorsOutput) ToApiCorsOutput() ApiCorsOutput

func (ApiCorsOutput) ToApiCorsOutputWithContext 

func (o ApiCorsOutput) ToApiCorsOutputWithContext(ctx context.Context) ApiCorsOutput

func (ApiCorsOutput) ToApiCorsPtrOutput 

func (o ApiCorsOutput) ToApiCorsPtrOutput() ApiCorsPtrOutput

func (ApiCorsOutput) ToApiCorsPtrOutputWithContext 

func (o ApiCorsOutput) ToApiCorsPtrOutputWithContext(ctx context.Context) ApiCorsPtrOutput

type ApiCorsPtrInput 

type ApiCorsPtrInput interface {
	pulumi.Input

	ToApiCorsPtrOutput() ApiCorsPtrOutput
	ToApiCorsPtrOutputWithContext(context.Context) ApiCorsPtrOutput
}

ApiCorsPtrInput is an input type that accepts ApiCorsArgs, ApiCorsPtr and ApiCorsPtrOutput values. You can construct a concrete instance of `ApiCorsPtrInput` via: 

        ApiCorsArgs{...}

or:

        nil

func ApiCorsPtr 

func ApiCorsPtr(v *ApiCorsArgs) ApiCorsPtrInput

type ApiCorsPtrOutput 

type ApiCorsPtrOutput struct{ *pulumi.OutputState }

func (ApiCorsPtrOutput) AllowCredentials 

func (o ApiCorsPtrOutput) AllowCredentials() pulumi.BoolPtrOutput

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

func (ApiCorsPtrOutput) AllowHeaders 

func (o ApiCorsPtrOutput) AllowHeaders() pulumi.StringArrayOutput

Represents a collection of allowed headers. Supported only for HTTP APIs.

func (ApiCorsPtrOutput) AllowMethods 

func (o ApiCorsPtrOutput) AllowMethods() pulumi.StringArrayOutput

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

func (ApiCorsPtrOutput) AllowOrigins 

func (o ApiCorsPtrOutput) AllowOrigins() pulumi.StringArrayOutput

Represents a collection of allowed origins. Supported only for HTTP APIs.

func (ApiCorsPtrOutput) Elem 

func (o ApiCorsPtrOutput) Elem() ApiCorsOutput

func (ApiCorsPtrOutput) ElementType 

func (ApiCorsPtrOutput) ElementType() reflect.Type

func (ApiCorsPtrOutput) ExposeHeaders 

func (o ApiCorsPtrOutput) ExposeHeaders() pulumi.StringArrayOutput

Represents a collection of exposed headers. Supported only for HTTP APIs.

func (ApiCorsPtrOutput) MaxAge 

func (o ApiCorsPtrOutput) MaxAge() pulumi.IntPtrOutput

The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

func (ApiCorsPtrOutput) ToApiCorsPtrOutput 

func (o ApiCorsPtrOutput) ToApiCorsPtrOutput() ApiCorsPtrOutput

func (ApiCorsPtrOutput) ToApiCorsPtrOutputWithContext 

func (o ApiCorsPtrOutput) ToApiCorsPtrOutputWithContext(ctx context.Context) ApiCorsPtrOutput

type ApiInput 

type ApiInput interface {
	pulumi.Input

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

type ApiMapping 

type ApiMapping struct {
	pulumi.CustomResourceState

	// The identifier of the API.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// The API mapping resource ID.
	ApiMappingId pulumi.StringOutput `pulumi:"apiMappingId"`
	// The API mapping key.
	ApiMappingKey pulumi.StringPtrOutput `pulumi:"apiMappingKey"`
	// The domain name.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// The API stage.
	Stage pulumi.StringOutput `pulumi:"stage"`
}

The “AWS::ApiGatewayV2::ApiMapping“ resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.

func GetApiMapping 

func GetApiMapping(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApiMappingState, opts ...pulumi.ResourceOption) (*ApiMapping, error)

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

func NewApiMapping 

func NewApiMapping(ctx *pulumi.Context,
	name string, args *ApiMappingArgs, opts ...pulumi.ResourceOption) (*ApiMapping, error)

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

func (*ApiMapping) ElementType 

func (*ApiMapping) ElementType() reflect.Type

func (*ApiMapping) ToApiMappingOutput 

func (i *ApiMapping) ToApiMappingOutput() ApiMappingOutput

func (*ApiMapping) ToApiMappingOutputWithContext 

func (i *ApiMapping) ToApiMappingOutputWithContext(ctx context.Context) ApiMappingOutput

type ApiMappingArgs 

type ApiMappingArgs struct {
	// The identifier of the API.
	ApiId pulumi.StringInput
	// The API mapping key.
	ApiMappingKey pulumi.StringPtrInput
	// The domain name.
	DomainName pulumi.StringInput
	// The API stage.
	Stage pulumi.StringInput
}

The set of arguments for constructing a ApiMapping resource.

func (ApiMappingArgs) ElementType 

func (ApiMappingArgs) ElementType() reflect.Type

type ApiMappingInput 

type ApiMappingInput interface {
	pulumi.Input

	ToApiMappingOutput() ApiMappingOutput
	ToApiMappingOutputWithContext(ctx context.Context) ApiMappingOutput
}

type ApiMappingOutput 

type ApiMappingOutput struct{ *pulumi.OutputState }

func (ApiMappingOutput) ApiId added in v0.17.0 

func (o ApiMappingOutput) ApiId() pulumi.StringOutput

The identifier of the API.

func (ApiMappingOutput) ApiMappingId added in v0.68.0 

func (o ApiMappingOutput) ApiMappingId() pulumi.StringOutput

The API mapping resource ID.

func (ApiMappingOutput) ApiMappingKey added in v0.17.0 

func (o ApiMappingOutput) ApiMappingKey() pulumi.StringPtrOutput

The API mapping key.

func (ApiMappingOutput) DomainName added in v0.17.0 

func (o ApiMappingOutput) DomainName() pulumi.StringOutput

The domain name.

func (ApiMappingOutput) ElementType 

func (ApiMappingOutput) ElementType() reflect.Type

func (ApiMappingOutput) Stage added in v0.17.0 

func (o ApiMappingOutput) Stage() pulumi.StringOutput

The API stage.

func (ApiMappingOutput) ToApiMappingOutput 

func (o ApiMappingOutput) ToApiMappingOutput() ApiMappingOutput

func (ApiMappingOutput) ToApiMappingOutputWithContext 

func (o ApiMappingOutput) ToApiMappingOutputWithContext(ctx context.Context) ApiMappingOutput

type ApiMappingState 

type ApiMappingState struct {
}

func (ApiMappingState) ElementType 

func (ApiMappingState) ElementType() reflect.Type

type ApiOutput 

type ApiOutput struct{ *pulumi.OutputState }

func (ApiOutput) ApiEndpoint added in v0.17.0 

func (o ApiOutput) ApiEndpoint() pulumi.StringOutput

The default endpoint for an API. For example: `https://abcdef.execute-api.us-west-2.amazonaws.com` .

func (ApiOutput) ApiId added in v0.40.0 

func (o ApiOutput) ApiId() pulumi.StringOutput

The API identifier.

func (ApiOutput) ApiKeySelectionExpression added in v0.17.0 

func (o ApiOutput) ApiKeySelectionExpression() pulumi.StringPtrOutput

An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).

func (ApiOutput) BasePath added in v0.17.0 

func (o ApiOutput) BasePath() pulumi.StringPtrOutput

Specifies how to interpret the base path of the API during import. Valid values are “ignore“, “prepend“, and “split“. The default value is “ignore“. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.

func (ApiOutput) Body added in v0.17.0 

func (o ApiOutput) Body() pulumi.AnyOutput

The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a “Body“ or “BodyS3Location“. If you specify a “Body“ or “BodyS3Location“, don't specify CloudFormation resources such as “AWS::ApiGatewayV2::Authorizer“ or “AWS::ApiGatewayV2::Route“. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Api` for more information about the expected schema for this property.

func (ApiOutput) BodyS3Location added in v0.17.0 

func (o ApiOutput) BodyS3Location() ApiBodyS3LocationPtrOutput

The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a “Body“ or “BodyS3Location“. If you specify a “Body“ or “BodyS3Location“, don't specify CloudFormation resources such as “AWS::ApiGatewayV2::Authorizer“ or “AWS::ApiGatewayV2::Route“. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.

func (ApiOutput) CorsConfiguration added in v0.17.0 

func (o ApiOutput) CorsConfiguration() ApiCorsPtrOutput

A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.

func (ApiOutput) CredentialsArn added in v0.17.0 

func (o ApiOutput) CredentialsArn() pulumi.StringPtrOutput

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify “arn:aws:iam::*:user/*“. To use resource-based permissions on supported AWS services, specify “null“. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

func (ApiOutput) Description added in v0.17.0 

func (o ApiOutput) Description() pulumi.StringPtrOutput

The description of the API.

func (ApiOutput) DisableExecuteApiEndpoint added in v0.17.0 

func (o ApiOutput) DisableExecuteApiEndpoint() pulumi.BoolPtrOutput

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

func (ApiOutput) DisableSchemaValidation added in v0.17.0 

func (o ApiOutput) DisableSchemaValidation() pulumi.BoolPtrOutput

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

func (ApiOutput) ElementType 

func (ApiOutput) ElementType() reflect.Type

func (ApiOutput) FailOnWarnings added in v0.17.0 

func (o ApiOutput) FailOnWarnings() pulumi.BoolPtrOutput

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

func (ApiOutput) Name added in v0.17.0 

func (o ApiOutput) Name() pulumi.StringPtrOutput

The name of the API. Required unless you specify an OpenAPI definition for “Body“ or “S3BodyLocation“.

func (ApiOutput) ProtocolType added in v0.17.0 

func (o ApiOutput) ProtocolType() pulumi.StringPtrOutput

The API protocol. Valid values are “WEBSOCKET“ or “HTTP“. Required unless you specify an OpenAPI definition for “Body“ or “S3BodyLocation“.

func (ApiOutput) RouteKey added in v0.17.0 

func (o ApiOutput) RouteKey() pulumi.StringPtrOutput

This property is part of quick create. If you don't specify a “routeKey“, a default route of “$default“ is created. The “$default“ route acts as a catch-all for any request made to your API, for a particular stage. The “$default“ route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

func (ApiOutput) RouteSelectionExpression added in v0.17.0 

func (o ApiOutput) RouteSelectionExpression() pulumi.StringPtrOutput

The route selection expression for the API. For HTTP APIs, the “routeSelectionExpression“ must be “${request.method} ${request.path}“. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

func (ApiOutput) Tags added in v0.17.0 

func (o ApiOutput) Tags() pulumi.StringMapOutput

The collection of tags. Each tag element is associated with a given resource.

func (ApiOutput) Target added in v0.17.0 

func (o ApiOutput) Target() pulumi.StringPtrOutput

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

func (ApiOutput) ToApiOutput 

func (o ApiOutput) ToApiOutput() ApiOutput

func (ApiOutput) ToApiOutputWithContext 

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

func (ApiOutput) Version added in v0.17.0 

func (o ApiOutput) Version() pulumi.StringPtrOutput

A version identifier for the API.

type ApiState 

type ApiState struct {
}

func (ApiState) ElementType 

func (ApiState) ElementType() reflect.Type

type Authorizer 

type Authorizer struct {
	pulumi.CustomResourceState

	// The API identifier.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for “REQUEST“ authorizers.
	AuthorizerCredentialsArn pulumi.StringPtrOutput `pulumi:"authorizerCredentialsArn"`
	// The authorizer ID.
	AuthorizerId pulumi.StringOutput `pulumi:"authorizerId"`
	// Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are “1.0“ and “2.0“. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	AuthorizerPayloadFormatVersion pulumi.StringPtrOutput `pulumi:"authorizerPayloadFormatVersion"`
	// The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
	AuthorizerResultTtlInSeconds pulumi.IntPtrOutput `pulumi:"authorizerResultTtlInSeconds"`
	// The authorizer type. Specify “REQUEST“ for a Lambda function using incoming request parameters. Specify “JWT“ to use JSON Web Tokens (supported only for HTTP APIs).
	AuthorizerType pulumi.StringOutput `pulumi:"authorizerType"`
	// The authorizer's Uniform Resource Identifier (URI). For “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form: “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.
	AuthorizerUri pulumi.StringPtrOutput `pulumi:"authorizerUri"`
	// Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	EnableSimpleResponses pulumi.BoolPtrOutput `pulumi:"enableSimpleResponses"`
	// The identity source for which authorization is requested.
	//  For a “REQUEST“ authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with “$“, for example, “$request.header.Auth“, “$request.querystring.Name“. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	//  For “JWT“, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example “$request.header.Authorization“.
	IdentitySource pulumi.StringArrayOutput `pulumi:"identitySource"`
	// This parameter is not used.
	IdentityValidationExpression pulumi.StringPtrOutput `pulumi:"identityValidationExpression"`
	// The “JWTConfiguration“ property specifies the configuration of a JWT authorizer. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.
	JwtConfiguration AuthorizerJwtConfigurationPtrOutput `pulumi:"jwtConfiguration"`
	// The name of the authorizer.
	Name pulumi.StringOutput `pulumi:"name"`
}

The “AWS::ApiGatewayV2::Authorizer“ resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.

func GetAuthorizer 

func GetAuthorizer(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AuthorizerState, opts ...pulumi.ResourceOption) (*Authorizer, error)

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

func NewAuthorizer 

func NewAuthorizer(ctx *pulumi.Context,
	name string, args *AuthorizerArgs, opts ...pulumi.ResourceOption) (*Authorizer, error)

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

func (*Authorizer) ElementType 

func (*Authorizer) ElementType() reflect.Type

func (*Authorizer) ToAuthorizerOutput 

func (i *Authorizer) ToAuthorizerOutput() AuthorizerOutput

func (*Authorizer) ToAuthorizerOutputWithContext 

func (i *Authorizer) ToAuthorizerOutputWithContext(ctx context.Context) AuthorizerOutput

type AuthorizerArgs 

type AuthorizerArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput
	// Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for “REQUEST“ authorizers.
	AuthorizerCredentialsArn pulumi.StringPtrInput
	// Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are “1.0“ and “2.0“. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	AuthorizerPayloadFormatVersion pulumi.StringPtrInput
	// The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
	AuthorizerResultTtlInSeconds pulumi.IntPtrInput
	// The authorizer type. Specify “REQUEST“ for a Lambda function using incoming request parameters. Specify “JWT“ to use JSON Web Tokens (supported only for HTTP APIs).
	AuthorizerType pulumi.StringInput
	// The authorizer's Uniform Resource Identifier (URI). For “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form: “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.
	AuthorizerUri pulumi.StringPtrInput
	// Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	EnableSimpleResponses pulumi.BoolPtrInput
	// The identity source for which authorization is requested.
	//  For a “REQUEST“ authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with “$“, for example, “$request.header.Auth“, “$request.querystring.Name“. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	//  For “JWT“, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example “$request.header.Authorization“.
	IdentitySource pulumi.StringArrayInput
	// This parameter is not used.
	IdentityValidationExpression pulumi.StringPtrInput
	// The “JWTConfiguration“ property specifies the configuration of a JWT authorizer. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.
	JwtConfiguration AuthorizerJwtConfigurationPtrInput
	// The name of the authorizer.
	Name pulumi.StringPtrInput
}

The set of arguments for constructing a Authorizer resource.

func (AuthorizerArgs) ElementType 

func (AuthorizerArgs) ElementType() reflect.Type

type AuthorizerInput 

type AuthorizerInput interface {
	pulumi.Input

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

type AuthorizerJwtConfiguration added in v0.72.0 

type AuthorizerJwtConfiguration struct {
	// A list of the intended recipients of the JWT. A valid JWT must provide an “aud“ that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the “JWT“ authorizer type. Supported only for HTTP APIs.
	Audience []string `pulumi:"audience"`
	// The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: “https://cognito-idp.{region}.amazonaws.com/{userPoolId}“. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.
	Issuer *string `pulumi:"issuer"`
}

The “JWTConfiguration“ property specifies the configuration of a JWT authorizer. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

type AuthorizerJwtConfigurationArgs added in v0.72.0 

type AuthorizerJwtConfigurationArgs struct {
	// A list of the intended recipients of the JWT. A valid JWT must provide an “aud“ that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the “JWT“ authorizer type. Supported only for HTTP APIs.
	Audience pulumi.StringArrayInput `pulumi:"audience"`
	// The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: “https://cognito-idp.{region}.amazonaws.com/{userPoolId}“. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.
	Issuer pulumi.StringPtrInput `pulumi:"issuer"`
}

The “JWTConfiguration“ property specifies the configuration of a JWT authorizer. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

func (AuthorizerJwtConfigurationArgs) ElementType added in v0.72.0 

func (AuthorizerJwtConfigurationArgs) ElementType() reflect.Type

func (AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutput added in v0.72.0 

func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutput() AuthorizerJwtConfigurationOutput

func (AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutputWithContext added in v0.72.0 

func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationOutput

func (AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutput added in v0.72.0 

func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput

func (AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutputWithContext added in v0.72.0 

func (i AuthorizerJwtConfigurationArgs) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput

type AuthorizerJwtConfigurationInput added in v0.72.0 

type AuthorizerJwtConfigurationInput interface {
	pulumi.Input

	ToAuthorizerJwtConfigurationOutput() AuthorizerJwtConfigurationOutput
	ToAuthorizerJwtConfigurationOutputWithContext(context.Context) AuthorizerJwtConfigurationOutput
}

AuthorizerJwtConfigurationInput is an input type that accepts AuthorizerJwtConfigurationArgs and AuthorizerJwtConfigurationOutput values. You can construct a concrete instance of `AuthorizerJwtConfigurationInput` via: 

AuthorizerJwtConfigurationArgs{...}

type AuthorizerJwtConfigurationOutput added in v0.72.0 

type AuthorizerJwtConfigurationOutput struct{ *pulumi.OutputState }

The “JWTConfiguration“ property specifies the configuration of a JWT authorizer. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

func (AuthorizerJwtConfigurationOutput) Audience added in v0.72.0 

func (o AuthorizerJwtConfigurationOutput) Audience() pulumi.StringArrayOutput

A list of the intended recipients of the JWT. A valid JWT must provide an “aud“ that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

func (AuthorizerJwtConfigurationOutput) ElementType added in v0.72.0 

func (AuthorizerJwtConfigurationOutput) ElementType() reflect.Type

func (AuthorizerJwtConfigurationOutput) Issuer added in v0.72.0 

func (o AuthorizerJwtConfigurationOutput) Issuer() pulumi.StringPtrOutput

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: “https://cognito-idp.{region}.amazonaws.com/{userPoolId}“. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

func (AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutput added in v0.72.0 

func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutput() AuthorizerJwtConfigurationOutput

func (AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutputWithContext added in v0.72.0 

func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationOutput

func (AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutput added in v0.72.0 

func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput

func (AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext added in v0.72.0 

func (o AuthorizerJwtConfigurationOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput

type AuthorizerJwtConfigurationPtrInput added in v0.72.0 

type AuthorizerJwtConfigurationPtrInput interface {
	pulumi.Input

	ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput
	ToAuthorizerJwtConfigurationPtrOutputWithContext(context.Context) AuthorizerJwtConfigurationPtrOutput
}

AuthorizerJwtConfigurationPtrInput is an input type that accepts AuthorizerJwtConfigurationArgs, AuthorizerJwtConfigurationPtr and AuthorizerJwtConfigurationPtrOutput values. You can construct a concrete instance of `AuthorizerJwtConfigurationPtrInput` via: 

        AuthorizerJwtConfigurationArgs{...}

or:

        nil

func AuthorizerJwtConfigurationPtr added in v0.72.0 

func AuthorizerJwtConfigurationPtr(v *AuthorizerJwtConfigurationArgs) AuthorizerJwtConfigurationPtrInput

type AuthorizerJwtConfigurationPtrOutput added in v0.72.0 

type AuthorizerJwtConfigurationPtrOutput struct{ *pulumi.OutputState }

func (AuthorizerJwtConfigurationPtrOutput) Audience added in v0.72.0 

func (o AuthorizerJwtConfigurationPtrOutput) Audience() pulumi.StringArrayOutput

A list of the intended recipients of the JWT. A valid JWT must provide an “aud“ that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

func (AuthorizerJwtConfigurationPtrOutput) Elem added in v0.72.0 

func (o AuthorizerJwtConfigurationPtrOutput) Elem() AuthorizerJwtConfigurationOutput

func (AuthorizerJwtConfigurationPtrOutput) ElementType added in v0.72.0 

func (AuthorizerJwtConfigurationPtrOutput) ElementType() reflect.Type

func (AuthorizerJwtConfigurationPtrOutput) Issuer added in v0.72.0 

func (o AuthorizerJwtConfigurationPtrOutput) Issuer() pulumi.StringPtrOutput

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: “https://cognito-idp.{region}.amazonaws.com/{userPoolId}“. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

func (AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutput added in v0.72.0 

func (o AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutput() AuthorizerJwtConfigurationPtrOutput

func (AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext added in v0.72.0 

func (o AuthorizerJwtConfigurationPtrOutput) ToAuthorizerJwtConfigurationPtrOutputWithContext(ctx context.Context) AuthorizerJwtConfigurationPtrOutput

type AuthorizerOutput 

type AuthorizerOutput struct{ *pulumi.OutputState }

func (AuthorizerOutput) ApiId added in v0.17.0 

func (o AuthorizerOutput) ApiId() pulumi.StringOutput

The API identifier.

func (AuthorizerOutput) AuthorizerCredentialsArn added in v0.17.0 

func (o AuthorizerOutput) AuthorizerCredentialsArn() pulumi.StringPtrOutput

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for “REQUEST“ authorizers.

func (AuthorizerOutput) AuthorizerId added in v0.42.0 

func (o AuthorizerOutput) AuthorizerId() pulumi.StringOutput

The authorizer ID.

func (AuthorizerOutput) AuthorizerPayloadFormatVersion added in v0.17.0 

func (o AuthorizerOutput) AuthorizerPayloadFormatVersion() pulumi.StringPtrOutput

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are “1.0“ and “2.0“. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).

func (AuthorizerOutput) AuthorizerResultTtlInSeconds added in v0.17.0 

func (o AuthorizerOutput) AuthorizerResultTtlInSeconds() pulumi.IntPtrOutput

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

func (AuthorizerOutput) AuthorizerType added in v0.17.0 

func (o AuthorizerOutput) AuthorizerType() pulumi.StringOutput

The authorizer type. Specify “REQUEST“ for a Lambda function using incoming request parameters. Specify “JWT“ to use JSON Web Tokens (supported only for HTTP APIs).

func (AuthorizerOutput) AuthorizerUri added in v0.17.0 

func (o AuthorizerOutput) AuthorizerUri() pulumi.StringPtrOutput

The authorizer's Uniform Resource Identifier (URI). For “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form: “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.

func (AuthorizerOutput) ElementType 

func (AuthorizerOutput) ElementType() reflect.Type

func (AuthorizerOutput) EnableSimpleResponses added in v0.17.0 

func (o AuthorizerOutput) EnableSimpleResponses() pulumi.BoolPtrOutput

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).

func (AuthorizerOutput) IdentitySource added in v0.17.0 

func (o AuthorizerOutput) IdentitySource() pulumi.StringArrayOutput

The identity source for which authorization is requested. 

For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.

func (AuthorizerOutput) IdentityValidationExpression added in v0.17.0 

func (o AuthorizerOutput) IdentityValidationExpression() pulumi.StringPtrOutput

This parameter is not used.

func (AuthorizerOutput) JwtConfiguration added in v0.17.0 

func (o AuthorizerOutput) JwtConfiguration() AuthorizerJwtConfigurationPtrOutput

The “JWTConfiguration“ property specifies the configuration of a JWT authorizer. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

func (AuthorizerOutput) Name added in v0.17.0 

func (o AuthorizerOutput) Name() pulumi.StringOutput

The name of the authorizer.

func (AuthorizerOutput) ToAuthorizerOutput 

func (o AuthorizerOutput) ToAuthorizerOutput() AuthorizerOutput

func (AuthorizerOutput) ToAuthorizerOutputWithContext 

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

type AuthorizerState 

type AuthorizerState struct {
}

func (AuthorizerState) ElementType 

func (AuthorizerState) ElementType() reflect.Type

type Deployment 

type Deployment struct {
	pulumi.CustomResourceState

	// The API identifier.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// The deployment ID.
	DeploymentId pulumi.StringOutput `pulumi:"deploymentId"`
	// The description for the deployment resource.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of an existing stage to associate with the deployment.
	StageName pulumi.StringPtrOutput `pulumi:"stageName"`
}

The “AWS::ApiGatewayV2::Deployment“ resource creates a deployment for an API.

func GetDeployment 

func GetDeployment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DeploymentState, opts ...pulumi.ResourceOption) (*Deployment, error)

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

func NewDeployment 

func NewDeployment(ctx *pulumi.Context,
	name string, args *DeploymentArgs, opts ...pulumi.ResourceOption) (*Deployment, error)

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

func (*Deployment) ElementType 

func (*Deployment) ElementType() reflect.Type

func (*Deployment) ToDeploymentOutput 

func (i *Deployment) ToDeploymentOutput() DeploymentOutput

func (*Deployment) ToDeploymentOutputWithContext 

func (i *Deployment) ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput

type DeploymentArgs 

type DeploymentArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput
	// The description for the deployment resource.
	Description pulumi.StringPtrInput
	// The name of an existing stage to associate with the deployment.
	StageName pulumi.StringPtrInput
}

The set of arguments for constructing a Deployment resource.

func (DeploymentArgs) ElementType 

func (DeploymentArgs) ElementType() reflect.Type

type DeploymentInput 

type DeploymentInput interface {
	pulumi.Input

	ToDeploymentOutput() DeploymentOutput
	ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput
}

type DeploymentOutput 

type DeploymentOutput struct{ *pulumi.OutputState }

func (DeploymentOutput) ApiId added in v0.17.0 

func (o DeploymentOutput) ApiId() pulumi.StringOutput

The API identifier.

func (DeploymentOutput) DeploymentId added in v0.40.0 

func (o DeploymentOutput) DeploymentId() pulumi.StringOutput

The deployment ID.

func (DeploymentOutput) Description added in v0.17.0 

func (o DeploymentOutput) Description() pulumi.StringPtrOutput

The description for the deployment resource.

func (DeploymentOutput) ElementType 

func (DeploymentOutput) ElementType() reflect.Type

func (DeploymentOutput) StageName added in v0.17.0 

func (o DeploymentOutput) StageName() pulumi.StringPtrOutput

The name of an existing stage to associate with the deployment.

func (DeploymentOutput) ToDeploymentOutput 

func (o DeploymentOutput) ToDeploymentOutput() DeploymentOutput

func (DeploymentOutput) ToDeploymentOutputWithContext 

func (o DeploymentOutput) ToDeploymentOutputWithContext(ctx context.Context) DeploymentOutput

type DeploymentState 

type DeploymentState struct {
}

func (DeploymentState) ElementType 

func (DeploymentState) ElementType() reflect.Type

type DomainName 

type DomainName struct {
	pulumi.CustomResourceState

	// The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// The domain name configurations.
	DomainNameConfigurations DomainNameConfigurationArrayOutput `pulumi:"domainNameConfigurations"`
	// The mutual TLS authentication configuration for a custom domain name.
	MutualTlsAuthentication DomainNameMutualTlsAuthenticationPtrOutput `pulumi:"mutualTlsAuthentication"`
	// The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name.
	RegionalDomainName pulumi.StringOutput `pulumi:"regionalDomainName"`
	// The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
	RegionalHostedZoneId pulumi.StringOutput `pulumi:"regionalHostedZoneId"`
	// The collection of tags associated with a domain name.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

The “AWS::ApiGatewayV2::DomainName“ resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). 

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.

func GetDomainName 

func GetDomainName(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainNameState, opts ...pulumi.ResourceOption) (*DomainName, error)

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

func NewDomainName 

func NewDomainName(ctx *pulumi.Context,
	name string, args *DomainNameArgs, opts ...pulumi.ResourceOption) (*DomainName, error)

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

func (*DomainName) ElementType 

func (*DomainName) ElementType() reflect.Type

func (*DomainName) ToDomainNameOutput 

func (i *DomainName) ToDomainNameOutput() DomainNameOutput

func (*DomainName) ToDomainNameOutputWithContext 

func (i *DomainName) ToDomainNameOutputWithContext(ctx context.Context) DomainNameOutput

type DomainNameArgs 

type DomainNameArgs struct {
	// The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
	DomainName pulumi.StringInput
	// The domain name configurations.
	DomainNameConfigurations DomainNameConfigurationArrayInput
	// The mutual TLS authentication configuration for a custom domain name.
	MutualTlsAuthentication DomainNameMutualTlsAuthenticationPtrInput
	// The collection of tags associated with a domain name.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a DomainName resource.

func (DomainNameArgs) ElementType 

func (DomainNameArgs) ElementType() reflect.Type

type DomainNameConfiguration added in v0.2.0 

type DomainNameConfiguration struct {
	// An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
	CertificateArn *string `pulumi:"certificateArn"`
	// The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
	CertificateName *string `pulumi:"certificateName"`
	// The endpoint type.
	EndpointType *string `pulumi:"endpointType"`
	// The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
	OwnershipVerificationCertificateArn *string `pulumi:"ownershipVerificationCertificateArn"`
	// The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are “TLS_1_0“ and “TLS_1_2“.
	SecurityPolicy *string `pulumi:"securityPolicy"`
}

The “DomainNameConfiguration“ property type specifies the configuration for an API's domain name. 

``DomainNameConfiguration`` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource.

type DomainNameConfigurationArgs added in v0.2.0 

type DomainNameConfigurationArgs struct {
	// An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
	CertificateArn pulumi.StringPtrInput `pulumi:"certificateArn"`
	// The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
	CertificateName pulumi.StringPtrInput `pulumi:"certificateName"`
	// The endpoint type.
	EndpointType pulumi.StringPtrInput `pulumi:"endpointType"`
	// The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
	OwnershipVerificationCertificateArn pulumi.StringPtrInput `pulumi:"ownershipVerificationCertificateArn"`
	// The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are “TLS_1_0“ and “TLS_1_2“.
	SecurityPolicy pulumi.StringPtrInput `pulumi:"securityPolicy"`
}

The “DomainNameConfiguration“ property type specifies the configuration for an API's domain name. 

``DomainNameConfiguration`` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource.

func (DomainNameConfigurationArgs) ElementType added in v0.2.0 

func (DomainNameConfigurationArgs) ElementType() reflect.Type

func (DomainNameConfigurationArgs) ToDomainNameConfigurationOutput added in v0.2.0 

func (i DomainNameConfigurationArgs) ToDomainNameConfigurationOutput() DomainNameConfigurationOutput

func (DomainNameConfigurationArgs) ToDomainNameConfigurationOutputWithContext added in v0.2.0 

func (i DomainNameConfigurationArgs) ToDomainNameConfigurationOutputWithContext(ctx context.Context) DomainNameConfigurationOutput

type DomainNameConfigurationArray added in v0.2.0 

type DomainNameConfigurationArray []DomainNameConfigurationInput

func (DomainNameConfigurationArray) ElementType added in v0.2.0 

func (DomainNameConfigurationArray) ElementType() reflect.Type

func (DomainNameConfigurationArray) ToDomainNameConfigurationArrayOutput added in v0.2.0 

func (i DomainNameConfigurationArray) ToDomainNameConfigurationArrayOutput() DomainNameConfigurationArrayOutput

func (DomainNameConfigurationArray) ToDomainNameConfigurationArrayOutputWithContext added in v0.2.0 

func (i DomainNameConfigurationArray) ToDomainNameConfigurationArrayOutputWithContext(ctx context.Context) DomainNameConfigurationArrayOutput

type DomainNameConfigurationArrayInput added in v0.2.0 

type DomainNameConfigurationArrayInput interface {
	pulumi.Input

	ToDomainNameConfigurationArrayOutput() DomainNameConfigurationArrayOutput
	ToDomainNameConfigurationArrayOutputWithContext(context.Context) DomainNameConfigurationArrayOutput
}

DomainNameConfigurationArrayInput is an input type that accepts DomainNameConfigurationArray and DomainNameConfigurationArrayOutput values. You can construct a concrete instance of `DomainNameConfigurationArrayInput` via: 

DomainNameConfigurationArray{ DomainNameConfigurationArgs{...} }

type DomainNameConfigurationArrayOutput added in v0.2.0 

type DomainNameConfigurationArrayOutput struct{ *pulumi.OutputState }

func (DomainNameConfigurationArrayOutput) ElementType added in v0.2.0 

func (DomainNameConfigurationArrayOutput) ElementType() reflect.Type

func (DomainNameConfigurationArrayOutput) Index added in v0.2.0 

func (o DomainNameConfigurationArrayOutput) Index(i pulumi.IntInput) DomainNameConfigurationOutput

func (DomainNameConfigurationArrayOutput) ToDomainNameConfigurationArrayOutput added in v0.2.0 

func (o DomainNameConfigurationArrayOutput) ToDomainNameConfigurationArrayOutput() DomainNameConfigurationArrayOutput

func (DomainNameConfigurationArrayOutput) ToDomainNameConfigurationArrayOutputWithContext added in v0.2.0 

func (o DomainNameConfigurationArrayOutput) ToDomainNameConfigurationArrayOutputWithContext(ctx context.Context) DomainNameConfigurationArrayOutput

type DomainNameConfigurationInput added in v0.2.0 

type DomainNameConfigurationInput interface {
	pulumi.Input

	ToDomainNameConfigurationOutput() DomainNameConfigurationOutput
	ToDomainNameConfigurationOutputWithContext(context.Context) DomainNameConfigurationOutput
}

DomainNameConfigurationInput is an input type that accepts DomainNameConfigurationArgs and DomainNameConfigurationOutput values. You can construct a concrete instance of `DomainNameConfigurationInput` via: 

DomainNameConfigurationArgs{...}

type DomainNameConfigurationOutput added in v0.2.0 

type DomainNameConfigurationOutput struct{ *pulumi.OutputState }

The “DomainNameConfiguration“ property type specifies the configuration for an API's domain name. 

``DomainNameConfiguration`` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource.

func (DomainNameConfigurationOutput) CertificateArn added in v0.2.0 

func (o DomainNameConfigurationOutput) CertificateArn() pulumi.StringPtrOutput

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

func (DomainNameConfigurationOutput) CertificateName added in v0.2.0 

func (o DomainNameConfigurationOutput) CertificateName() pulumi.StringPtrOutput

The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

func (DomainNameConfigurationOutput) ElementType added in v0.2.0 

func (DomainNameConfigurationOutput) ElementType() reflect.Type

func (DomainNameConfigurationOutput) EndpointType added in v0.2.0 

func (o DomainNameConfigurationOutput) EndpointType() pulumi.StringPtrOutput

The endpoint type.

func (DomainNameConfigurationOutput) OwnershipVerificationCertificateArn added in v0.2.0 

func (o DomainNameConfigurationOutput) OwnershipVerificationCertificateArn() pulumi.StringPtrOutput

The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.

func (DomainNameConfigurationOutput) SecurityPolicy added in v0.2.0 

func (o DomainNameConfigurationOutput) SecurityPolicy() pulumi.StringPtrOutput

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are “TLS_1_0“ and “TLS_1_2“.

func (DomainNameConfigurationOutput) ToDomainNameConfigurationOutput added in v0.2.0 

func (o DomainNameConfigurationOutput) ToDomainNameConfigurationOutput() DomainNameConfigurationOutput

func (DomainNameConfigurationOutput) ToDomainNameConfigurationOutputWithContext added in v0.2.0 

func (o DomainNameConfigurationOutput) ToDomainNameConfigurationOutputWithContext(ctx context.Context) DomainNameConfigurationOutput

type DomainNameInput 

type DomainNameInput interface {
	pulumi.Input

	ToDomainNameOutput() DomainNameOutput
	ToDomainNameOutputWithContext(ctx context.Context) DomainNameOutput
}

type DomainNameMutualTlsAuthentication 

type DomainNameMutualTlsAuthentication struct {
	// An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, “s3://bucket-name/key-name“. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
	TruststoreUri *string `pulumi:"truststoreUri"`
	// The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
	TruststoreVersion *string `pulumi:"truststoreVersion"`
}

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

type DomainNameMutualTlsAuthenticationArgs 

type DomainNameMutualTlsAuthenticationArgs struct {
	// An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, “s3://bucket-name/key-name“. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
	TruststoreUri pulumi.StringPtrInput `pulumi:"truststoreUri"`
	// The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
	TruststoreVersion pulumi.StringPtrInput `pulumi:"truststoreVersion"`
}

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

func (DomainNameMutualTlsAuthenticationArgs) ElementType 

func (DomainNameMutualTlsAuthenticationArgs) ElementType() reflect.Type

func (DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationOutput 

func (i DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationOutput() DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationOutputWithContext 

func (i DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationPtrOutput 

func (i DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext 

func (i DomainNameMutualTlsAuthenticationArgs) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationPtrOutput

type DomainNameMutualTlsAuthenticationInput 

type DomainNameMutualTlsAuthenticationInput interface {
	pulumi.Input

	ToDomainNameMutualTlsAuthenticationOutput() DomainNameMutualTlsAuthenticationOutput
	ToDomainNameMutualTlsAuthenticationOutputWithContext(context.Context) DomainNameMutualTlsAuthenticationOutput
}

DomainNameMutualTlsAuthenticationInput is an input type that accepts DomainNameMutualTlsAuthenticationArgs and DomainNameMutualTlsAuthenticationOutput values. You can construct a concrete instance of `DomainNameMutualTlsAuthenticationInput` via: 

DomainNameMutualTlsAuthenticationArgs{...}

type DomainNameMutualTlsAuthenticationOutput 

type DomainNameMutualTlsAuthenticationOutput struct{ *pulumi.OutputState }

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

func (DomainNameMutualTlsAuthenticationOutput) ElementType 

func (DomainNameMutualTlsAuthenticationOutput) ElementType() reflect.Type

func (DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationOutput 

func (o DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationOutput() DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationOutputWithContext 

func (o DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationPtrOutput 

func (o DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext 

func (o DomainNameMutualTlsAuthenticationOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationOutput) TruststoreUri 

func (o DomainNameMutualTlsAuthenticationOutput) TruststoreUri() pulumi.StringPtrOutput

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, “s3://bucket-name/key-name“. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

func (DomainNameMutualTlsAuthenticationOutput) TruststoreVersion 

func (o DomainNameMutualTlsAuthenticationOutput) TruststoreVersion() pulumi.StringPtrOutput

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

type DomainNameMutualTlsAuthenticationPtrInput 

type DomainNameMutualTlsAuthenticationPtrInput interface {
	pulumi.Input

	ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput
	ToDomainNameMutualTlsAuthenticationPtrOutputWithContext(context.Context) DomainNameMutualTlsAuthenticationPtrOutput
}

DomainNameMutualTlsAuthenticationPtrInput is an input type that accepts DomainNameMutualTlsAuthenticationArgs, DomainNameMutualTlsAuthenticationPtr and DomainNameMutualTlsAuthenticationPtrOutput values. You can construct a concrete instance of `DomainNameMutualTlsAuthenticationPtrInput` via: 

        DomainNameMutualTlsAuthenticationArgs{...}

or:

        nil

func DomainNameMutualTlsAuthenticationPtr 

func DomainNameMutualTlsAuthenticationPtr(v *DomainNameMutualTlsAuthenticationArgs) DomainNameMutualTlsAuthenticationPtrInput

type DomainNameMutualTlsAuthenticationPtrOutput 

type DomainNameMutualTlsAuthenticationPtrOutput struct{ *pulumi.OutputState }

func (DomainNameMutualTlsAuthenticationPtrOutput) Elem 

func (o DomainNameMutualTlsAuthenticationPtrOutput) Elem() DomainNameMutualTlsAuthenticationOutput

func (DomainNameMutualTlsAuthenticationPtrOutput) ElementType 

func (DomainNameMutualTlsAuthenticationPtrOutput) ElementType() reflect.Type

func (DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutput 

func (o DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutput() DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext 

func (o DomainNameMutualTlsAuthenticationPtrOutput) ToDomainNameMutualTlsAuthenticationPtrOutputWithContext(ctx context.Context) DomainNameMutualTlsAuthenticationPtrOutput

func (DomainNameMutualTlsAuthenticationPtrOutput) TruststoreUri 

func (o DomainNameMutualTlsAuthenticationPtrOutput) TruststoreUri() pulumi.StringPtrOutput

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, “s3://bucket-name/key-name“. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

func (DomainNameMutualTlsAuthenticationPtrOutput) TruststoreVersion 

func (o DomainNameMutualTlsAuthenticationPtrOutput) TruststoreVersion() pulumi.StringPtrOutput

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

type DomainNameOutput 

type DomainNameOutput struct{ *pulumi.OutputState }

func (DomainNameOutput) DomainName added in v0.17.0 

func (o DomainNameOutput) DomainName() pulumi.StringOutput

The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.

func (DomainNameOutput) DomainNameConfigurations added in v0.17.0 

func (o DomainNameOutput) DomainNameConfigurations() DomainNameConfigurationArrayOutput

The domain name configurations.

func (DomainNameOutput) ElementType 

func (DomainNameOutput) ElementType() reflect.Type

func (DomainNameOutput) MutualTlsAuthentication added in v0.17.0 

func (o DomainNameOutput) MutualTlsAuthentication() DomainNameMutualTlsAuthenticationPtrOutput

The mutual TLS authentication configuration for a custom domain name.

func (DomainNameOutput) RegionalDomainName added in v0.17.0 

func (o DomainNameOutput) RegionalDomainName() pulumi.StringOutput

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name.

func (DomainNameOutput) RegionalHostedZoneId added in v0.17.0 

func (o DomainNameOutput) RegionalHostedZoneId() pulumi.StringOutput

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

func (DomainNameOutput) Tags added in v0.17.0 

func (o DomainNameOutput) Tags() pulumi.StringMapOutput

The collection of tags associated with a domain name.

func (DomainNameOutput) ToDomainNameOutput 

func (o DomainNameOutput) ToDomainNameOutput() DomainNameOutput

func (DomainNameOutput) ToDomainNameOutputWithContext 

func (o DomainNameOutput) ToDomainNameOutputWithContext(ctx context.Context) DomainNameOutput

type DomainNameState 

type DomainNameState struct {
}

func (DomainNameState) ElementType 

func (DomainNameState) ElementType() reflect.Type

type IntegrationResponse 

type IntegrationResponse struct {
	pulumi.CustomResourceState

	// The API identifier.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors:
	//   “CONVERT_TO_BINARY“: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
	//   “CONVERT_TO_TEXT“: Converts a response payload from a binary blob to a Base64-encoded string.
	//  If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
	ContentHandlingStrategy pulumi.StringPtrOutput `pulumi:"contentHandlingStrategy"`
	// The integration ID.
	IntegrationId pulumi.StringOutput `pulumi:"integrationId"`
	// The integration response ID.
	IntegrationResponseId pulumi.StringOutput `pulumi:"integrationResponseId"`
	// The integration response key.
	IntegrationResponseKey pulumi.StringOutput `pulumi:"integrationResponseKey"`
	// A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of “method.response.header.{name}“, where name is a valid and unique header name. The mapped non-static value must match the pattern of “integration.response.header.{name}“ or “integration.response.body.{JSON-expression}“, where “{name}“ is a valid and unique response header name and “{JSON-expression}“ is a valid JSON expression without the “$“ prefix.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
	ResponseParameters pulumi.AnyOutput `pulumi:"responseParameters"`
	// The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
	ResponseTemplates pulumi.AnyOutput `pulumi:"responseTemplates"`
	// The template selection expression for the integration response. Supported only for WebSocket APIs.
	TemplateSelectionExpression pulumi.StringPtrOutput `pulumi:"templateSelectionExpression"`
}

The “AWS::ApiGatewayV2::IntegrationResponse“ resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.

func GetIntegrationResponse 

func GetIntegrationResponse(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *IntegrationResponseState, opts ...pulumi.ResourceOption) (*IntegrationResponse, error)

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

func NewIntegrationResponse 

func NewIntegrationResponse(ctx *pulumi.Context,
	name string, args *IntegrationResponseArgs, opts ...pulumi.ResourceOption) (*IntegrationResponse, error)

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

func (*IntegrationResponse) ElementType 

func (*IntegrationResponse) ElementType() reflect.Type

func (*IntegrationResponse) ToIntegrationResponseOutput 

func (i *IntegrationResponse) ToIntegrationResponseOutput() IntegrationResponseOutput

func (*IntegrationResponse) ToIntegrationResponseOutputWithContext 

func (i *IntegrationResponse) ToIntegrationResponseOutputWithContext(ctx context.Context) IntegrationResponseOutput

type IntegrationResponseArgs 

type IntegrationResponseArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput
	// Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors:
	//   “CONVERT_TO_BINARY“: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
	//   “CONVERT_TO_TEXT“: Converts a response payload from a binary blob to a Base64-encoded string.
	//  If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
	ContentHandlingStrategy pulumi.StringPtrInput
	// The integration ID.
	IntegrationId pulumi.StringInput
	// The integration response key.
	IntegrationResponseKey pulumi.StringInput
	// A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of “method.response.header.{name}“, where name is a valid and unique header name. The mapped non-static value must match the pattern of “integration.response.header.{name}“ or “integration.response.body.{JSON-expression}“, where “{name}“ is a valid and unique response header name and “{JSON-expression}“ is a valid JSON expression without the “$“ prefix.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
	ResponseParameters pulumi.Input
	// The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
	ResponseTemplates pulumi.Input
	// The template selection expression for the integration response. Supported only for WebSocket APIs.
	TemplateSelectionExpression pulumi.StringPtrInput
}

The set of arguments for constructing a IntegrationResponse resource.

func (IntegrationResponseArgs) ElementType 

func (IntegrationResponseArgs) ElementType() reflect.Type

type IntegrationResponseInput 

type IntegrationResponseInput interface {
	pulumi.Input

	ToIntegrationResponseOutput() IntegrationResponseOutput
	ToIntegrationResponseOutputWithContext(ctx context.Context) IntegrationResponseOutput
}

type IntegrationResponseOutput 

type IntegrationResponseOutput struct{ *pulumi.OutputState }

func (IntegrationResponseOutput) ApiId added in v0.17.0 

func (o IntegrationResponseOutput) ApiId() pulumi.StringOutput

The API identifier.

func (IntegrationResponseOutput) ContentHandlingStrategy added in v0.17.0 

func (o IntegrationResponseOutput) ContentHandlingStrategy() pulumi.StringPtrOutput

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors: 

 ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
 ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

func (IntegrationResponseOutput) ElementType 

func (IntegrationResponseOutput) ElementType() reflect.Type

func (IntegrationResponseOutput) IntegrationId added in v0.17.0 

func (o IntegrationResponseOutput) IntegrationId() pulumi.StringOutput

The integration ID.

func (IntegrationResponseOutput) IntegrationResponseId added in v0.60.0 

func (o IntegrationResponseOutput) IntegrationResponseId() pulumi.StringOutput

The integration response ID.

func (IntegrationResponseOutput) IntegrationResponseKey added in v0.17.0 

func (o IntegrationResponseOutput) IntegrationResponseKey() pulumi.StringOutput

The integration response key.

func (IntegrationResponseOutput) ResponseParameters added in v0.17.0 

func (o IntegrationResponseOutput) ResponseParameters() pulumi.AnyOutput

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of “method.response.header.{name}“, where name is a valid and unique header name. The mapped non-static value must match the pattern of “integration.response.header.{name}“ or “integration.response.body.{JSON-expression}“, where “{name}“ is a valid and unique response header name and “{JSON-expression}“ is a valid JSON expression without the “$“ prefix.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.

func (IntegrationResponseOutput) ResponseTemplates added in v0.17.0 

func (o IntegrationResponseOutput) ResponseTemplates() pulumi.AnyOutput

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.

func (IntegrationResponseOutput) TemplateSelectionExpression added in v0.17.0 

func (o IntegrationResponseOutput) TemplateSelectionExpression() pulumi.StringPtrOutput

The template selection expression for the integration response. Supported only for WebSocket APIs.

func (IntegrationResponseOutput) ToIntegrationResponseOutput 

func (o IntegrationResponseOutput) ToIntegrationResponseOutput() IntegrationResponseOutput

func (IntegrationResponseOutput) ToIntegrationResponseOutputWithContext 

func (o IntegrationResponseOutput) ToIntegrationResponseOutputWithContext(ctx context.Context) IntegrationResponseOutput

type IntegrationResponseState 

type IntegrationResponseState struct {
}

func (IntegrationResponseState) ElementType 

func (IntegrationResponseState) ElementType() reflect.Type

type LookupApiArgs added in v0.12.0 

type LookupApiArgs struct {
	// The API identifier.
	ApiId string `pulumi:"apiId"`
}

type LookupApiMappingArgs added in v0.12.0 

type LookupApiMappingArgs struct {
	// The API mapping resource ID.
	ApiMappingId string `pulumi:"apiMappingId"`
	// The domain name.
	DomainName string `pulumi:"domainName"`
}

type LookupApiMappingOutputArgs added in v0.12.0 

type LookupApiMappingOutputArgs struct {
	// The API mapping resource ID.
	ApiMappingId pulumi.StringInput `pulumi:"apiMappingId"`
	// The domain name.
	DomainName pulumi.StringInput `pulumi:"domainName"`
}

func (LookupApiMappingOutputArgs) ElementType added in v0.12.0 

func (LookupApiMappingOutputArgs) ElementType() reflect.Type

type LookupApiMappingResult added in v0.12.0 

type LookupApiMappingResult struct {
	// The identifier of the API.
	ApiId *string `pulumi:"apiId"`
	// The API mapping resource ID.
	ApiMappingId *string `pulumi:"apiMappingId"`
	// The API mapping key.
	ApiMappingKey *string `pulumi:"apiMappingKey"`
	// The API stage.
	Stage *string `pulumi:"stage"`
}

func LookupApiMapping added in v0.12.0 

func LookupApiMapping(ctx *pulumi.Context, args *LookupApiMappingArgs, opts ...pulumi.InvokeOption) (*LookupApiMappingResult, error)

The “AWS::ApiGatewayV2::ApiMapping“ resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.

type LookupApiMappingResultOutput added in v0.12.0 

type LookupApiMappingResultOutput struct{ *pulumi.OutputState }

func LookupApiMappingOutput added in v0.12.0 

func LookupApiMappingOutput(ctx *pulumi.Context, args LookupApiMappingOutputArgs, opts ...pulumi.InvokeOption) LookupApiMappingResultOutput

func (LookupApiMappingResultOutput) ApiId added in v0.50.0 

func (o LookupApiMappingResultOutput) ApiId() pulumi.StringPtrOutput

The identifier of the API.

func (LookupApiMappingResultOutput) ApiMappingId added in v0.68.0 

func (o LookupApiMappingResultOutput) ApiMappingId() pulumi.StringPtrOutput

The API mapping resource ID.

func (LookupApiMappingResultOutput) ApiMappingKey added in v0.12.0 

func (o LookupApiMappingResultOutput) ApiMappingKey() pulumi.StringPtrOutput

The API mapping key.

func (LookupApiMappingResultOutput) ElementType added in v0.12.0 

func (LookupApiMappingResultOutput) ElementType() reflect.Type

func (LookupApiMappingResultOutput) Stage added in v0.12.0 

func (o LookupApiMappingResultOutput) Stage() pulumi.StringPtrOutput

The API stage.

func (LookupApiMappingResultOutput) ToLookupApiMappingResultOutput added in v0.12.0 

func (o LookupApiMappingResultOutput) ToLookupApiMappingResultOutput() LookupApiMappingResultOutput

func (LookupApiMappingResultOutput) ToLookupApiMappingResultOutputWithContext added in v0.12.0 

func (o LookupApiMappingResultOutput) ToLookupApiMappingResultOutputWithContext(ctx context.Context) LookupApiMappingResultOutput

type LookupApiOutputArgs added in v0.12.0 

type LookupApiOutputArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput `pulumi:"apiId"`
}

func (LookupApiOutputArgs) ElementType added in v0.12.0 

func (LookupApiOutputArgs) ElementType() reflect.Type

type LookupApiResult added in v0.12.0 

type LookupApiResult struct {
	// The default endpoint for an API. For example: `https://abcdef.execute-api.us-west-2.amazonaws.com` .
	ApiEndpoint *string `pulumi:"apiEndpoint"`
	// The API identifier.
	ApiId *string `pulumi:"apiId"`
	// An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
	ApiKeySelectionExpression *string `pulumi:"apiKeySelectionExpression"`
	// A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
	CorsConfiguration *ApiCors `pulumi:"corsConfiguration"`
	// The description of the API.
	Description *string `pulumi:"description"`
	// Specifies 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.
	DisableExecuteApiEndpoint *bool `pulumi:"disableExecuteApiEndpoint"`
	// The name of the API. Required unless you specify an OpenAPI definition for “Body“ or “S3BodyLocation“.
	Name *string `pulumi:"name"`
	// The route selection expression for the API. For HTTP APIs, the “routeSelectionExpression“ must be “${request.method} ${request.path}“. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
	RouteSelectionExpression *string `pulumi:"routeSelectionExpression"`
	// The collection of tags. Each tag element is associated with a given resource.
	Tags map[string]string `pulumi:"tags"`
	// A version identifier for the API.
	Version *string `pulumi:"version"`
}

func LookupApi added in v0.12.0 

func LookupApi(ctx *pulumi.Context, args *LookupApiArgs, opts ...pulumi.InvokeOption) (*LookupApiResult, error)

The “AWS::ApiGatewayV2::Api“ resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*

type LookupApiResultOutput added in v0.12.0 

type LookupApiResultOutput struct{ *pulumi.OutputState }

func LookupApiOutput added in v0.12.0 

func LookupApiOutput(ctx *pulumi.Context, args LookupApiOutputArgs, opts ...pulumi.InvokeOption) LookupApiResultOutput

func (LookupApiResultOutput) ApiEndpoint added in v0.12.0 

func (o LookupApiResultOutput) ApiEndpoint() pulumi.StringPtrOutput

The default endpoint for an API. For example: `https://abcdef.execute-api.us-west-2.amazonaws.com` .

func (LookupApiResultOutput) ApiId added in v0.40.0 

func (o LookupApiResultOutput) ApiId() pulumi.StringPtrOutput

The API identifier.

func (LookupApiResultOutput) ApiKeySelectionExpression added in v0.12.0 

func (o LookupApiResultOutput) ApiKeySelectionExpression() pulumi.StringPtrOutput

An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).

func (LookupApiResultOutput) CorsConfiguration added in v0.12.0 

func (o LookupApiResultOutput) CorsConfiguration() ApiCorsPtrOutput

A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.

func (LookupApiResultOutput) Description added in v0.12.0 

func (o LookupApiResultOutput) Description() pulumi.StringPtrOutput

The description of the API.

func (LookupApiResultOutput) DisableExecuteApiEndpoint added in v0.12.0 

func (o LookupApiResultOutput) DisableExecuteApiEndpoint() pulumi.BoolPtrOutput

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

func (LookupApiResultOutput) ElementType added in v0.12.0 

func (LookupApiResultOutput) ElementType() reflect.Type

func (LookupApiResultOutput) Name added in v0.12.0 

func (o LookupApiResultOutput) Name() pulumi.StringPtrOutput

The name of the API. Required unless you specify an OpenAPI definition for “Body“ or “S3BodyLocation“.

func (LookupApiResultOutput) RouteSelectionExpression added in v0.12.0 

func (o LookupApiResultOutput) RouteSelectionExpression() pulumi.StringPtrOutput

The route selection expression for the API. For HTTP APIs, the “routeSelectionExpression“ must be “${request.method} ${request.path}“. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

func (LookupApiResultOutput) Tags added in v0.12.0 

func (o LookupApiResultOutput) Tags() pulumi.StringMapOutput

The collection of tags. Each tag element is associated with a given resource.

func (LookupApiResultOutput) ToLookupApiResultOutput added in v0.12.0 

func (o LookupApiResultOutput) ToLookupApiResultOutput() LookupApiResultOutput

func (LookupApiResultOutput) ToLookupApiResultOutputWithContext added in v0.12.0 

func (o LookupApiResultOutput) ToLookupApiResultOutputWithContext(ctx context.Context) LookupApiResultOutput

func (LookupApiResultOutput) Version added in v0.12.0 

func (o LookupApiResultOutput) Version() pulumi.StringPtrOutput

A version identifier for the API.

type LookupAuthorizerArgs added in v0.12.0 

type LookupAuthorizerArgs struct {
	// The API identifier.
	ApiId string `pulumi:"apiId"`
	// The authorizer ID.
	AuthorizerId string `pulumi:"authorizerId"`
}

type LookupAuthorizerOutputArgs added in v0.12.0 

type LookupAuthorizerOutputArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput `pulumi:"apiId"`
	// The authorizer ID.
	AuthorizerId pulumi.StringInput `pulumi:"authorizerId"`
}

func (LookupAuthorizerOutputArgs) ElementType added in v0.12.0 

func (LookupAuthorizerOutputArgs) ElementType() reflect.Type

type LookupAuthorizerResult added in v0.12.0 

type LookupAuthorizerResult struct {
	// Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for “REQUEST“ authorizers.
	AuthorizerCredentialsArn *string `pulumi:"authorizerCredentialsArn"`
	// The authorizer ID.
	AuthorizerId *string `pulumi:"authorizerId"`
	// Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are “1.0“ and “2.0“. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	AuthorizerPayloadFormatVersion *string `pulumi:"authorizerPayloadFormatVersion"`
	// The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
	AuthorizerResultTtlInSeconds *int `pulumi:"authorizerResultTtlInSeconds"`
	// The authorizer type. Specify “REQUEST“ for a Lambda function using incoming request parameters. Specify “JWT“ to use JSON Web Tokens (supported only for HTTP APIs).
	AuthorizerType *string `pulumi:"authorizerType"`
	// The authorizer's Uniform Resource Identifier (URI). For “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form: “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.
	AuthorizerUri *string `pulumi:"authorizerUri"`
	// Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	EnableSimpleResponses *bool `pulumi:"enableSimpleResponses"`
	// The identity source for which authorization is requested.
	//  For a “REQUEST“ authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with “$“, for example, “$request.header.Auth“, “$request.querystring.Name“. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
	//  For “JWT“, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example “$request.header.Authorization“.
	IdentitySource []string `pulumi:"identitySource"`
	// This parameter is not used.
	IdentityValidationExpression *string `pulumi:"identityValidationExpression"`
	// The “JWTConfiguration“ property specifies the configuration of a JWT authorizer. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.
	JwtConfiguration *AuthorizerJwtConfiguration `pulumi:"jwtConfiguration"`
	// The name of the authorizer.
	Name *string `pulumi:"name"`
}

func LookupAuthorizer added in v0.12.0 

func LookupAuthorizer(ctx *pulumi.Context, args *LookupAuthorizerArgs, opts ...pulumi.InvokeOption) (*LookupAuthorizerResult, error)

The “AWS::ApiGatewayV2::Authorizer“ resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.

type LookupAuthorizerResultOutput added in v0.12.0 

type LookupAuthorizerResultOutput struct{ *pulumi.OutputState }

func LookupAuthorizerOutput added in v0.12.0 

func LookupAuthorizerOutput(ctx *pulumi.Context, args LookupAuthorizerOutputArgs, opts ...pulumi.InvokeOption) LookupAuthorizerResultOutput

func (LookupAuthorizerResultOutput) AuthorizerCredentialsArn added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerCredentialsArn() pulumi.StringPtrOutput

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for “REQUEST“ authorizers.

func (LookupAuthorizerResultOutput) AuthorizerId added in v0.42.0 

func (o LookupAuthorizerResultOutput) AuthorizerId() pulumi.StringPtrOutput

The authorizer ID.

func (LookupAuthorizerResultOutput) AuthorizerPayloadFormatVersion added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerPayloadFormatVersion() pulumi.StringPtrOutput

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are “1.0“ and “2.0“. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).

func (LookupAuthorizerResultOutput) AuthorizerResultTtlInSeconds added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerResultTtlInSeconds() pulumi.IntPtrOutput

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

func (LookupAuthorizerResultOutput) AuthorizerType added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerType() pulumi.StringPtrOutput

The authorizer type. Specify “REQUEST“ for a Lambda function using incoming request parameters. Specify “JWT“ to use JSON Web Tokens (supported only for HTTP APIs).

func (LookupAuthorizerResultOutput) AuthorizerUri added in v0.12.0 

func (o LookupAuthorizerResultOutput) AuthorizerUri() pulumi.StringPtrOutput

The authorizer's Uniform Resource Identifier (URI). For “REQUEST“ authorizers, this must be a well-formed Lambda function URI, for example, “arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations“. In general, the URI has this form: “arn:aws:apigateway:{region}:lambda:path/{service_api}“, where *{region}* is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial “/“. For Lambda functions, this is usually of the form “/2015-03-31/functions/[FunctionARN]/invocations“.

func (LookupAuthorizerResultOutput) ElementType added in v0.12.0 

func (LookupAuthorizerResultOutput) ElementType() reflect.Type

func (LookupAuthorizerResultOutput) EnableSimpleResponses added in v0.12.0 

func (o LookupAuthorizerResultOutput) EnableSimpleResponses() pulumi.BoolPtrOutput

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).

func (LookupAuthorizerResultOutput) IdentitySource added in v0.12.0 

func (o LookupAuthorizerResultOutput) IdentitySource() pulumi.StringArrayOutput

The identity source for which authorization is requested. 

For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.

func (LookupAuthorizerResultOutput) IdentityValidationExpression added in v0.12.0 

func (o LookupAuthorizerResultOutput) IdentityValidationExpression() pulumi.StringPtrOutput

This parameter is not used.

func (LookupAuthorizerResultOutput) JwtConfiguration added in v0.12.0 

func (o LookupAuthorizerResultOutput) JwtConfiguration() AuthorizerJwtConfigurationPtrOutput

The “JWTConfiguration“ property specifies the configuration of a JWT authorizer. Required for the “JWT“ authorizer type. Supported only for HTTP APIs.

func (LookupAuthorizerResultOutput) Name added in v0.12.0 

func (o LookupAuthorizerResultOutput) Name() pulumi.StringPtrOutput

The name of the authorizer.

func (LookupAuthorizerResultOutput) ToLookupAuthorizerResultOutput added in v0.12.0 

func (o LookupAuthorizerResultOutput) ToLookupAuthorizerResultOutput() LookupAuthorizerResultOutput

func (LookupAuthorizerResultOutput) ToLookupAuthorizerResultOutputWithContext added in v0.12.0 

func (o LookupAuthorizerResultOutput) ToLookupAuthorizerResultOutputWithContext(ctx context.Context) LookupAuthorizerResultOutput

type LookupDeploymentArgs added in v0.12.0 

type LookupDeploymentArgs struct {
	// The API identifier.
	ApiId string `pulumi:"apiId"`
	// The deployment ID.
	DeploymentId string `pulumi:"deploymentId"`
}

type LookupDeploymentOutputArgs added in v0.12.0 

type LookupDeploymentOutputArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput `pulumi:"apiId"`
	// The deployment ID.
	DeploymentId pulumi.StringInput `pulumi:"deploymentId"`
}

func (LookupDeploymentOutputArgs) ElementType added in v0.12.0 

func (LookupDeploymentOutputArgs) ElementType() reflect.Type

type LookupDeploymentResult added in v0.12.0 

type LookupDeploymentResult struct {
	// The deployment ID.
	DeploymentId *string `pulumi:"deploymentId"`
	// The description for the deployment resource.
	Description *string `pulumi:"description"`
}

func LookupDeployment added in v0.12.0 

func LookupDeployment(ctx *pulumi.Context, args *LookupDeploymentArgs, opts ...pulumi.InvokeOption) (*LookupDeploymentResult, error)

The “AWS::ApiGatewayV2::Deployment“ resource creates a deployment for an API.

type LookupDeploymentResultOutput added in v0.12.0 

type LookupDeploymentResultOutput struct{ *pulumi.OutputState }

func LookupDeploymentOutput added in v0.12.0 

func LookupDeploymentOutput(ctx *pulumi.Context, args LookupDeploymentOutputArgs, opts ...pulumi.InvokeOption) LookupDeploymentResultOutput

func (LookupDeploymentResultOutput) DeploymentId added in v0.40.0 

func (o LookupDeploymentResultOutput) DeploymentId() pulumi.StringPtrOutput

The deployment ID.

func (LookupDeploymentResultOutput) Description added in v0.12.0 

func (o LookupDeploymentResultOutput) Description() pulumi.StringPtrOutput

The description for the deployment resource.

func (LookupDeploymentResultOutput) ElementType added in v0.12.0 

func (LookupDeploymentResultOutput) ElementType() reflect.Type

func (LookupDeploymentResultOutput) ToLookupDeploymentResultOutput added in v0.12.0 

func (o LookupDeploymentResultOutput) ToLookupDeploymentResultOutput() LookupDeploymentResultOutput

func (LookupDeploymentResultOutput) ToLookupDeploymentResultOutputWithContext added in v0.12.0 

func (o LookupDeploymentResultOutput) ToLookupDeploymentResultOutputWithContext(ctx context.Context) LookupDeploymentResultOutput

type LookupDomainNameArgs added in v0.12.0 

type LookupDomainNameArgs struct {
	// The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
	DomainName string `pulumi:"domainName"`
}

type LookupDomainNameOutputArgs added in v0.12.0 

type LookupDomainNameOutputArgs struct {
	// The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported.
	DomainName pulumi.StringInput `pulumi:"domainName"`
}

func (LookupDomainNameOutputArgs) ElementType added in v0.12.0 

func (LookupDomainNameOutputArgs) ElementType() reflect.Type

type LookupDomainNameResult added in v0.12.0 

type LookupDomainNameResult struct {
	// The domain name configurations.
	DomainNameConfigurations []DomainNameConfiguration `pulumi:"domainNameConfigurations"`
	// The mutual TLS authentication configuration for a custom domain name.
	MutualTlsAuthentication *DomainNameMutualTlsAuthentication `pulumi:"mutualTlsAuthentication"`
	// The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name.
	RegionalDomainName *string `pulumi:"regionalDomainName"`
	// The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
	RegionalHostedZoneId *string `pulumi:"regionalHostedZoneId"`
	// The collection of tags associated with a domain name.
	Tags map[string]string `pulumi:"tags"`
}

func LookupDomainName added in v0.12.0 

func LookupDomainName(ctx *pulumi.Context, args *LookupDomainNameArgs, opts ...pulumi.InvokeOption) (*LookupDomainNameResult, error)

The “AWS::ApiGatewayV2::DomainName“ resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). 

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.

type LookupDomainNameResultOutput added in v0.12.0 

type LookupDomainNameResultOutput struct{ *pulumi.OutputState }

func LookupDomainNameOutput added in v0.12.0 

func LookupDomainNameOutput(ctx *pulumi.Context, args LookupDomainNameOutputArgs, opts ...pulumi.InvokeOption) LookupDomainNameResultOutput

func (LookupDomainNameResultOutput) DomainNameConfigurations added in v0.12.0 

func (o LookupDomainNameResultOutput) DomainNameConfigurations() DomainNameConfigurationArrayOutput

The domain name configurations.

func (LookupDomainNameResultOutput) ElementType added in v0.12.0 

func (LookupDomainNameResultOutput) ElementType() reflect.Type

func (LookupDomainNameResultOutput) MutualTlsAuthentication added in v0.12.0 

func (o LookupDomainNameResultOutput) MutualTlsAuthentication() DomainNameMutualTlsAuthenticationPtrOutput

The mutual TLS authentication configuration for a custom domain name.

func (LookupDomainNameResultOutput) RegionalDomainName added in v0.12.0 

func (o LookupDomainNameResultOutput) RegionalDomainName() pulumi.StringPtrOutput

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name.

func (LookupDomainNameResultOutput) RegionalHostedZoneId added in v0.12.0 

func (o LookupDomainNameResultOutput) RegionalHostedZoneId() pulumi.StringPtrOutput

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

func (LookupDomainNameResultOutput) Tags added in v0.12.0 

func (o LookupDomainNameResultOutput) Tags() pulumi.StringMapOutput

The collection of tags associated with a domain name.

func (LookupDomainNameResultOutput) ToLookupDomainNameResultOutput added in v0.12.0 

func (o LookupDomainNameResultOutput) ToLookupDomainNameResultOutput() LookupDomainNameResultOutput

func (LookupDomainNameResultOutput) ToLookupDomainNameResultOutputWithContext added in v0.12.0 

func (o LookupDomainNameResultOutput) ToLookupDomainNameResultOutputWithContext(ctx context.Context) LookupDomainNameResultOutput

type LookupIntegrationResponseArgs added in v0.12.0 

type LookupIntegrationResponseArgs struct {
	// The API identifier.
	ApiId string `pulumi:"apiId"`
	// The integration ID.
	IntegrationId string `pulumi:"integrationId"`
	// The integration response ID.
	IntegrationResponseId string `pulumi:"integrationResponseId"`
}

type LookupIntegrationResponseOutputArgs added in v0.12.0 

type LookupIntegrationResponseOutputArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput `pulumi:"apiId"`
	// The integration ID.
	IntegrationId pulumi.StringInput `pulumi:"integrationId"`
	// The integration response ID.
	IntegrationResponseId pulumi.StringInput `pulumi:"integrationResponseId"`
}

func (LookupIntegrationResponseOutputArgs) ElementType added in v0.12.0 

func (LookupIntegrationResponseOutputArgs) ElementType() reflect.Type

type LookupIntegrationResponseResult added in v0.12.0 

type LookupIntegrationResponseResult struct {
	// Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors:
	//   “CONVERT_TO_BINARY“: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
	//   “CONVERT_TO_TEXT“: Converts a response payload from a binary blob to a Base64-encoded string.
	//  If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
	ContentHandlingStrategy *string `pulumi:"contentHandlingStrategy"`
	// The integration response ID.
	IntegrationResponseId *string `pulumi:"integrationResponseId"`
	// The integration response key.
	IntegrationResponseKey *string `pulumi:"integrationResponseKey"`
	// A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of “method.response.header.{name}“, where name is a valid and unique header name. The mapped non-static value must match the pattern of “integration.response.header.{name}“ or “integration.response.body.{JSON-expression}“, where “{name}“ is a valid and unique response header name and “{JSON-expression}“ is a valid JSON expression without the “$“ prefix.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
	ResponseParameters interface{} `pulumi:"responseParameters"`
	// The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
	ResponseTemplates interface{} `pulumi:"responseTemplates"`
	// The template selection expression for the integration response. Supported only for WebSocket APIs.
	TemplateSelectionExpression *string `pulumi:"templateSelectionExpression"`
}

func LookupIntegrationResponse added in v0.12.0 

func LookupIntegrationResponse(ctx *pulumi.Context, args *LookupIntegrationResponseArgs, opts ...pulumi.InvokeOption) (*LookupIntegrationResponseResult, error)

The “AWS::ApiGatewayV2::IntegrationResponse“ resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.

type LookupIntegrationResponseResultOutput added in v0.12.0 

type LookupIntegrationResponseResultOutput struct{ *pulumi.OutputState }

func LookupIntegrationResponseOutput added in v0.12.0 

func LookupIntegrationResponseOutput(ctx *pulumi.Context, args LookupIntegrationResponseOutputArgs, opts ...pulumi.InvokeOption) LookupIntegrationResponseResultOutput

func (LookupIntegrationResponseResultOutput) ContentHandlingStrategy added in v0.12.0 

func (o LookupIntegrationResponseResultOutput) ContentHandlingStrategy() pulumi.StringPtrOutput

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are “CONVERT_TO_BINARY“ and “CONVERT_TO_TEXT“, with the following behaviors: 

 ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
 ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

func (LookupIntegrationResponseResultOutput) ElementType added in v0.12.0 

func (LookupIntegrationResponseResultOutput) ElementType() reflect.Type

func (LookupIntegrationResponseResultOutput) IntegrationResponseId added in v0.60.0 

func (o LookupIntegrationResponseResultOutput) IntegrationResponseId() pulumi.StringPtrOutput

The integration response ID.

func (LookupIntegrationResponseResultOutput) IntegrationResponseKey added in v0.12.0 

func (o LookupIntegrationResponseResultOutput) IntegrationResponseKey() pulumi.StringPtrOutput

The integration response key.

func (LookupIntegrationResponseResultOutput) ResponseParameters added in v0.12.0 

func (o LookupIntegrationResponseResultOutput) ResponseParameters() pulumi.AnyOutput

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of “method.response.header.{name}“, where name is a valid and unique header name. The mapped non-static value must match the pattern of “integration.response.header.{name}“ or “integration.response.body.{JSON-expression}“, where “{name}“ is a valid and unique response header name and “{JSON-expression}“ is a valid JSON expression without the “$“ prefix.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.

func (LookupIntegrationResponseResultOutput) ResponseTemplates added in v0.12.0 

func (o LookupIntegrationResponseResultOutput) ResponseTemplates() pulumi.AnyOutput

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.

func (LookupIntegrationResponseResultOutput) TemplateSelectionExpression added in v0.12.0 

func (o LookupIntegrationResponseResultOutput) TemplateSelectionExpression() pulumi.StringPtrOutput

The template selection expression for the integration response. Supported only for WebSocket APIs.

func (LookupIntegrationResponseResultOutput) ToLookupIntegrationResponseResultOutput added in v0.12.0 

func (o LookupIntegrationResponseResultOutput) ToLookupIntegrationResponseResultOutput() LookupIntegrationResponseResultOutput

func (LookupIntegrationResponseResultOutput) ToLookupIntegrationResponseResultOutputWithContext added in v0.12.0 

func (o LookupIntegrationResponseResultOutput) ToLookupIntegrationResponseResultOutputWithContext(ctx context.Context) LookupIntegrationResponseResultOutput

type LookupModelArgs added in v0.12.0 

type LookupModelArgs struct {
	// The API identifier.
	ApiId string `pulumi:"apiId"`
	// The model ID.
	ModelId string `pulumi:"modelId"`
}

type LookupModelOutputArgs added in v0.12.0 

type LookupModelOutputArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput `pulumi:"apiId"`
	// The model ID.
	ModelId pulumi.StringInput `pulumi:"modelId"`
}

func (LookupModelOutputArgs) ElementType added in v0.12.0 

func (LookupModelOutputArgs) ElementType() reflect.Type

type LookupModelResult added in v0.12.0 

type LookupModelResult struct {
	// The content-type for the model, for example, "application/json".
	ContentType *string `pulumi:"contentType"`
	// The description of the model.
	Description *string `pulumi:"description"`
	// The model ID.
	ModelId *string `pulumi:"modelId"`
	// The name of the model.
	Name *string `pulumi:"name"`
	// The schema for the model. For application/json models, this should be JSON schema draft 4 model.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Model` for more information about the expected schema for this property.
	Schema interface{} `pulumi:"schema"`
}

func LookupModel added in v0.12.0 

func LookupModel(ctx *pulumi.Context, args *LookupModelArgs, opts ...pulumi.InvokeOption) (*LookupModelResult, error)

The “AWS::ApiGatewayV2::Model“ resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.

type LookupModelResultOutput added in v0.12.0 

type LookupModelResultOutput struct{ *pulumi.OutputState }

func LookupModelOutput added in v0.12.0 

func LookupModelOutput(ctx *pulumi.Context, args LookupModelOutputArgs, opts ...pulumi.InvokeOption) LookupModelResultOutput

func (LookupModelResultOutput) ContentType added in v0.12.0 

func (o LookupModelResultOutput) ContentType() pulumi.StringPtrOutput

The content-type for the model, for example, "application/json".

func (LookupModelResultOutput) Description added in v0.12.0 

func (o LookupModelResultOutput) Description() pulumi.StringPtrOutput

The description of the model.

func (LookupModelResultOutput) ElementType added in v0.12.0 

func (LookupModelResultOutput) ElementType() reflect.Type

func (LookupModelResultOutput) ModelId added in v0.38.0 

func (o LookupModelResultOutput) ModelId() pulumi.StringPtrOutput

The model ID.

func (LookupModelResultOutput) Name added in v0.12.0 

func (o LookupModelResultOutput) Name() pulumi.StringPtrOutput

The name of the model.

func (LookupModelResultOutput) Schema added in v0.12.0 

func (o LookupModelResultOutput) Schema() pulumi.AnyOutput

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Model` for more information about the expected schema for this property.

func (LookupModelResultOutput) ToLookupModelResultOutput added in v0.12.0 

func (o LookupModelResultOutput) ToLookupModelResultOutput() LookupModelResultOutput

func (LookupModelResultOutput) ToLookupModelResultOutputWithContext added in v0.12.0 

func (o LookupModelResultOutput) ToLookupModelResultOutputWithContext(ctx context.Context) LookupModelResultOutput

type LookupRouteArgs added in v0.12.0 

type LookupRouteArgs struct {
	// The API identifier.
	ApiId string `pulumi:"apiId"`
	// The route ID.
	RouteId string `pulumi:"routeId"`
}

type LookupRouteOutputArgs added in v0.12.0 

type LookupRouteOutputArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput `pulumi:"apiId"`
	// The route ID.
	RouteId pulumi.StringInput `pulumi:"routeId"`
}

func (LookupRouteOutputArgs) ElementType added in v0.12.0 

func (LookupRouteOutputArgs) ElementType() reflect.Type

type LookupRouteResponseArgs added in v0.12.0 

type LookupRouteResponseArgs struct {
	// The API identifier.
	ApiId string `pulumi:"apiId"`
	// The route ID.
	RouteId string `pulumi:"routeId"`
	// The route response ID.
	RouteResponseId string `pulumi:"routeResponseId"`
}

type LookupRouteResponseOutputArgs added in v0.12.0 

type LookupRouteResponseOutputArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput `pulumi:"apiId"`
	// The route ID.
	RouteId pulumi.StringInput `pulumi:"routeId"`
	// The route response ID.
	RouteResponseId pulumi.StringInput `pulumi:"routeResponseId"`
}

func (LookupRouteResponseOutputArgs) ElementType added in v0.12.0 

func (LookupRouteResponseOutputArgs) ElementType() reflect.Type

type LookupRouteResponseResult added in v0.12.0 

type LookupRouteResponseResult struct {
	// The model selection expression for the route response. Supported only for WebSocket APIs.
	ModelSelectionExpression *string `pulumi:"modelSelectionExpression"`
	// The response models for the route response.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::RouteResponse` for more information about the expected schema for this property.
	ResponseModels interface{} `pulumi:"responseModels"`
	// The route response parameters.
	ResponseParameters map[string]RouteResponseParameterConstraints `pulumi:"responseParameters"`
	// The route response ID.
	RouteResponseId *string `pulumi:"routeResponseId"`
	// The route response key.
	RouteResponseKey *string `pulumi:"routeResponseKey"`
}

func LookupRouteResponse added in v0.12.0 

func LookupRouteResponse(ctx *pulumi.Context, args *LookupRouteResponseArgs, opts ...pulumi.InvokeOption) (*LookupRouteResponseResult, error)

The “AWS::ApiGatewayV2::RouteResponse“ resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.

type LookupRouteResponseResultOutput added in v0.12.0 

type LookupRouteResponseResultOutput struct{ *pulumi.OutputState }

func LookupRouteResponseOutput added in v0.12.0 

func LookupRouteResponseOutput(ctx *pulumi.Context, args LookupRouteResponseOutputArgs, opts ...pulumi.InvokeOption) LookupRouteResponseResultOutput

func (LookupRouteResponseResultOutput) ElementType added in v0.12.0 

func (LookupRouteResponseResultOutput) ElementType() reflect.Type

func (LookupRouteResponseResultOutput) ModelSelectionExpression added in v0.12.0 

func (o LookupRouteResponseResultOutput) ModelSelectionExpression() pulumi.StringPtrOutput

The model selection expression for the route response. Supported only for WebSocket APIs.

func (LookupRouteResponseResultOutput) ResponseModels added in v0.12.0 

func (o LookupRouteResponseResultOutput) ResponseModels() pulumi.AnyOutput

The response models for the route response.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::RouteResponse` for more information about the expected schema for this property.

func (LookupRouteResponseResultOutput) ResponseParameters added in v0.12.0 

func (o LookupRouteResponseResultOutput) ResponseParameters() RouteResponseParameterConstraintsMapOutput

The route response parameters.

func (LookupRouteResponseResultOutput) RouteResponseId added in v0.51.0 

func (o LookupRouteResponseResultOutput) RouteResponseId() pulumi.StringPtrOutput

The route response ID.

func (LookupRouteResponseResultOutput) RouteResponseKey added in v0.12.0 

func (o LookupRouteResponseResultOutput) RouteResponseKey() pulumi.StringPtrOutput

The route response key.

func (LookupRouteResponseResultOutput) ToLookupRouteResponseResultOutput added in v0.12.0 

func (o LookupRouteResponseResultOutput) ToLookupRouteResponseResultOutput() LookupRouteResponseResultOutput

func (LookupRouteResponseResultOutput) ToLookupRouteResponseResultOutputWithContext added in v0.12.0 

func (o LookupRouteResponseResultOutput) ToLookupRouteResponseResultOutputWithContext(ctx context.Context) LookupRouteResponseResultOutput

type LookupRouteResult added in v0.12.0 

type LookupRouteResult struct {
	// Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
	ApiKeyRequired *bool `pulumi:"apiKeyRequired"`
	// The authorization scopes supported by this route.
	AuthorizationScopes []string `pulumi:"authorizationScopes"`
	// The authorization type for the route. For WebSocket APIs, valid values are “NONE“ for open access, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer. For HTTP APIs, valid values are “NONE“ for open access, “JWT“ for using JSON Web Tokens, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer.
	AuthorizationType *string `pulumi:"authorizationType"`
	// The model selection expression for the route. Supported only for WebSocket APIs.
	ModelSelectionExpression *string `pulumi:"modelSelectionExpression"`
	// The operation name for the route.
	OperationName *string `pulumi:"operationName"`
	// The request models for the route. Supported only for WebSocket APIs.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Route` for more information about the expected schema for this property.
	RequestModels interface{} `pulumi:"requestModels"`
	// The route ID.
	RouteId *string `pulumi:"routeId"`
	// The route key for the route. For HTTP APIs, the route key can be either “$default“, or a combination of an HTTP method and resource path, for example, “GET /pets“.
	RouteKey *string `pulumi:"routeKey"`
	// The route response selection expression for the route. Supported only for WebSocket APIs.
	RouteResponseSelectionExpression *string `pulumi:"routeResponseSelectionExpression"`
	// The target for the route.
	Target *string `pulumi:"target"`
}

func LookupRoute added in v0.12.0 

func LookupRoute(ctx *pulumi.Context, args *LookupRouteArgs, opts ...pulumi.InvokeOption) (*LookupRouteResult, error)

The “AWS::ApiGatewayV2::Route“ resource creates a route for an API.

type LookupRouteResultOutput added in v0.12.0 

type LookupRouteResultOutput struct{ *pulumi.OutputState }

func LookupRouteOutput added in v0.12.0 

func LookupRouteOutput(ctx *pulumi.Context, args LookupRouteOutputArgs, opts ...pulumi.InvokeOption) LookupRouteResultOutput

func (LookupRouteResultOutput) ApiKeyRequired added in v0.12.0 

func (o LookupRouteResultOutput) ApiKeyRequired() pulumi.BoolPtrOutput

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

func (LookupRouteResultOutput) AuthorizationScopes added in v0.12.0 

func (o LookupRouteResultOutput) AuthorizationScopes() pulumi.StringArrayOutput

The authorization scopes supported by this route.

func (LookupRouteResultOutput) AuthorizationType added in v0.12.0 

func (o LookupRouteResultOutput) AuthorizationType() pulumi.StringPtrOutput

The authorization type for the route. For WebSocket APIs, valid values are “NONE“ for open access, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer. For HTTP APIs, valid values are “NONE“ for open access, “JWT“ for using JSON Web Tokens, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer.

func (LookupRouteResultOutput) ElementType added in v0.12.0 

func (LookupRouteResultOutput) ElementType() reflect.Type

func (LookupRouteResultOutput) ModelSelectionExpression added in v0.12.0 

func (o LookupRouteResultOutput) ModelSelectionExpression() pulumi.StringPtrOutput

The model selection expression for the route. Supported only for WebSocket APIs.

func (LookupRouteResultOutput) OperationName added in v0.12.0 

func (o LookupRouteResultOutput) OperationName() pulumi.StringPtrOutput

The operation name for the route.

func (LookupRouteResultOutput) RequestModels added in v0.12.0 

func (o LookupRouteResultOutput) RequestModels() pulumi.AnyOutput

The request models for the route. Supported only for WebSocket APIs.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Route` for more information about the expected schema for this property.

func (LookupRouteResultOutput) RouteId added in v0.55.0 

func (o LookupRouteResultOutput) RouteId() pulumi.StringPtrOutput

The route ID.

func (LookupRouteResultOutput) RouteKey added in v0.12.0 

func (o LookupRouteResultOutput) RouteKey() pulumi.StringPtrOutput

The route key for the route. For HTTP APIs, the route key can be either “$default“, or a combination of an HTTP method and resource path, for example, “GET /pets“.

func (LookupRouteResultOutput) RouteResponseSelectionExpression added in v0.12.0 

func (o LookupRouteResultOutput) RouteResponseSelectionExpression() pulumi.StringPtrOutput

The route response selection expression for the route. Supported only for WebSocket APIs.

func (LookupRouteResultOutput) Target added in v0.12.0 

func (o LookupRouteResultOutput) Target() pulumi.StringPtrOutput

The target for the route.

func (LookupRouteResultOutput) ToLookupRouteResultOutput added in v0.12.0 

func (o LookupRouteResultOutput) ToLookupRouteResultOutput() LookupRouteResultOutput

func (LookupRouteResultOutput) ToLookupRouteResultOutputWithContext added in v0.12.0 

func (o LookupRouteResultOutput) ToLookupRouteResultOutputWithContext(ctx context.Context) LookupRouteResultOutput

type LookupVpcLinkArgs added in v0.12.0 

type LookupVpcLinkArgs struct {
	// The VPC link ID.
	VpcLinkId string `pulumi:"vpcLinkId"`
}

type LookupVpcLinkOutputArgs added in v0.12.0 

type LookupVpcLinkOutputArgs struct {
	// The VPC link ID.
	VpcLinkId pulumi.StringInput `pulumi:"vpcLinkId"`
}

func (LookupVpcLinkOutputArgs) ElementType added in v0.12.0 

func (LookupVpcLinkOutputArgs) ElementType() reflect.Type

type LookupVpcLinkResult added in v0.12.0 

type LookupVpcLinkResult struct {
	// The name of the VPC link.
	Name *string `pulumi:"name"`
	// This resource type use map for Tags, suggest to use List of Tag
	Tags map[string]string `pulumi:"tags"`
	// The VPC link ID.
	VpcLinkId *string `pulumi:"vpcLinkId"`
}
func LookupVpcLink(ctx *pulumi.Context, args *LookupVpcLinkArgs, opts ...pulumi.InvokeOption) (*LookupVpcLinkResult, error)

Resource Type definition for AWS::ApiGatewayV2::VpcLink

type LookupVpcLinkResultOutput added in v0.12.0 

type LookupVpcLinkResultOutput struct{ *pulumi.OutputState }

func LookupVpcLinkOutput added in v0.12.0 

func LookupVpcLinkOutput(ctx *pulumi.Context, args LookupVpcLinkOutputArgs, opts ...pulumi.InvokeOption) LookupVpcLinkResultOutput

func (LookupVpcLinkResultOutput) ElementType added in v0.12.0 

func (LookupVpcLinkResultOutput) ElementType() reflect.Type

func (LookupVpcLinkResultOutput) Name added in v0.12.0 

func (o LookupVpcLinkResultOutput) Name() pulumi.StringPtrOutput

The name of the VPC link.

func (LookupVpcLinkResultOutput) Tags added in v0.12.0 

func (o LookupVpcLinkResultOutput) Tags() pulumi.StringMapOutput

This resource type use map for Tags, suggest to use List of Tag

func (LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutput added in v0.12.0 

func (o LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutput() LookupVpcLinkResultOutput

func (LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutputWithContext added in v0.12.0 

func (o LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutputWithContext(ctx context.Context) LookupVpcLinkResultOutput

func (LookupVpcLinkResultOutput) VpcLinkId added in v0.20.0 

func (o LookupVpcLinkResultOutput) VpcLinkId() pulumi.StringPtrOutput

The VPC link ID.

type Model 

type Model struct {
	pulumi.CustomResourceState

	// The API identifier.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// The content-type for the model, for example, "application/json".
	ContentType pulumi.StringPtrOutput `pulumi:"contentType"`
	// The description of the model.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The model ID.
	ModelId pulumi.StringOutput `pulumi:"modelId"`
	// The name of the model.
	Name pulumi.StringOutput `pulumi:"name"`
	// The schema for the model. For application/json models, this should be JSON schema draft 4 model.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Model` for more information about the expected schema for this property.
	Schema pulumi.AnyOutput `pulumi:"schema"`
}

The “AWS::ApiGatewayV2::Model“ resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.

func GetModel 

func GetModel(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ModelState, opts ...pulumi.ResourceOption) (*Model, error)

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

func NewModel 

func NewModel(ctx *pulumi.Context,
	name string, args *ModelArgs, opts ...pulumi.ResourceOption) (*Model, error)

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

func (*Model) ElementType 

func (*Model) ElementType() reflect.Type

func (*Model) ToModelOutput 

func (i *Model) ToModelOutput() ModelOutput

func (*Model) ToModelOutputWithContext 

func (i *Model) ToModelOutputWithContext(ctx context.Context) ModelOutput

type ModelArgs 

type ModelArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput
	// The content-type for the model, for example, "application/json".
	ContentType pulumi.StringPtrInput
	// The description of the model.
	Description pulumi.StringPtrInput
	// The name of the model.
	Name pulumi.StringPtrInput
	// The schema for the model. For application/json models, this should be JSON schema draft 4 model.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Model` for more information about the expected schema for this property.
	Schema pulumi.Input
}

The set of arguments for constructing a Model resource.

func (ModelArgs) ElementType 

func (ModelArgs) ElementType() reflect.Type

type ModelInput 

type ModelInput interface {
	pulumi.Input

	ToModelOutput() ModelOutput
	ToModelOutputWithContext(ctx context.Context) ModelOutput
}

type ModelOutput 

type ModelOutput struct{ *pulumi.OutputState }

func (ModelOutput) ApiId added in v0.17.0 

func (o ModelOutput) ApiId() pulumi.StringOutput

The API identifier.

func (ModelOutput) ContentType added in v0.17.0 

func (o ModelOutput) ContentType() pulumi.StringPtrOutput

The content-type for the model, for example, "application/json".

func (ModelOutput) Description added in v0.17.0 

func (o ModelOutput) Description() pulumi.StringPtrOutput

The description of the model.

func (ModelOutput) ElementType 

func (ModelOutput) ElementType() reflect.Type

func (ModelOutput) ModelId added in v0.38.0 

func (o ModelOutput) ModelId() pulumi.StringOutput

The model ID.

func (ModelOutput) Name added in v0.17.0 

func (o ModelOutput) Name() pulumi.StringOutput

The name of the model.

func (ModelOutput) Schema added in v0.17.0 

func (o ModelOutput) Schema() pulumi.AnyOutput

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Model` for more information about the expected schema for this property.

func (ModelOutput) ToModelOutput 

func (o ModelOutput) ToModelOutput() ModelOutput

func (ModelOutput) ToModelOutputWithContext 

func (o ModelOutput) ToModelOutputWithContext(ctx context.Context) ModelOutput

type ModelState 

type ModelState struct {
}

func (ModelState) ElementType 

func (ModelState) ElementType() reflect.Type

type Route 

type Route struct {
	pulumi.CustomResourceState

	// The API identifier.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
	ApiKeyRequired pulumi.BoolPtrOutput `pulumi:"apiKeyRequired"`
	// The authorization scopes supported by this route.
	AuthorizationScopes pulumi.StringArrayOutput `pulumi:"authorizationScopes"`
	// The authorization type for the route. For WebSocket APIs, valid values are “NONE“ for open access, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer. For HTTP APIs, valid values are “NONE“ for open access, “JWT“ for using JSON Web Tokens, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer.
	AuthorizationType pulumi.StringPtrOutput `pulumi:"authorizationType"`
	// The identifier of the “Authorizer“ resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
	AuthorizerId pulumi.StringPtrOutput `pulumi:"authorizerId"`
	// The model selection expression for the route. Supported only for WebSocket APIs.
	ModelSelectionExpression pulumi.StringPtrOutput `pulumi:"modelSelectionExpression"`
	// The operation name for the route.
	OperationName pulumi.StringPtrOutput `pulumi:"operationName"`
	// The request models for the route. Supported only for WebSocket APIs.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Route` for more information about the expected schema for this property.
	RequestModels pulumi.AnyOutput `pulumi:"requestModels"`
	// The request parameters for the route. Supported only for WebSocket APIs.
	RequestParameters RouteParameterConstraintsArrayOutput `pulumi:"requestParameters"`
	// The route ID.
	RouteId pulumi.StringOutput `pulumi:"routeId"`
	// The route key for the route. For HTTP APIs, the route key can be either “$default“, or a combination of an HTTP method and resource path, for example, “GET /pets“.
	RouteKey pulumi.StringOutput `pulumi:"routeKey"`
	// The route response selection expression for the route. Supported only for WebSocket APIs.
	RouteResponseSelectionExpression pulumi.StringPtrOutput `pulumi:"routeResponseSelectionExpression"`
	// The target for the route.
	Target pulumi.StringPtrOutput `pulumi:"target"`
}

The “AWS::ApiGatewayV2::Route“ resource creates a route for an API.

func GetRoute 

func GetRoute(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RouteState, opts ...pulumi.ResourceOption) (*Route, error)

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

func NewRoute 

func NewRoute(ctx *pulumi.Context,
	name string, args *RouteArgs, opts ...pulumi.ResourceOption) (*Route, error)

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

func (*Route) ElementType 

func (*Route) ElementType() reflect.Type

func (*Route) ToRouteOutput 

func (i *Route) ToRouteOutput() RouteOutput

func (*Route) ToRouteOutputWithContext 

func (i *Route) ToRouteOutputWithContext(ctx context.Context) RouteOutput

type RouteArgs 

type RouteArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput
	// Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
	ApiKeyRequired pulumi.BoolPtrInput
	// The authorization scopes supported by this route.
	AuthorizationScopes pulumi.StringArrayInput
	// The authorization type for the route. For WebSocket APIs, valid values are “NONE“ for open access, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer. For HTTP APIs, valid values are “NONE“ for open access, “JWT“ for using JSON Web Tokens, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer.
	AuthorizationType pulumi.StringPtrInput
	// The identifier of the “Authorizer“ resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
	AuthorizerId pulumi.StringPtrInput
	// The model selection expression for the route. Supported only for WebSocket APIs.
	ModelSelectionExpression pulumi.StringPtrInput
	// The operation name for the route.
	OperationName pulumi.StringPtrInput
	// The request models for the route. Supported only for WebSocket APIs.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Route` for more information about the expected schema for this property.
	RequestModels pulumi.Input
	// The request parameters for the route. Supported only for WebSocket APIs.
	RequestParameters RouteParameterConstraintsArrayInput
	// The route key for the route. For HTTP APIs, the route key can be either “$default“, or a combination of an HTTP method and resource path, for example, “GET /pets“.
	RouteKey pulumi.StringInput
	// The route response selection expression for the route. Supported only for WebSocket APIs.
	RouteResponseSelectionExpression pulumi.StringPtrInput
	// The target for the route.
	Target pulumi.StringPtrInput
}

The set of arguments for constructing a Route resource.

func (RouteArgs) ElementType 

func (RouteArgs) ElementType() reflect.Type

type RouteInput 

type RouteInput interface {
	pulumi.Input

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

type RouteOutput 

type RouteOutput struct{ *pulumi.OutputState }

func (RouteOutput) ApiId added in v0.17.0 

func (o RouteOutput) ApiId() pulumi.StringOutput

The API identifier.

func (RouteOutput) ApiKeyRequired added in v0.17.0 

func (o RouteOutput) ApiKeyRequired() pulumi.BoolPtrOutput

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

func (RouteOutput) AuthorizationScopes added in v0.17.0 

func (o RouteOutput) AuthorizationScopes() pulumi.StringArrayOutput

The authorization scopes supported by this route.

func (RouteOutput) AuthorizationType added in v0.17.0 

func (o RouteOutput) AuthorizationType() pulumi.StringPtrOutput

The authorization type for the route. For WebSocket APIs, valid values are “NONE“ for open access, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer. For HTTP APIs, valid values are “NONE“ for open access, “JWT“ for using JSON Web Tokens, “AWS_IAM“ for using AWS IAM permissions, and “CUSTOM“ for using a Lambda authorizer.

func (RouteOutput) AuthorizerId added in v0.17.0 

func (o RouteOutput) AuthorizerId() pulumi.StringPtrOutput

The identifier of the “Authorizer“ resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

func (RouteOutput) ElementType 

func (RouteOutput) ElementType() reflect.Type

func (RouteOutput) ModelSelectionExpression added in v0.17.0 

func (o RouteOutput) ModelSelectionExpression() pulumi.StringPtrOutput

The model selection expression for the route. Supported only for WebSocket APIs.

func (RouteOutput) OperationName added in v0.17.0 

func (o RouteOutput) OperationName() pulumi.StringPtrOutput

The operation name for the route.

func (RouteOutput) RequestModels added in v0.17.0 

func (o RouteOutput) RequestModels() pulumi.AnyOutput

The request models for the route. Supported only for WebSocket APIs.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::Route` for more information about the expected schema for this property.

func (RouteOutput) RequestParameters added in v0.17.0 

func (o RouteOutput) RequestParameters() RouteParameterConstraintsArrayOutput

The request parameters for the route. Supported only for WebSocket APIs.

func (RouteOutput) RouteId added in v0.55.0 

func (o RouteOutput) RouteId() pulumi.StringOutput

The route ID.

func (RouteOutput) RouteKey added in v0.17.0 

func (o RouteOutput) RouteKey() pulumi.StringOutput

The route key for the route. For HTTP APIs, the route key can be either “$default“, or a combination of an HTTP method and resource path, for example, “GET /pets“.

func (RouteOutput) RouteResponseSelectionExpression added in v0.17.0 

func (o RouteOutput) RouteResponseSelectionExpression() pulumi.StringPtrOutput

The route response selection expression for the route. Supported only for WebSocket APIs.

func (RouteOutput) Target added in v0.17.0 

func (o RouteOutput) Target() pulumi.StringPtrOutput

The target for the route.

func (RouteOutput) ToRouteOutput 

func (o RouteOutput) ToRouteOutput() RouteOutput

func (RouteOutput) ToRouteOutputWithContext 

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

type RouteParameterConstraints added in v0.99.0 

type RouteParameterConstraints struct {
	Required bool `pulumi:"required"`
}

type RouteParameterConstraintsArgs added in v0.99.0 

type RouteParameterConstraintsArgs struct {
	Required pulumi.BoolInput `pulumi:"required"`
}

func (RouteParameterConstraintsArgs) ElementType added in v0.99.0 

func (RouteParameterConstraintsArgs) ElementType() reflect.Type

func (RouteParameterConstraintsArgs) ToRouteParameterConstraintsOutput added in v0.99.0 

func (i RouteParameterConstraintsArgs) ToRouteParameterConstraintsOutput() RouteParameterConstraintsOutput

func (RouteParameterConstraintsArgs) ToRouteParameterConstraintsOutputWithContext added in v0.99.0 

func (i RouteParameterConstraintsArgs) ToRouteParameterConstraintsOutputWithContext(ctx context.Context) RouteParameterConstraintsOutput

type RouteParameterConstraintsArray added in v0.99.0 

type RouteParameterConstraintsArray []RouteParameterConstraintsInput

func (RouteParameterConstraintsArray) ElementType added in v0.99.0 

func (RouteParameterConstraintsArray) ElementType() reflect.Type

func (RouteParameterConstraintsArray) ToRouteParameterConstraintsArrayOutput added in v0.99.0 

func (i RouteParameterConstraintsArray) ToRouteParameterConstraintsArrayOutput() RouteParameterConstraintsArrayOutput

func (RouteParameterConstraintsArray) ToRouteParameterConstraintsArrayOutputWithContext added in v0.99.0 

func (i RouteParameterConstraintsArray) ToRouteParameterConstraintsArrayOutputWithContext(ctx context.Context) RouteParameterConstraintsArrayOutput

type RouteParameterConstraintsArrayInput added in v0.99.0 

type RouteParameterConstraintsArrayInput interface {
	pulumi.Input

	ToRouteParameterConstraintsArrayOutput() RouteParameterConstraintsArrayOutput
	ToRouteParameterConstraintsArrayOutputWithContext(context.Context) RouteParameterConstraintsArrayOutput
}

RouteParameterConstraintsArrayInput is an input type that accepts RouteParameterConstraintsArray and RouteParameterConstraintsArrayOutput values. You can construct a concrete instance of `RouteParameterConstraintsArrayInput` via: 

RouteParameterConstraintsArray{ RouteParameterConstraintsArgs{...} }

type RouteParameterConstraintsArrayOutput added in v0.99.0 

type RouteParameterConstraintsArrayOutput struct{ *pulumi.OutputState }

func (RouteParameterConstraintsArrayOutput) ElementType added in v0.99.0 

func (RouteParameterConstraintsArrayOutput) ElementType() reflect.Type

func (RouteParameterConstraintsArrayOutput) Index added in v0.99.0 

func (o RouteParameterConstraintsArrayOutput) Index(i pulumi.IntInput) RouteParameterConstraintsOutput

func (RouteParameterConstraintsArrayOutput) ToRouteParameterConstraintsArrayOutput added in v0.99.0 

func (o RouteParameterConstraintsArrayOutput) ToRouteParameterConstraintsArrayOutput() RouteParameterConstraintsArrayOutput

func (RouteParameterConstraintsArrayOutput) ToRouteParameterConstraintsArrayOutputWithContext added in v0.99.0 

func (o RouteParameterConstraintsArrayOutput) ToRouteParameterConstraintsArrayOutputWithContext(ctx context.Context) RouteParameterConstraintsArrayOutput

type RouteParameterConstraintsInput added in v0.99.0 

type RouteParameterConstraintsInput interface {
	pulumi.Input

	ToRouteParameterConstraintsOutput() RouteParameterConstraintsOutput
	ToRouteParameterConstraintsOutputWithContext(context.Context) RouteParameterConstraintsOutput
}

RouteParameterConstraintsInput is an input type that accepts RouteParameterConstraintsArgs and RouteParameterConstraintsOutput values. You can construct a concrete instance of `RouteParameterConstraintsInput` via: 

RouteParameterConstraintsArgs{...}

type RouteParameterConstraintsOutput added in v0.99.0 

type RouteParameterConstraintsOutput struct{ *pulumi.OutputState }

func (RouteParameterConstraintsOutput) ElementType added in v0.99.0 

func (RouteParameterConstraintsOutput) ElementType() reflect.Type

func (RouteParameterConstraintsOutput) Required added in v0.99.0 

func (o RouteParameterConstraintsOutput) Required() pulumi.BoolOutput

func (RouteParameterConstraintsOutput) ToRouteParameterConstraintsOutput added in v0.99.0 

func (o RouteParameterConstraintsOutput) ToRouteParameterConstraintsOutput() RouteParameterConstraintsOutput

func (RouteParameterConstraintsOutput) ToRouteParameterConstraintsOutputWithContext added in v0.99.0 

func (o RouteParameterConstraintsOutput) ToRouteParameterConstraintsOutputWithContext(ctx context.Context) RouteParameterConstraintsOutput

type RouteResponse 

type RouteResponse struct {
	pulumi.CustomResourceState

	// The API identifier.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// The model selection expression for the route response. Supported only for WebSocket APIs.
	ModelSelectionExpression pulumi.StringPtrOutput `pulumi:"modelSelectionExpression"`
	// The response models for the route response.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::RouteResponse` for more information about the expected schema for this property.
	ResponseModels pulumi.AnyOutput `pulumi:"responseModels"`
	// The route response parameters.
	ResponseParameters RouteResponseParameterConstraintsMapOutput `pulumi:"responseParameters"`
	// The route ID.
	RouteId pulumi.StringOutput `pulumi:"routeId"`
	// The route response ID.
	RouteResponseId pulumi.StringOutput `pulumi:"routeResponseId"`
	// The route response key.
	RouteResponseKey pulumi.StringOutput `pulumi:"routeResponseKey"`
}

The “AWS::ApiGatewayV2::RouteResponse“ resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.

func GetRouteResponse 

func GetRouteResponse(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RouteResponseState, opts ...pulumi.ResourceOption) (*RouteResponse, error)

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

func NewRouteResponse 

func NewRouteResponse(ctx *pulumi.Context,
	name string, args *RouteResponseArgs, opts ...pulumi.ResourceOption) (*RouteResponse, error)

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

func (*RouteResponse) ElementType 

func (*RouteResponse) ElementType() reflect.Type

func (*RouteResponse) ToRouteResponseOutput 

func (i *RouteResponse) ToRouteResponseOutput() RouteResponseOutput

func (*RouteResponse) ToRouteResponseOutputWithContext 

func (i *RouteResponse) ToRouteResponseOutputWithContext(ctx context.Context) RouteResponseOutput

type RouteResponseArgs 

type RouteResponseArgs struct {
	// The API identifier.
	ApiId pulumi.StringInput
	// The model selection expression for the route response. Supported only for WebSocket APIs.
	ModelSelectionExpression pulumi.StringPtrInput
	// The response models for the route response.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::RouteResponse` for more information about the expected schema for this property.
	ResponseModels pulumi.Input
	// The route response parameters.
	ResponseParameters RouteResponseParameterConstraintsMapInput
	// The route ID.
	RouteId pulumi.StringInput
	// The route response key.
	RouteResponseKey pulumi.StringInput
}

The set of arguments for constructing a RouteResponse resource.

func (RouteResponseArgs) ElementType 

func (RouteResponseArgs) ElementType() reflect.Type

type RouteResponseInput 

type RouteResponseInput interface {
	pulumi.Input

	ToRouteResponseOutput() RouteResponseOutput
	ToRouteResponseOutputWithContext(ctx context.Context) RouteResponseOutput
}

type RouteResponseOutput 

type RouteResponseOutput struct{ *pulumi.OutputState }

func (RouteResponseOutput) ApiId added in v0.17.0 

func (o RouteResponseOutput) ApiId() pulumi.StringOutput

The API identifier.

func (RouteResponseOutput) ElementType 

func (RouteResponseOutput) ElementType() reflect.Type

func (RouteResponseOutput) ModelSelectionExpression added in v0.17.0 

func (o RouteResponseOutput) ModelSelectionExpression() pulumi.StringPtrOutput

The model selection expression for the route response. Supported only for WebSocket APIs.

func (RouteResponseOutput) ResponseModels added in v0.17.0 

func (o RouteResponseOutput) ResponseModels() pulumi.AnyOutput

The response models for the route response.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::RouteResponse` for more information about the expected schema for this property.

func (RouteResponseOutput) ResponseParameters added in v0.17.0 

func (o RouteResponseOutput) ResponseParameters() RouteResponseParameterConstraintsMapOutput

The route response parameters.

func (RouteResponseOutput) RouteId added in v0.17.0 

func (o RouteResponseOutput) RouteId() pulumi.StringOutput

The route ID.

func (RouteResponseOutput) RouteResponseId added in v0.51.0 

func (o RouteResponseOutput) RouteResponseId() pulumi.StringOutput

The route response ID.

func (RouteResponseOutput) RouteResponseKey added in v0.17.0 

func (o RouteResponseOutput) RouteResponseKey() pulumi.StringOutput

The route response key.

func (RouteResponseOutput) ToRouteResponseOutput 

func (o RouteResponseOutput) ToRouteResponseOutput() RouteResponseOutput

func (RouteResponseOutput) ToRouteResponseOutputWithContext 

func (o RouteResponseOutput) ToRouteResponseOutputWithContext(ctx context.Context) RouteResponseOutput

type RouteResponseParameterConstraints added in v0.98.0 

type RouteResponseParameterConstraints struct {
	// Specifies whether the parameter is required.
	Required bool `pulumi:"required"`
}

Specifies whether the parameter is required.

type RouteResponseParameterConstraintsArgs added in v0.98.0 

type RouteResponseParameterConstraintsArgs struct {
	// Specifies whether the parameter is required.
	Required pulumi.BoolInput `pulumi:"required"`
}

Specifies whether the parameter is required.

func (RouteResponseParameterConstraintsArgs) ElementType added in v0.98.0 

func (RouteResponseParameterConstraintsArgs) ElementType() reflect.Type

func (RouteResponseParameterConstraintsArgs) ToRouteResponseParameterConstraintsOutput added in v0.98.0 

func (i RouteResponseParameterConstraintsArgs) ToRouteResponseParameterConstraintsOutput() RouteResponseParameterConstraintsOutput

func (RouteResponseParameterConstraintsArgs) ToRouteResponseParameterConstraintsOutputWithContext added in v0.98.0 

func (i RouteResponseParameterConstraintsArgs) ToRouteResponseParameterConstraintsOutputWithContext(ctx context.Context) RouteResponseParameterConstraintsOutput

type RouteResponseParameterConstraintsInput added in v0.98.0 

type RouteResponseParameterConstraintsInput interface {
	pulumi.Input

	ToRouteResponseParameterConstraintsOutput() RouteResponseParameterConstraintsOutput
	ToRouteResponseParameterConstraintsOutputWithContext(context.Context) RouteResponseParameterConstraintsOutput
}

RouteResponseParameterConstraintsInput is an input type that accepts RouteResponseParameterConstraintsArgs and RouteResponseParameterConstraintsOutput values. You can construct a concrete instance of `RouteResponseParameterConstraintsInput` via: 

RouteResponseParameterConstraintsArgs{...}

type RouteResponseParameterConstraintsMap added in v0.98.0 

type RouteResponseParameterConstraintsMap map[string]RouteResponseParameterConstraintsInput

func (RouteResponseParameterConstraintsMap) ElementType added in v0.98.0 

func (RouteResponseParameterConstraintsMap) ElementType() reflect.Type

func (RouteResponseParameterConstraintsMap) ToRouteResponseParameterConstraintsMapOutput added in v0.98.0 

func (i RouteResponseParameterConstraintsMap) ToRouteResponseParameterConstraintsMapOutput() RouteResponseParameterConstraintsMapOutput

func (RouteResponseParameterConstraintsMap) ToRouteResponseParameterConstraintsMapOutputWithContext added in v0.98.0 

func (i RouteResponseParameterConstraintsMap) ToRouteResponseParameterConstraintsMapOutputWithContext(ctx context.Context) RouteResponseParameterConstraintsMapOutput

type RouteResponseParameterConstraintsMapInput added in v0.98.0 

type RouteResponseParameterConstraintsMapInput interface {
	pulumi.Input

	ToRouteResponseParameterConstraintsMapOutput() RouteResponseParameterConstraintsMapOutput
	ToRouteResponseParameterConstraintsMapOutputWithContext(context.Context) RouteResponseParameterConstraintsMapOutput
}

RouteResponseParameterConstraintsMapInput is an input type that accepts RouteResponseParameterConstraintsMap and RouteResponseParameterConstraintsMapOutput values. You can construct a concrete instance of `RouteResponseParameterConstraintsMapInput` via: 

RouteResponseParameterConstraintsMap{ "key": RouteResponseParameterConstraintsArgs{...} }

type RouteResponseParameterConstraintsMapOutput added in v0.98.0 

type RouteResponseParameterConstraintsMapOutput struct{ *pulumi.OutputState }

func (RouteResponseParameterConstraintsMapOutput) ElementType added in v0.98.0 

func (RouteResponseParameterConstraintsMapOutput) ElementType() reflect.Type

func (RouteResponseParameterConstraintsMapOutput) MapIndex added in v0.98.0 

func (o RouteResponseParameterConstraintsMapOutput) MapIndex(k pulumi.StringInput) RouteResponseParameterConstraintsOutput

func (RouteResponseParameterConstraintsMapOutput) ToRouteResponseParameterConstraintsMapOutput added in v0.98.0 

func (o RouteResponseParameterConstraintsMapOutput) ToRouteResponseParameterConstraintsMapOutput() RouteResponseParameterConstraintsMapOutput

func (RouteResponseParameterConstraintsMapOutput) ToRouteResponseParameterConstraintsMapOutputWithContext added in v0.98.0 

func (o RouteResponseParameterConstraintsMapOutput) ToRouteResponseParameterConstraintsMapOutputWithContext(ctx context.Context) RouteResponseParameterConstraintsMapOutput

type RouteResponseParameterConstraintsOutput added in v0.98.0 

type RouteResponseParameterConstraintsOutput struct{ *pulumi.OutputState }

Specifies whether the parameter is required.

func (RouteResponseParameterConstraintsOutput) ElementType added in v0.98.0 

func (RouteResponseParameterConstraintsOutput) ElementType() reflect.Type

func (RouteResponseParameterConstraintsOutput) Required added in v0.98.0 

func (o RouteResponseParameterConstraintsOutput) Required() pulumi.BoolOutput

Specifies whether the parameter is required.

func (RouteResponseParameterConstraintsOutput) ToRouteResponseParameterConstraintsOutput added in v0.98.0 

func (o RouteResponseParameterConstraintsOutput) ToRouteResponseParameterConstraintsOutput() RouteResponseParameterConstraintsOutput

func (RouteResponseParameterConstraintsOutput) ToRouteResponseParameterConstraintsOutputWithContext added in v0.98.0 

func (o RouteResponseParameterConstraintsOutput) ToRouteResponseParameterConstraintsOutputWithContext(ctx context.Context) RouteResponseParameterConstraintsOutput

type RouteResponseState 

type RouteResponseState struct {
}

func (RouteResponseState) ElementType 

func (RouteResponseState) ElementType() reflect.Type

type RouteState 

type RouteState struct {
}

func (RouteState) ElementType 

func (RouteState) ElementType() reflect.Type
type VpcLink struct {
	pulumi.CustomResourceState

	// The name of the VPC link.
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of security group IDs for the VPC link.
	SecurityGroupIds pulumi.StringArrayOutput `pulumi:"securityGroupIds"`
	// A list of subnet IDs to include in the VPC link.
	SubnetIds pulumi.StringArrayOutput `pulumi:"subnetIds"`
	// This resource type use map for Tags, suggest to use List of Tag
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// The VPC link ID.
	VpcLinkId pulumi.StringOutput `pulumi:"vpcLinkId"`
}

Resource Type definition for AWS::ApiGatewayV2::VpcLink 

func GetVpcLink(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VpcLinkState, opts ...pulumi.ResourceOption) (*VpcLink, error)

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

func NewVpcLink(ctx *pulumi.Context,
	name string, args *VpcLinkArgs, opts ...pulumi.ResourceOption) (*VpcLink, error)

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

func (*VpcLink) ElementType 

func (*VpcLink) ElementType() reflect.Type

func (*VpcLink) ToVpcLinkOutput 

func (i *VpcLink) ToVpcLinkOutput() VpcLinkOutput

func (*VpcLink) ToVpcLinkOutputWithContext 

func (i *VpcLink) ToVpcLinkOutputWithContext(ctx context.Context) VpcLinkOutput

type VpcLinkArgs 

type VpcLinkArgs struct {
	// The name of the VPC link.
	Name pulumi.StringPtrInput
	// A list of security group IDs for the VPC link.
	SecurityGroupIds pulumi.StringArrayInput
	// A list of subnet IDs to include in the VPC link.
	SubnetIds pulumi.StringArrayInput
	// This resource type use map for Tags, suggest to use List of Tag
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a VpcLink resource.

func (VpcLinkArgs) ElementType 

func (VpcLinkArgs) ElementType() reflect.Type

type VpcLinkInput 

type VpcLinkInput interface {
	pulumi.Input

	ToVpcLinkOutput() VpcLinkOutput
	ToVpcLinkOutputWithContext(ctx context.Context) VpcLinkOutput
}

type VpcLinkOutput 

type VpcLinkOutput struct{ *pulumi.OutputState }

func (VpcLinkOutput) ElementType 

func (VpcLinkOutput) ElementType() reflect.Type

func (VpcLinkOutput) Name added in v0.17.0 

func (o VpcLinkOutput) Name() pulumi.StringOutput

The name of the VPC link.

func (VpcLinkOutput) SecurityGroupIds added in v0.17.0 

func (o VpcLinkOutput) SecurityGroupIds() pulumi.StringArrayOutput

A list of security group IDs for the VPC link.

func (VpcLinkOutput) SubnetIds added in v0.17.0 

func (o VpcLinkOutput) SubnetIds() pulumi.StringArrayOutput

A list of subnet IDs to include in the VPC link.

func (VpcLinkOutput) Tags added in v0.17.0 

func (o VpcLinkOutput) Tags() pulumi.StringMapOutput

This resource type use map for Tags, suggest to use List of Tag

func (VpcLinkOutput) ToVpcLinkOutput 

func (o VpcLinkOutput) ToVpcLinkOutput() VpcLinkOutput

func (VpcLinkOutput) ToVpcLinkOutputWithContext 

func (o VpcLinkOutput) ToVpcLinkOutputWithContext(ctx context.Context) VpcLinkOutput

func (VpcLinkOutput) VpcLinkId added in v0.20.0 

func (o VpcLinkOutput) VpcLinkId() pulumi.StringOutput

The VPC link ID.

type VpcLinkState 

type VpcLinkState struct {
}

func (VpcLinkState) ElementType 

func (VpcLinkState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

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