awsapigatewayv2

package
v1.149.0-devpreview Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2022 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ApiMapping_IsConstruct 

func ApiMapping_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func ApiMapping_IsResource 

func ApiMapping_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func CfnApiGatewayManagedOverrides_CFN_RESOURCE_TYPE_NAME 

func CfnApiGatewayManagedOverrides_CFN_RESOURCE_TYPE_NAME() *string

func CfnApiGatewayManagedOverrides_IsCfnElement 

func CfnApiGatewayManagedOverrides_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnApiGatewayManagedOverrides_IsCfnResource 

func CfnApiGatewayManagedOverrides_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnApiGatewayManagedOverrides_IsConstruct 

func CfnApiGatewayManagedOverrides_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnApiMapping_CFN_RESOURCE_TYPE_NAME 

func CfnApiMapping_CFN_RESOURCE_TYPE_NAME() *string

func CfnApiMapping_IsCfnElement 

func CfnApiMapping_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnApiMapping_IsCfnResource 

func CfnApiMapping_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnApiMapping_IsConstruct 

func CfnApiMapping_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnApi_CFN_RESOURCE_TYPE_NAME 

func CfnApi_CFN_RESOURCE_TYPE_NAME() *string

func CfnApi_IsCfnElement 

func CfnApi_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnApi_IsCfnResource 

func CfnApi_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnApi_IsConstruct 

func CfnApi_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnAuthorizer_CFN_RESOURCE_TYPE_NAME 

func CfnAuthorizer_CFN_RESOURCE_TYPE_NAME() *string

func CfnAuthorizer_IsCfnElement 

func CfnAuthorizer_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnAuthorizer_IsCfnResource 

func CfnAuthorizer_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnAuthorizer_IsConstruct 

func CfnAuthorizer_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnDeployment_CFN_RESOURCE_TYPE_NAME 

func CfnDeployment_CFN_RESOURCE_TYPE_NAME() *string

func CfnDeployment_IsCfnElement 

func CfnDeployment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDeployment_IsCfnResource 

func CfnDeployment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDeployment_IsConstruct 

func CfnDeployment_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnDomainName_CFN_RESOURCE_TYPE_NAME 

func CfnDomainName_CFN_RESOURCE_TYPE_NAME() *string

func CfnDomainName_IsCfnElement 

func CfnDomainName_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDomainName_IsCfnResource 

func CfnDomainName_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDomainName_IsConstruct 

func CfnDomainName_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnIntegrationResponse_CFN_RESOURCE_TYPE_NAME 

func CfnIntegrationResponse_CFN_RESOURCE_TYPE_NAME() *string

func CfnIntegrationResponse_IsCfnElement 

func CfnIntegrationResponse_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnIntegrationResponse_IsCfnResource 

func CfnIntegrationResponse_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnIntegrationResponse_IsConstruct 

func CfnIntegrationResponse_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnIntegration_CFN_RESOURCE_TYPE_NAME 

func CfnIntegration_CFN_RESOURCE_TYPE_NAME() *string

func CfnIntegration_IsCfnElement 

func CfnIntegration_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnIntegration_IsCfnResource 

func CfnIntegration_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnIntegration_IsConstruct 

func CfnIntegration_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnModel_CFN_RESOURCE_TYPE_NAME 

func CfnModel_CFN_RESOURCE_TYPE_NAME() *string

func CfnModel_IsCfnElement 

func CfnModel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnModel_IsCfnResource 

func CfnModel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnModel_IsConstruct 

func CfnModel_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnRouteResponse_CFN_RESOURCE_TYPE_NAME 

func CfnRouteResponse_CFN_RESOURCE_TYPE_NAME() *string

func CfnRouteResponse_IsCfnElement 

func CfnRouteResponse_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnRouteResponse_IsCfnResource 

func CfnRouteResponse_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnRouteResponse_IsConstruct 

func CfnRouteResponse_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnRoute_CFN_RESOURCE_TYPE_NAME 

func CfnRoute_CFN_RESOURCE_TYPE_NAME() *string

func CfnRoute_IsCfnElement 

func CfnRoute_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnRoute_IsCfnResource 

func CfnRoute_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnRoute_IsConstruct 

func CfnRoute_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnStage_CFN_RESOURCE_TYPE_NAME 

func CfnStage_CFN_RESOURCE_TYPE_NAME() *string

func CfnStage_IsCfnElement 

func CfnStage_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnStage_IsCfnResource 

func CfnStage_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnStage_IsConstruct 

func CfnStage_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental. 

func CfnVpcLink_CFN_RESOURCE_TYPE_NAME() *string
func CfnVpcLink_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental. 

func CfnVpcLink_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental. 

func CfnVpcLink_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func DomainName_IsConstruct 

func DomainName_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func DomainName_IsResource 

func DomainName_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func HttpApi_IsConstruct 

func HttpApi_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func HttpApi_IsResource 

func HttpApi_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func HttpAuthorizer_IsConstruct 

func HttpAuthorizer_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func HttpAuthorizer_IsResource 

func HttpAuthorizer_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func HttpIntegration_IsConstruct 

func HttpIntegration_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func HttpIntegration_IsResource 

func HttpIntegration_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func HttpRoute_IsConstruct 

func HttpRoute_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func HttpRoute_IsResource 

func HttpRoute_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func HttpStage_IsConstruct 

func HttpStage_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func HttpStage_IsResource 

func HttpStage_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewApiMapping_Override 

func NewApiMapping_Override(a ApiMapping, scope constructs.Construct, id *string, props *ApiMappingProps)

Experimental.

func NewCfnApiGatewayManagedOverrides_Override 

func NewCfnApiGatewayManagedOverrides_Override(c CfnApiGatewayManagedOverrides, scope awscdk.Construct, id *string, props *CfnApiGatewayManagedOverridesProps)

Create a new `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.

func NewCfnApiMapping_Override 

func NewCfnApiMapping_Override(c CfnApiMapping, scope awscdk.Construct, id *string, props *CfnApiMappingProps)

Create a new `AWS::ApiGatewayV2::ApiMapping`.

func NewCfnApi_Override 

func NewCfnApi_Override(c CfnApi, scope awscdk.Construct, id *string, props *CfnApiProps)

Create a new `AWS::ApiGatewayV2::Api`.

func NewCfnAuthorizer_Override 

func NewCfnAuthorizer_Override(c CfnAuthorizer, scope awscdk.Construct, id *string, props *CfnAuthorizerProps)

Create a new `AWS::ApiGatewayV2::Authorizer`.

func NewCfnDeployment_Override 

func NewCfnDeployment_Override(c CfnDeployment, scope awscdk.Construct, id *string, props *CfnDeploymentProps)

Create a new `AWS::ApiGatewayV2::Deployment`.

func NewCfnDomainName_Override 

func NewCfnDomainName_Override(c CfnDomainName, scope awscdk.Construct, id *string, props *CfnDomainNameProps)

Create a new `AWS::ApiGatewayV2::DomainName`.

func NewCfnIntegrationResponse_Override 

func NewCfnIntegrationResponse_Override(c CfnIntegrationResponse, scope awscdk.Construct, id *string, props *CfnIntegrationResponseProps)

Create a new `AWS::ApiGatewayV2::IntegrationResponse`.

func NewCfnIntegration_Override 

func NewCfnIntegration_Override(c CfnIntegration, scope awscdk.Construct, id *string, props *CfnIntegrationProps)

Create a new `AWS::ApiGatewayV2::Integration`.

func NewCfnModel_Override 

func NewCfnModel_Override(c CfnModel, scope awscdk.Construct, id *string, props *CfnModelProps)

Create a new `AWS::ApiGatewayV2::Model`.

func NewCfnRouteResponse_Override 

func NewCfnRouteResponse_Override(c CfnRouteResponse, scope awscdk.Construct, id *string, props *CfnRouteResponseProps)

Create a new `AWS::ApiGatewayV2::RouteResponse`.

func NewCfnRoute_Override 

func NewCfnRoute_Override(c CfnRoute, scope awscdk.Construct, id *string, props *CfnRouteProps)

Create a new `AWS::ApiGatewayV2::Route`.

func NewCfnStage_Override 

func NewCfnStage_Override(c CfnStage, scope awscdk.Construct, id *string, props *CfnStageProps)

Create a new `AWS::ApiGatewayV2::Stage`. 

func NewCfnVpcLink_Override(c CfnVpcLink, scope awscdk.Construct, id *string, props *CfnVpcLinkProps)

Create a new `AWS::ApiGatewayV2::VpcLink`.

func NewDomainName_Override 

func NewDomainName_Override(d DomainName, scope constructs.Construct, id *string, props *DomainNameProps)

Experimental.

func NewHttpApi_Override 

func NewHttpApi_Override(h HttpApi, scope constructs.Construct, id *string, props *HttpApiProps)

Experimental.

func NewHttpAuthorizer_Override 

func NewHttpAuthorizer_Override(h HttpAuthorizer, scope constructs.Construct, id *string, props *HttpAuthorizerProps)

Experimental.

func NewHttpIntegration_Override 

func NewHttpIntegration_Override(h HttpIntegration, scope constructs.Construct, id *string, props *HttpIntegrationProps)

Experimental.

func NewHttpNoneAuthorizer_Override 

func NewHttpNoneAuthorizer_Override(h HttpNoneAuthorizer)

Experimental.

func NewHttpRouteIntegration_Override 

func NewHttpRouteIntegration_Override(h HttpRouteIntegration, id *string)

Initialize an integration for a route on http api. Experimental.

func NewHttpRoute_Override 

func NewHttpRoute_Override(h HttpRoute, scope constructs.Construct, id *string, props *HttpRouteProps)

Experimental.

func NewHttpStage_Override 

func NewHttpStage_Override(h HttpStage, scope constructs.Construct, id *string, props *HttpStageProps)

Experimental.

func NewIntegrationCredentials_Override 

func NewIntegrationCredentials_Override(i IntegrationCredentials)

Experimental.

func NewMappingValue_Override 

func NewMappingValue_Override(m MappingValue, value *string)

Experimental.

func NewParameterMapping_Override 

func NewParameterMapping_Override(p ParameterMapping)

Experimental. 

func NewVpcLink_Override(v VpcLink, scope constructs.Construct, id *string, props *VpcLinkProps)

Experimental.

func NewWebSocketApiKeySelectionExpression_Override 

func NewWebSocketApiKeySelectionExpression_Override(w WebSocketApiKeySelectionExpression, customApiKeySelector *string)

Experimental.

func NewWebSocketApi_Override 

func NewWebSocketApi_Override(w WebSocketApi, scope constructs.Construct, id *string, props *WebSocketApiProps)

Experimental.

func NewWebSocketAuthorizer_Override 

func NewWebSocketAuthorizer_Override(w WebSocketAuthorizer, scope constructs.Construct, id *string, props *WebSocketAuthorizerProps)

Experimental.

func NewWebSocketIntegration_Override 

func NewWebSocketIntegration_Override(w WebSocketIntegration, scope constructs.Construct, id *string, props *WebSocketIntegrationProps)

Experimental.

func NewWebSocketNoneAuthorizer_Override 

func NewWebSocketNoneAuthorizer_Override(w WebSocketNoneAuthorizer)

Experimental.

func NewWebSocketRouteIntegration_Override 

func NewWebSocketRouteIntegration_Override(w WebSocketRouteIntegration, id *string)

Initialize an integration for a route on websocket api. Experimental.

func NewWebSocketRoute_Override 

func NewWebSocketRoute_Override(w WebSocketRoute, scope constructs.Construct, id *string, props *WebSocketRouteProps)

Experimental.

func NewWebSocketStage_Override 

func NewWebSocketStage_Override(w WebSocketStage, scope constructs.Construct, id *string, props *WebSocketStageProps)

Experimental. 

func VpcLink_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental. 

func VpcLink_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func WebSocketApi_IsConstruct 

func WebSocketApi_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func WebSocketApi_IsResource 

func WebSocketApi_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func WebSocketAuthorizer_IsConstruct 

func WebSocketAuthorizer_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func WebSocketAuthorizer_IsResource 

func WebSocketAuthorizer_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func WebSocketIntegration_IsConstruct 

func WebSocketIntegration_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func WebSocketIntegration_IsResource 

func WebSocketIntegration_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func WebSocketRoute_IsConstruct 

func WebSocketRoute_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func WebSocketRoute_IsResource 

func WebSocketRoute_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func WebSocketStage_IsConstruct 

func WebSocketStage_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func WebSocketStage_IsResource 

func WebSocketStage_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

Types

type AddRoutesOptions 

type AddRoutesOptions struct {
	// The integration to be configured on this route.
	// Experimental.
	Integration HttpRouteIntegration `json:"integration" yaml:"integration"`
	// The path at which all of these routes are configured.
	// Experimental.
	Path *string `json:"path" yaml:"path"`
	// The list of OIDC scopes to include in the authorization.
	//
	// These scopes will override the default authorization scopes on the gateway.
	// Set to [] to remove default scopes
	// Experimental.
	AuthorizationScopes *[]*string `json:"authorizationScopes" yaml:"authorizationScopes"`
	// Authorizer to be associated to these routes.
	//
	// Use NoneAuthorizer to remove the default authorizer for the api
	// Experimental.
	Authorizer IHttpRouteAuthorizer `json:"authorizer" yaml:"authorizer"`
	// The HTTP methods to be configured.
	// Experimental.
	Methods *[]HttpMethod `json:"methods" yaml:"methods"`
}

Options for the Route with Integration resource.

TODO: EXAMPLE

Experimental.

type ApiMapping 

type ApiMapping interface {
	awscdk.Resource
	IApiMapping
	ApiMappingId() *string
	DomainName() IDomainName
	Env() *awscdk.ResourceEnvironment
	MappingKey() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Create a new API mapping for API Gateway API endpoint.

TODO: EXAMPLE

Experimental.

func NewApiMapping 

func NewApiMapping(scope constructs.Construct, id *string, props *ApiMappingProps) ApiMapping

Experimental.

type ApiMappingAttributes 

type ApiMappingAttributes struct {
	// The API mapping ID.
	// Experimental.
	ApiMappingId *string `json:"apiMappingId" yaml:"apiMappingId"`
}

The attributes used to import existing ApiMapping.

TODO: EXAMPLE

Experimental.

type ApiMappingProps 

type ApiMappingProps struct {
	// The Api to which this mapping is applied.
	// Experimental.
	Api IApi `json:"api" yaml:"api"`
	// custom domain name of the mapping target.
	// Experimental.
	DomainName IDomainName `json:"domainName" yaml:"domainName"`
	// Api mapping key.
	//
	// The path where this stage should be mapped to on the domain
	// Experimental.
	ApiMappingKey *string `json:"apiMappingKey" yaml:"apiMappingKey"`
	// stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.
	// Experimental.
	Stage IStage `json:"stage" yaml:"stage"`
}

Properties used to create the ApiMapping resource.

TODO: EXAMPLE

Experimental.

type AuthorizerPayloadVersion 

type AuthorizerPayloadVersion string

Payload format version for lambda authorizers. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html

Experimental. 

const (
	AuthorizerPayloadVersion_VERSION_1_0 AuthorizerPayloadVersion = "VERSION_1_0"
	AuthorizerPayloadVersion_VERSION_2_0 AuthorizerPayloadVersion = "VERSION_2_0"
)

type BatchHttpRouteOptions 

type BatchHttpRouteOptions struct {
	// The integration to be configured on this route.
	// Experimental.
	Integration HttpRouteIntegration `json:"integration" yaml:"integration"`
}

Options used when configuring multiple routes, at once.

The options here are the ones that would be configured for all being set up.

TODO: EXAMPLE

Experimental.

type CfnApi 

type CfnApi interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiKeySelectionExpression() *string
	SetApiKeySelectionExpression(val *string)
	AttrApiEndpoint() *string
	BasePath() *string
	SetBasePath(val *string)
	Body() interface{}
	SetBody(val interface{})
	BodyS3Location() interface{}
	SetBodyS3Location(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CorsConfiguration() interface{}
	SetCorsConfiguration(val interface{})
	CreationStack() *[]*string
	CredentialsArn() *string
	SetCredentialsArn(val *string)
	Description() *string
	SetDescription(val *string)
	DisableExecuteApiEndpoint() interface{}
	SetDisableExecuteApiEndpoint(val interface{})
	DisableSchemaValidation() interface{}
	SetDisableSchemaValidation(val interface{})
	FailOnWarnings() interface{}
	SetFailOnWarnings(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	ProtocolType() *string
	SetProtocolType(val *string)
	Ref() *string
	RouteKey() *string
	SetRouteKey(val *string)
	RouteSelectionExpression() *string
	SetRouteSelectionExpression(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Target() *string
	SetTarget(val *string)
	UpdatedProperites() *map[string]interface{}
	Version() *string
	SetVersion(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::Api`.

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

TODO: EXAMPLE

func NewCfnApi 

func NewCfnApi(scope awscdk.Construct, id *string, props *CfnApiProps) CfnApi

Create a new `AWS::ApiGatewayV2::Api`.

type CfnApiGatewayManagedOverrides 

type CfnApiGatewayManagedOverrides interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Integration() interface{}
	SetIntegration(val interface{})
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Route() interface{}
	SetRoute(val interface{})
	Stack() awscdk.Stack
	Stage() interface{}
	SetStage(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.

The `AWS::ApiGatewayV2::ApiGatewayManagedOverrides` resource overrides the default properties of API Gateway-managed resources that are implicitly configured for you when you use quick create. When you create an API by using quick create, an `AWS::ApiGatewayV2::Route` , `AWS::ApiGatewayV2::Integration` , and `AWS::ApiGatewayV2::Stage` are created for you and associated with your `AWS::ApiGatewayV2::Api` . The `AWS::ApiGatewayV2::ApiGatewayManagedOverrides` resource enables you to set, or override the properties of these implicit resources. Supported only for HTTP APIs.

TODO: EXAMPLE

func NewCfnApiGatewayManagedOverrides 

func NewCfnApiGatewayManagedOverrides(scope awscdk.Construct, id *string, props *CfnApiGatewayManagedOverridesProps) CfnApiGatewayManagedOverrides

Create a new `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.

type CfnApiGatewayManagedOverridesProps 

type CfnApiGatewayManagedOverridesProps struct {
	// The ID of the API for which to override the configuration of API Gateway-managed resources.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// Overrides the integration configuration for an API Gateway-managed integration.
	Integration interface{} `json:"integration" yaml:"integration"`
	// Overrides the route configuration for an API Gateway-managed route.
	Route interface{} `json:"route" yaml:"route"`
	// Overrides the stage configuration for an API Gateway-managed stage.
	Stage interface{} `json:"stage" yaml:"stage"`
}

Properties for defining a `CfnApiGatewayManagedOverrides`.

TODO: EXAMPLE

type CfnApiGatewayManagedOverrides_AccessLogSettingsProperty 

type CfnApiGatewayManagedOverrides_AccessLogSettingsProperty struct {
	// The ARN of the CloudWatch Logs log group to receive access logs.
	DestinationArn *string `json:"destinationArn" yaml:"destinationArn"`
	// A single line format of the access logs of data, as specified by selected $context variables.
	//
	// The format must include at least $context.requestId.
	Format *string `json:"format" yaml:"format"`
}

The `AccessLogSettings` property overrides the access log settings for an API Gateway-managed stage.

TODO: EXAMPLE

type CfnApiGatewayManagedOverrides_IntegrationOverridesProperty 

type CfnApiGatewayManagedOverrides_IntegrationOverridesProperty struct {
	// The description of the integration.
	Description *string `json:"description" yaml:"description"`
	// Specifies the integration's HTTP method type.
	IntegrationMethod *string `json:"integrationMethod" yaml:"integrationMethod"`
	// Specifies the format of the payload sent to an integration.
	//
	// Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are `1.0` and `2.0` . For all other integrations, `1.0` is the only supported value. To learn more, see [Working with AWS Lambda proxy integrations for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html) .
	PayloadFormatVersion *string `json:"payloadFormatVersion" yaml:"payloadFormatVersion"`
	// Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
	//
	// The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
	TimeoutInMillis *float64 `json:"timeoutInMillis" yaml:"timeoutInMillis"`
}

The `IntegrationOverrides` property overrides the integration settings for an API Gateway-managed integration.

If you remove this property, API Gateway restores the default values.

TODO: EXAMPLE

type CfnApiGatewayManagedOverrides_RouteOverridesProperty 

type CfnApiGatewayManagedOverrides_RouteOverridesProperty struct {
	// The authorization scopes supported by this route.
	AuthorizationScopes *[]*string `json:"authorizationScopes" yaml:"authorizationScopes"`
	// The authorization type for the route.
	//
	// To learn more, see [AuthorizationType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype) .
	AuthorizationType *string `json:"authorizationType" yaml:"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 *string `json:"authorizerId" yaml:"authorizerId"`
	// The operation name for the route.
	OperationName *string `json:"operationName" yaml:"operationName"`
	// 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.
	Target *string `json:"target" yaml:"target"`
}

The `RouteOverrides` property overrides the route configuration for an API Gateway-managed route.

If you remove this property, API Gateway restores the default values.

TODO: EXAMPLE

type CfnApiGatewayManagedOverrides_RouteSettingsProperty 

type CfnApiGatewayManagedOverrides_RouteSettingsProperty struct {
	// Specifies whether ( `true` ) or not ( `false` ) data trace logging is enabled for this route.
	//
	// This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
	DataTraceEnabled interface{} `json:"dataTraceEnabled" yaml:"dataTraceEnabled"`
	// Specifies whether detailed metrics are enabled.
	DetailedMetricsEnabled interface{} `json:"detailedMetricsEnabled" yaml:"detailedMetricsEnabled"`
	// Specifies the logging level for this route: `INFO` , `ERROR` , or `OFF` .
	//
	// This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
	LoggingLevel *string `json:"loggingLevel" yaml:"loggingLevel"`
	// Specifies the throttling burst limit.
	ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit" yaml:"throttlingBurstLimit"`
	// Specifies the throttling rate limit.
	ThrottlingRateLimit *float64 `json:"throttlingRateLimit" yaml:"throttlingRateLimit"`
}

The `RouteSettings` property overrides the route settings for an API Gateway-managed route.

TODO: EXAMPLE

type CfnApiGatewayManagedOverrides_StageOverridesProperty 

type CfnApiGatewayManagedOverrides_StageOverridesProperty struct {
	// Settings for logging access in a stage.
	AccessLogSettings interface{} `json:"accessLogSettings" yaml:"accessLogSettings"`
	// Specifies whether updates to an API automatically trigger a new deployment.
	//
	// The default value is `true` .
	AutoDeploy interface{} `json:"autoDeploy" yaml:"autoDeploy"`
	// The default route settings for the stage.
	DefaultRouteSettings interface{} `json:"defaultRouteSettings" yaml:"defaultRouteSettings"`
	// The description for the API stage.
	Description *string `json:"description" yaml:"description"`
	// Route settings for the stage.
	RouteSettings interface{} `json:"routeSettings" yaml:"routeSettings"`
	// A map that defines the stage variables for a `Stage` .
	//
	// Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
	StageVariables interface{} `json:"stageVariables" yaml:"stageVariables"`
}

The `StageOverrides` property overrides the stage configuration for an API Gateway-managed stage.

If you remove this property, API Gateway restores the default values.

TODO: EXAMPLE

type CfnApiMapping 

type CfnApiMapping interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	ApiMappingKey() *string
	SetApiMappingKey(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DomainName() *string
	SetDomainName(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Stage() *string
	SetStage(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::ApiMapping`.

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

TODO: EXAMPLE

func NewCfnApiMapping 

func NewCfnApiMapping(scope awscdk.Construct, id *string, props *CfnApiMappingProps) CfnApiMapping

Create a new `AWS::ApiGatewayV2::ApiMapping`.

type CfnApiMappingProps 

type CfnApiMappingProps struct {
	// The identifier of the API.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// The domain name.
	DomainName *string `json:"domainName" yaml:"domainName"`
	// The API stage.
	Stage *string `json:"stage" yaml:"stage"`
	// The API mapping key.
	ApiMappingKey *string `json:"apiMappingKey" yaml:"apiMappingKey"`
}

Properties for defining a `CfnApiMapping`.

TODO: EXAMPLE

type CfnApiProps 

type CfnApiProps 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 *string `json:"apiKeySelectionExpression" yaml:"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 *string `json:"basePath" yaml:"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.
	Body interface{} `json:"body" yaml:"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 interface{} `json:"bodyS3Location" yaml:"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 interface{} `json:"corsConfiguration" yaml:"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 *string `json:"credentialsArn" yaml:"credentialsArn"`
	// The description of the API.
	Description *string `json:"description" yaml:"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 interface{} `json:"disableExecuteApiEndpoint" yaml:"disableExecuteApiEndpoint"`
	// Avoid validating models when creating a deployment.
	//
	// Supported only for WebSocket APIs.
	DisableSchemaValidation interface{} `json:"disableSchemaValidation" yaml:"disableSchemaValidation"`
	// Specifies whether to rollback the API creation when a warning is encountered.
	//
	// By default, API creation continues if a warning is encountered.
	FailOnWarnings interface{} `json:"failOnWarnings" yaml:"failOnWarnings"`
	// The name of the API.
	//
	// Required unless you specify an OpenAPI definition for `Body` or `S3BodyLocation` .
	Name *string `json:"name" yaml:"name"`
	// The API protocol.
	//
	// Valid values are `WEBSOCKET` or `HTTP` . Required unless you specify an OpenAPI definition for `Body` or `S3BodyLocation` .
	ProtocolType *string `json:"protocolType" yaml:"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 *string `json:"routeKey" yaml:"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 *string `json:"routeSelectionExpression" yaml:"routeSelectionExpression"`
	// The collection of tags.
	//
	// Each tag element is associated with a given resource.
	Tags interface{} `json:"tags" yaml:"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 *string `json:"target" yaml:"target"`
	// A version identifier for the API.
	Version *string `json:"version" yaml:"version"`
}

Properties for defining a `CfnApi`.

TODO: EXAMPLE

type CfnApi_BodyS3LocationProperty 

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

The `BodyS3Location` property specifies an S3 location from which to import an OpenAPI definition.

Supported only for HTTP APIs.

TODO: EXAMPLE

type CfnApi_CorsProperty 

type CfnApi_CorsProperty struct {
	// Specifies whether credentials are included in the CORS request.
	//
	// Supported only for HTTP APIs.
	AllowCredentials interface{} `json:"allowCredentials" yaml:"allowCredentials"`
	// Represents a collection of allowed headers.
	//
	// Supported only for HTTP APIs.
	AllowHeaders *[]*string `json:"allowHeaders" yaml:"allowHeaders"`
	// Represents a collection of allowed HTTP methods.
	//
	// Supported only for HTTP APIs.
	AllowMethods *[]*string `json:"allowMethods" yaml:"allowMethods"`
	// Represents a collection of allowed origins.
	//
	// Supported only for HTTP APIs.
	AllowOrigins *[]*string `json:"allowOrigins" yaml:"allowOrigins"`
	// Represents a collection of exposed headers.
	//
	// Supported only for HTTP APIs.
	ExposeHeaders *[]*string `json:"exposeHeaders" yaml:"exposeHeaders"`
	// The number of seconds that the browser should cache preflight request results.
	//
	// Supported only for HTTP APIs.
	MaxAge *float64 `json:"maxAge" yaml:"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.

TODO: EXAMPLE

type CfnAuthorizer 

type CfnAuthorizer interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	AuthorizerCredentialsArn() *string
	SetAuthorizerCredentialsArn(val *string)
	AuthorizerPayloadFormatVersion() *string
	SetAuthorizerPayloadFormatVersion(val *string)
	AuthorizerResultTtlInSeconds() *float64
	SetAuthorizerResultTtlInSeconds(val *float64)
	AuthorizerType() *string
	SetAuthorizerType(val *string)
	AuthorizerUri() *string
	SetAuthorizerUri(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	EnableSimpleResponses() interface{}
	SetEnableSimpleResponses(val interface{})
	IdentitySource() *[]*string
	SetIdentitySource(val *[]*string)
	IdentityValidationExpression() *string
	SetIdentityValidationExpression(val *string)
	JwtConfiguration() interface{}
	SetJwtConfiguration(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::Authorizer`.

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

TODO: EXAMPLE

func NewCfnAuthorizer 

func NewCfnAuthorizer(scope awscdk.Construct, id *string, props *CfnAuthorizerProps) CfnAuthorizer

Create a new `AWS::ApiGatewayV2::Authorizer`.

type CfnAuthorizerProps 

type CfnAuthorizerProps struct {
	// The API identifier.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// 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 `json:"authorizerType" yaml:"authorizerType"`
	// The name of the authorizer.
	Name *string `json:"name" yaml:"name"`
	// 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 `json:"authorizerCredentialsArn" yaml:"authorizerCredentialsArn"`
	// 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 AWS Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) .
	AuthorizerPayloadFormatVersion *string `json:"authorizerPayloadFormatVersion" yaml:"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 *float64 `json:"authorizerResultTtlInSeconds" yaml:"authorizerResultTtlInSeconds"`
	// 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 `json:"authorizerUri" yaml:"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 AWS Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) .
	EnableSimpleResponses interface{} `json:"enableSimpleResponses" yaml:"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 AWS 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 `json:"identitySource" yaml:"identitySource"`
	// This parameter is not used.
	IdentityValidationExpression *string `json:"identityValidationExpression" yaml:"identityValidationExpression"`
	// The `JWTConfiguration` property specifies the configuration of a JWT authorizer.
	//
	// Required for the `JWT` authorizer type. Supported only for HTTP APIs.
	JwtConfiguration interface{} `json:"jwtConfiguration" yaml:"jwtConfiguration"`
}

Properties for defining a `CfnAuthorizer`.

TODO: EXAMPLE

type CfnAuthorizer_JWTConfigurationProperty 

type CfnAuthorizer_JWTConfigurationProperty 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 `json:"audience" yaml:"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 `json:"issuer" yaml:"issuer"`
}

The `JWTConfiguration` property specifies the configuration of a JWT authorizer.

Required for the `JWT` authorizer type. Supported only for HTTP APIs.

TODO: EXAMPLE

type CfnDeployment 

type CfnDeployment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	StageName() *string
	SetStageName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::Deployment`.

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

TODO: EXAMPLE

func NewCfnDeployment 

func NewCfnDeployment(scope awscdk.Construct, id *string, props *CfnDeploymentProps) CfnDeployment

Create a new `AWS::ApiGatewayV2::Deployment`.

type CfnDeploymentProps 

type CfnDeploymentProps struct {
	// The API identifier.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// The description for the deployment resource.
	Description *string `json:"description" yaml:"description"`
	// The name of an existing stage to associate with the deployment.
	StageName *string `json:"stageName" yaml:"stageName"`
}

Properties for defining a `CfnDeployment`.

TODO: EXAMPLE

type CfnDomainName 

type CfnDomainName interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrRegionalDomainName() *string
	AttrRegionalHostedZoneId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DomainName() *string
	SetDomainName(val *string)
	DomainNameConfigurations() interface{}
	SetDomainNameConfigurations(val interface{})
	LogicalId() *string
	MutualTlsAuthentication() interface{}
	SetMutualTlsAuthentication(val interface{})
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::DomainName`.

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

TODO: EXAMPLE

func NewCfnDomainName 

func NewCfnDomainName(scope awscdk.Construct, id *string, props *CfnDomainNameProps) CfnDomainName

Create a new `AWS::ApiGatewayV2::DomainName`.

type CfnDomainNameProps 

type CfnDomainNameProps struct {
	// The custom domain name for your API in Amazon API Gateway.
	//
	// Uppercase letters are not supported.
	DomainName *string `json:"domainName" yaml:"domainName"`
	// The domain name configurations.
	DomainNameConfigurations interface{} `json:"domainNameConfigurations" yaml:"domainNameConfigurations"`
	// The mutual TLS authentication configuration for a custom domain name.
	MutualTlsAuthentication interface{} `json:"mutualTlsAuthentication" yaml:"mutualTlsAuthentication"`
	// The collection of tags associated with a domain name.
	Tags interface{} `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnDomainName`.

TODO: EXAMPLE

type CfnDomainName_DomainNameConfigurationProperty 

type CfnDomainName_DomainNameConfigurationProperty 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 `json:"certificateArn" yaml:"certificateArn"`
	// The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
	CertificateName *string `json:"certificateName" yaml:"certificateName"`
	// The endpoint type.
	EndpointType *string `json:"endpointType" yaml:"endpointType"`
	// The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
	//
	// Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
	OwnershipVerificationCertificateArn *string `json:"ownershipVerificationCertificateArn" yaml:"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 `json:"securityPolicy" yaml:"securityPolicy"`
}

The `DomainNameConfiguration` property type specifies the configuration for a 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.

TODO: EXAMPLE

type CfnDomainName_MutualTlsAuthenticationProperty 

type CfnDomainName_MutualTlsAuthenticationProperty 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 `json:"truststoreUri" yaml:"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 `json:"truststoreVersion" yaml:"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.

TODO: EXAMPLE

type CfnIntegration 

type CfnIntegration interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConnectionId() *string
	SetConnectionId(val *string)
	ConnectionType() *string
	SetConnectionType(val *string)
	ContentHandlingStrategy() *string
	SetContentHandlingStrategy(val *string)
	CreationStack() *[]*string
	CredentialsArn() *string
	SetCredentialsArn(val *string)
	Description() *string
	SetDescription(val *string)
	IntegrationMethod() *string
	SetIntegrationMethod(val *string)
	IntegrationSubtype() *string
	SetIntegrationSubtype(val *string)
	IntegrationType() *string
	SetIntegrationType(val *string)
	IntegrationUri() *string
	SetIntegrationUri(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	PassthroughBehavior() *string
	SetPassthroughBehavior(val *string)
	PayloadFormatVersion() *string
	SetPayloadFormatVersion(val *string)
	Ref() *string
	RequestParameters() interface{}
	SetRequestParameters(val interface{})
	RequestTemplates() interface{}
	SetRequestTemplates(val interface{})
	ResponseParameters() interface{}
	SetResponseParameters(val interface{})
	Stack() awscdk.Stack
	TemplateSelectionExpression() *string
	SetTemplateSelectionExpression(val *string)
	TimeoutInMillis() *float64
	SetTimeoutInMillis(val *float64)
	TlsConfig() interface{}
	SetTlsConfig(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::Integration`.

The `AWS::ApiGatewayV2::Integration` resource creates an integration for an API.

TODO: EXAMPLE

func NewCfnIntegration 

func NewCfnIntegration(scope awscdk.Construct, id *string, props *CfnIntegrationProps) CfnIntegration

Create a new `AWS::ApiGatewayV2::Integration`.

type CfnIntegrationProps 

type CfnIntegrationProps struct {
	// The API identifier.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// The integration type of an integration. One of the following:.
	//
	// `AWS` : for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
	//
	// `AWS_PROXY` : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
	//
	// `HTTP` : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
	//
	// `HTTP_PROXY` : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an `HTTP_PROXY` integration.
	//
	// `MOCK` : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
	IntegrationType *string `json:"integrationType" yaml:"integrationType"`
	// The ID of the VPC link for a private integration.
	//
	// Supported only for HTTP APIs.
	ConnectionId *string `json:"connectionId" yaml:"connectionId"`
	// The type of the network connection to the integration endpoint.
	//
	// Specify `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and resources in a VPC. The default value is `INTERNET` .
	ConnectionType *string `json:"connectionType" yaml:"connectionType"`
	// 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 `json:"contentHandlingStrategy" yaml:"contentHandlingStrategy"`
	// Specifies the credentials required for the integration, if any.
	//
	// For AWS integrations, 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 the string `arn:aws:iam::*:user/*` . To use resource-based permissions on supported AWS services, don't specify this parameter.
	CredentialsArn *string `json:"credentialsArn" yaml:"credentialsArn"`
	// The description of the integration.
	Description *string `json:"description" yaml:"description"`
	// Specifies the integration's HTTP method type.
	IntegrationMethod *string `json:"integrationMethod" yaml:"integrationMethod"`
	// Supported only for HTTP API `AWS_PROXY` integrations.
	//
	// Specifies the AWS service action to invoke. To learn more, see [Integration subtype reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html) .
	IntegrationSubtype *string `json:"integrationSubtype" yaml:"integrationSubtype"`
	// For a Lambda integration, specify the URI of a Lambda function.
	//
	// For an HTTP integration, specify a fully-qualified URL.
	//
	// For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses `DiscoverInstances` to identify resources. You can use query parameters to target specific resources. To learn more, see [DiscoverInstances](https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) . For private integrations, all resources must be owned by the same AWS account .
	IntegrationUri *string `json:"integrationUri" yaml:"integrationUri"`
	// Specifies the pass-through behavior for incoming requests based on the `Content-Type` header in the request, and the available mapping templates specified as the `requestTemplates` property on the `Integration` resource.
	//
	// There are three valid values: `WHEN_NO_MATCH` , `WHEN_NO_TEMPLATES` , and `NEVER` . Supported only for WebSocket APIs.
	//
	// `WHEN_NO_MATCH` passes the request body for unmapped content types through to the integration backend without transformation.
	//
	// `NEVER` rejects unmapped content types with an `HTTP 415 Unsupported Media Type` response.
	//
	// `WHEN_NO_TEMPLATES` allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same `HTTP 415 Unsupported Media Type` response.
	PassthroughBehavior *string `json:"passthroughBehavior" yaml:"passthroughBehavior"`
	// Specifies the format of the payload sent to an integration.
	//
	// Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are `1.0` and `2.0` . For all other integrations, `1.0` is the only supported value. To learn more, see [Working with AWS Lambda proxy integrations for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html) .
	PayloadFormatVersion *string `json:"payloadFormatVersion" yaml:"payloadFormatVersion"`
	// For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
	//
	// The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of `method.request. {location} . {name}` , where `{location}` is `querystring` , `path` , or `header` ; and `{name}` must be a valid and unique method request parameter name.
	//
	// For HTTP API integrations with a specified `integrationSubtype` , request parameters are a key-value map specifying parameters that are passed to `AWS_PROXY` integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Working with AWS service integrations for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html) .
	//
	// For HTTP API integrations without a specified `integrationSubtype` request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be `append` , `overwrite` or `remove` . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .
	RequestParameters interface{} `json:"requestParameters" yaml:"requestParameters"`
	// Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
	//
	// The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
	RequestTemplates interface{} `json:"requestTemplates" yaml:"requestTemplates"`
	// Supported only for HTTP APIs.
	//
	// You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type [`ResponseParameterList`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameterlist.html) . To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .
	ResponseParameters interface{} `json:"responseParameters" yaml:"responseParameters"`
	// The template selection expression for the integration.
	//
	// Supported only for WebSocket APIs.
	TemplateSelectionExpression *string `json:"templateSelectionExpression" yaml:"templateSelectionExpression"`
	// Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
	//
	// The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
	TimeoutInMillis *float64 `json:"timeoutInMillis" yaml:"timeoutInMillis"`
	// The TLS configuration for a private integration.
	//
	// If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
	TlsConfig interface{} `json:"tlsConfig" yaml:"tlsConfig"`
}

Properties for defining a `CfnIntegration`.

TODO: EXAMPLE

type CfnIntegrationResponse 

type CfnIntegrationResponse interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ContentHandlingStrategy() *string
	SetContentHandlingStrategy(val *string)
	CreationStack() *[]*string
	IntegrationId() *string
	SetIntegrationId(val *string)
	IntegrationResponseKey() *string
	SetIntegrationResponseKey(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	ResponseParameters() interface{}
	SetResponseParameters(val interface{})
	ResponseTemplates() interface{}
	SetResponseTemplates(val interface{})
	Stack() awscdk.Stack
	TemplateSelectionExpression() *string
	SetTemplateSelectionExpression(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::IntegrationResponse`.

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

TODO: EXAMPLE

func NewCfnIntegrationResponse 

func NewCfnIntegrationResponse(scope awscdk.Construct, id *string, props *CfnIntegrationResponseProps) CfnIntegrationResponse

Create a new `AWS::ApiGatewayV2::IntegrationResponse`.

type CfnIntegrationResponseProps 

type CfnIntegrationResponseProps struct {
	// The API identifier.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// The integration ID.
	IntegrationId *string `json:"integrationId" yaml:"integrationId"`
	// The integration response key.
	IntegrationResponseKey *string `json:"integrationResponseKey" yaml:"integrationResponseKey"`
	// 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 `json:"contentHandlingStrategy" yaml:"contentHandlingStrategy"`
	// 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.
	ResponseParameters interface{} `json:"responseParameters" yaml:"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.
	ResponseTemplates interface{} `json:"responseTemplates" yaml:"responseTemplates"`
	// The template selection expression for the integration response.
	//
	// Supported only for WebSocket APIs.
	TemplateSelectionExpression *string `json:"templateSelectionExpression" yaml:"templateSelectionExpression"`
}

Properties for defining a `CfnIntegrationResponse`.

TODO: EXAMPLE

type CfnIntegration_ResponseParameterListProperty 

type CfnIntegration_ResponseParameterListProperty struct {
	// Supported only for HTTP APIs.
	//
	// You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match the pattern `<action>:<header>.<location>` or `overwrite.statuscode` . The action can be `append` , `overwrite` or `remove` . The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .
	ResponseParameters interface{} `json:"responseParameters" yaml:"responseParameters"`
}

Specifies a list of response parameters for an HTTP API.

TODO: EXAMPLE

type CfnIntegration_ResponseParameterProperty 

type CfnIntegration_ResponseParameterProperty struct {
	// Specifies the location of the response to modify, and how to modify it.
	//
	// To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .
	Destination *string `json:"destination" yaml:"destination"`
	// Specifies the data to update the parameter with.
	//
	// To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .
	Source *string `json:"source" yaml:"source"`
}

Supported only for HTTP APIs.

You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match the pattern `<action>:<header>.<location>` or `overwrite.statuscode` . The action can be `append` , `overwrite` or `remove` . The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .

TODO: EXAMPLE

type CfnIntegration_TlsConfigProperty 

type CfnIntegration_TlsConfigProperty struct {
	// If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate.
	//
	// The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
	ServerNameToVerify *string `json:"serverNameToVerify" yaml:"serverNameToVerify"`
}

The `TlsConfig` property specifies the TLS configuration for a private integration.

If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

TODO: EXAMPLE

type CfnModel 

type CfnModel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ContentType() *string
	SetContentType(val *string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Schema() interface{}
	SetSchema(val interface{})
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::Model`.

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

TODO: EXAMPLE

func NewCfnModel 

func NewCfnModel(scope awscdk.Construct, id *string, props *CfnModelProps) CfnModel

Create a new `AWS::ApiGatewayV2::Model`.

type CfnModelProps 

type CfnModelProps struct {
	// The API identifier.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// The name of the model.
	Name *string `json:"name" yaml:"name"`
	// The schema for the model.
	//
	// For application/json models, this should be JSON schema draft 4 model.
	Schema interface{} `json:"schema" yaml:"schema"`
	// The content-type for the model, for example, "application/json".
	ContentType *string `json:"contentType" yaml:"contentType"`
	// The description of the model.
	Description *string `json:"description" yaml:"description"`
}

Properties for defining a `CfnModel`.

TODO: EXAMPLE

type CfnRoute 

type CfnRoute interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	ApiKeyRequired() interface{}
	SetApiKeyRequired(val interface{})
	AuthorizationScopes() *[]*string
	SetAuthorizationScopes(val *[]*string)
	AuthorizationType() *string
	SetAuthorizationType(val *string)
	AuthorizerId() *string
	SetAuthorizerId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	ModelSelectionExpression() *string
	SetModelSelectionExpression(val *string)
	Node() awscdk.ConstructNode
	OperationName() *string
	SetOperationName(val *string)
	Ref() *string
	RequestModels() interface{}
	SetRequestModels(val interface{})
	RequestParameters() interface{}
	SetRequestParameters(val interface{})
	RouteKey() *string
	SetRouteKey(val *string)
	RouteResponseSelectionExpression() *string
	SetRouteResponseSelectionExpression(val *string)
	Stack() awscdk.Stack
	Target() *string
	SetTarget(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::Route`.

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

TODO: EXAMPLE

func NewCfnRoute 

func NewCfnRoute(scope awscdk.Construct, id *string, props *CfnRouteProps) CfnRoute

Create a new `AWS::ApiGatewayV2::Route`.

type CfnRouteProps 

type CfnRouteProps struct {
	// The API identifier.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// 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 `json:"routeKey" yaml:"routeKey"`
	// Specifies whether an API key is required for the route.
	//
	// Supported only for WebSocket APIs.
	ApiKeyRequired interface{} `json:"apiKeyRequired" yaml:"apiKeyRequired"`
	// The authorization scopes supported by this route.
	AuthorizationScopes *[]*string `json:"authorizationScopes" yaml:"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 `json:"authorizationType" yaml:"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 *string `json:"authorizerId" yaml:"authorizerId"`
	// The model selection expression for the route.
	//
	// Supported only for WebSocket APIs.
	ModelSelectionExpression *string `json:"modelSelectionExpression" yaml:"modelSelectionExpression"`
	// The operation name for the route.
	OperationName *string `json:"operationName" yaml:"operationName"`
	// The request models for the route.
	//
	// Supported only for WebSocket APIs.
	RequestModels interface{} `json:"requestModels" yaml:"requestModels"`
	// The request parameters for the route.
	//
	// Supported only for WebSocket APIs.
	RequestParameters interface{} `json:"requestParameters" yaml:"requestParameters"`
	// The route response selection expression for the route.
	//
	// Supported only for WebSocket APIs.
	RouteResponseSelectionExpression *string `json:"routeResponseSelectionExpression" yaml:"routeResponseSelectionExpression"`
	// The target for the route.
	Target *string `json:"target" yaml:"target"`
}

Properties for defining a `CfnRoute`.

TODO: EXAMPLE

type CfnRouteResponse 

type CfnRouteResponse interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiId() *string
	SetApiId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	ModelSelectionExpression() *string
	SetModelSelectionExpression(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	ResponseModels() interface{}
	SetResponseModels(val interface{})
	ResponseParameters() interface{}
	SetResponseParameters(val interface{})
	RouteId() *string
	SetRouteId(val *string)
	RouteResponseKey() *string
	SetRouteResponseKey(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::RouteResponse`.

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

TODO: EXAMPLE

func NewCfnRouteResponse 

func NewCfnRouteResponse(scope awscdk.Construct, id *string, props *CfnRouteResponseProps) CfnRouteResponse

Create a new `AWS::ApiGatewayV2::RouteResponse`.

type CfnRouteResponseProps 

type CfnRouteResponseProps struct {
	// The API identifier.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// The route ID.
	RouteId *string `json:"routeId" yaml:"routeId"`
	// The route response key.
	RouteResponseKey *string `json:"routeResponseKey" yaml:"routeResponseKey"`
	// The model selection expression for the route response.
	//
	// Supported only for WebSocket APIs.
	ModelSelectionExpression *string `json:"modelSelectionExpression" yaml:"modelSelectionExpression"`
	// The response models for the route response.
	ResponseModels interface{} `json:"responseModels" yaml:"responseModels"`
	// The route response parameters.
	ResponseParameters interface{} `json:"responseParameters" yaml:"responseParameters"`
}

Properties for defining a `CfnRouteResponse`.

TODO: EXAMPLE

type CfnRouteResponse_ParameterConstraintsProperty 

type CfnRouteResponse_ParameterConstraintsProperty struct {
	// Specifies whether the parameter is required.
	Required interface{} `json:"required" yaml:"required"`
}

Specifies whether the parameter is required.

TODO: EXAMPLE

type CfnRoute_ParameterConstraintsProperty 

type CfnRoute_ParameterConstraintsProperty struct {
	// Specifies whether the parameter is required.
	Required interface{} `json:"required" yaml:"required"`
}

Specifies whether the parameter is required.

TODO: EXAMPLE

type CfnStage 

type CfnStage interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AccessLogSettings() interface{}
	SetAccessLogSettings(val interface{})
	AccessPolicyId() *string
	SetAccessPolicyId(val *string)
	ApiId() *string
	SetApiId(val *string)
	AutoDeploy() interface{}
	SetAutoDeploy(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ClientCertificateId() *string
	SetClientCertificateId(val *string)
	CreationStack() *[]*string
	DefaultRouteSettings() interface{}
	SetDefaultRouteSettings(val interface{})
	DeploymentId() *string
	SetDeploymentId(val *string)
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	RouteSettings() interface{}
	SetRouteSettings(val interface{})
	Stack() awscdk.Stack
	StageName() *string
	SetStageName(val *string)
	StageVariables() interface{}
	SetStageVariables(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::Stage`.

The `AWS::ApiGatewayV2::Stage` resource specifies a stage for an API. Each stage is a named reference to a deployment of the API and is made available for client applications to call. To learn more, see [Working with stages for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) and [Deploy a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html) .

TODO: EXAMPLE

func NewCfnStage 

func NewCfnStage(scope awscdk.Construct, id *string, props *CfnStageProps) CfnStage

Create a new `AWS::ApiGatewayV2::Stage`.

type CfnStageProps 

type CfnStageProps struct {
	// The API identifier.
	ApiId *string `json:"apiId" yaml:"apiId"`
	// The stage name.
	//
	// Stage names can contain only alphanumeric characters, hyphens, and underscores, or be `$default` . Maximum length is 128 characters.
	StageName *string `json:"stageName" yaml:"stageName"`
	// Settings for logging access in this stage.
	AccessLogSettings interface{} `json:"accessLogSettings" yaml:"accessLogSettings"`
	// This parameter is not currently supported.
	AccessPolicyId *string `json:"accessPolicyId" yaml:"accessPolicyId"`
	// Specifies whether updates to an API automatically trigger a new deployment.
	//
	// The default value is `false` .
	AutoDeploy interface{} `json:"autoDeploy" yaml:"autoDeploy"`
	// The identifier of a client certificate for a `Stage` .
	//
	// Supported only for WebSocket APIs.
	ClientCertificateId *string `json:"clientCertificateId" yaml:"clientCertificateId"`
	// The default route settings for the stage.
	DefaultRouteSettings interface{} `json:"defaultRouteSettings" yaml:"defaultRouteSettings"`
	// The deployment identifier for the API stage.
	//
	// Can't be updated if `autoDeploy` is enabled.
	DeploymentId *string `json:"deploymentId" yaml:"deploymentId"`
	// The description for the API stage.
	Description *string `json:"description" yaml:"description"`
	// Route settings for the stage.
	RouteSettings interface{} `json:"routeSettings" yaml:"routeSettings"`
	// A map that defines the stage variables for a `Stage` .
	//
	// Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
	StageVariables interface{} `json:"stageVariables" yaml:"stageVariables"`
	// The collection of tags.
	//
	// Each tag element is associated with a given resource.
	Tags interface{} `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnStage`.

TODO: EXAMPLE

type CfnStage_AccessLogSettingsProperty 

type CfnStage_AccessLogSettingsProperty struct {
	// The ARN of the CloudWatch Logs log group to receive access logs.
	//
	// This parameter is required to enable access logging.
	DestinationArn *string `json:"destinationArn" yaml:"destinationArn"`
	// A single line format of the access logs of data, as specified by selected $context variables.
	//
	// The format must include at least $context.requestId. This parameter is required to enable access logging.
	Format *string `json:"format" yaml:"format"`
}

Settings for logging access in a stage.

TODO: EXAMPLE

type CfnStage_RouteSettingsProperty 

type CfnStage_RouteSettingsProperty struct {
	// Specifies whether ( `true` ) or not ( `false` ) data trace logging is enabled for this route.
	//
	// This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
	DataTraceEnabled interface{} `json:"dataTraceEnabled" yaml:"dataTraceEnabled"`
	// Specifies whether detailed metrics are enabled.
	DetailedMetricsEnabled interface{} `json:"detailedMetricsEnabled" yaml:"detailedMetricsEnabled"`
	// Specifies the logging level for this route: `INFO` , `ERROR` , or `OFF` .
	//
	// This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
	LoggingLevel *string `json:"loggingLevel" yaml:"loggingLevel"`
	// Specifies the throttling burst limit.
	ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit" yaml:"throttlingBurstLimit"`
	// Specifies the throttling rate limit.
	ThrottlingRateLimit *float64 `json:"throttlingRateLimit" yaml:"throttlingRateLimit"`
}

Represents a collection of route settings.

TODO: EXAMPLE 

type CfnVpcLink interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	SecurityGroupIds() *[]*string
	SetSecurityGroupIds(val *[]*string)
	Stack() awscdk.Stack
	SubnetIds() *[]*string
	SetSubnetIds(val *[]*string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ApiGatewayV2::VpcLink`.

The `AWS::ApiGatewayV2::VpcLink` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from `PENDING` to `AVAILABLE` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide* .

TODO: EXAMPLE 

func NewCfnVpcLink(scope awscdk.Construct, id *string, props *CfnVpcLinkProps) CfnVpcLink

Create a new `AWS::ApiGatewayV2::VpcLink`.

type CfnVpcLinkProps 

type CfnVpcLinkProps struct {
	// The name of the VPC link.
	Name *string `json:"name" yaml:"name"`
	// A list of subnet IDs to include in the VPC link.
	SubnetIds *[]*string `json:"subnetIds" yaml:"subnetIds"`
	// A list of security group IDs for the VPC link.
	SecurityGroupIds *[]*string `json:"securityGroupIds" yaml:"securityGroupIds"`
	// The collection of tags.
	//
	// Each tag element is associated with a given resource.
	Tags interface{} `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnVpcLink`.

TODO: EXAMPLE

type CorsHttpMethod 

type CorsHttpMethod string

Supported CORS HTTP methods.

TODO: EXAMPLE

Experimental. 

const (
	CorsHttpMethod_ANY     CorsHttpMethod = "ANY"
	CorsHttpMethod_DELETE  CorsHttpMethod = "DELETE"
	CorsHttpMethod_GET     CorsHttpMethod = "GET"
	CorsHttpMethod_HEAD    CorsHttpMethod = "HEAD"
	CorsHttpMethod_OPTIONS CorsHttpMethod = "OPTIONS"
	CorsHttpMethod_PATCH   CorsHttpMethod = "PATCH"
	CorsHttpMethod_POST    CorsHttpMethod = "POST"
	CorsHttpMethod_PUT     CorsHttpMethod = "PUT"
)

type CorsPreflightOptions 

type CorsPreflightOptions struct {
	// Specifies whether credentials are included in the CORS request.
	// Experimental.
	AllowCredentials *bool `json:"allowCredentials" yaml:"allowCredentials"`
	// Represents a collection of allowed headers.
	// Experimental.
	AllowHeaders *[]*string `json:"allowHeaders" yaml:"allowHeaders"`
	// Represents a collection of allowed HTTP methods.
	// Experimental.
	AllowMethods *[]CorsHttpMethod `json:"allowMethods" yaml:"allowMethods"`
	// Represents a collection of allowed origins.
	// Experimental.
	AllowOrigins *[]*string `json:"allowOrigins" yaml:"allowOrigins"`
	// Represents a collection of exposed headers.
	// Experimental.
	ExposeHeaders *[]*string `json:"exposeHeaders" yaml:"exposeHeaders"`
	// The duration that the browser should cache preflight request results.
	// Experimental.
	MaxAge awscdk.Duration `json:"maxAge" yaml:"maxAge"`
}

Options for the CORS Configuration.

TODO: EXAMPLE

Experimental.

type DomainMappingOptions 

type DomainMappingOptions struct {
	// The domain name for the mapping.
	// Experimental.
	DomainName IDomainName `json:"domainName" yaml:"domainName"`
	// The API mapping key.
	//
	// Leave it undefined for the root path mapping.
	// Experimental.
	MappingKey *string `json:"mappingKey" yaml:"mappingKey"`
}

Options for DomainMapping.

TODO: EXAMPLE

Experimental.

type DomainName 

type DomainName interface {
	awscdk.Resource
	IDomainName
	Env() *awscdk.ResourceEnvironment
	Name() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	RegionalDomainName() *string
	RegionalHostedZoneId() *string
	Stack() awscdk.Stack
	AddEndpoint(options *EndpointOptions)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Custom domain resource for the API.

TODO: EXAMPLE

Experimental.

func NewDomainName 

func NewDomainName(scope constructs.Construct, id *string, props *DomainNameProps) DomainName

Experimental.

type DomainNameAttributes 

type DomainNameAttributes struct {
	// domain name string.
	// Experimental.
	Name *string `json:"name" yaml:"name"`
	// The domain name associated with the regional endpoint for this custom domain name.
	// Experimental.
	RegionalDomainName *string `json:"regionalDomainName" yaml:"regionalDomainName"`
	// The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
	// Experimental.
	RegionalHostedZoneId *string `json:"regionalHostedZoneId" yaml:"regionalHostedZoneId"`
}

custom domain name attributes.

TODO: EXAMPLE

Experimental.

type DomainNameProps 

type DomainNameProps struct {
	// The ACM certificate for this domain name.
	//
	// Certificate can be both ACM issued or imported.
	// Experimental.
	Certificate awscertificatemanager.ICertificate `json:"certificate" yaml:"certificate"`
	// The user-friendly name of the certificate that will be used by the endpoint for this domain name.
	// Experimental.
	CertificateName *string `json:"certificateName" yaml:"certificateName"`
	// The type of endpoint for this DomainName.
	// Experimental.
	EndpointType EndpointType `json:"endpointType" yaml:"endpointType"`
	// A public certificate issued by ACM to validate that you own a custom domain.
	//
	// This parameter is required
	// only when you configure mutual TLS authentication and you specify an ACM imported or private CA certificate
	// for `certificate`. The ownership certificate validates that you have permissions to use the domain name.
	// Experimental.
	OwnershipCertificate awscertificatemanager.ICertificate `json:"ownershipCertificate" yaml:"ownershipCertificate"`
	// The Transport Layer Security (TLS) version + cipher suite for this domain name.
	// Experimental.
	SecurityPolicy SecurityPolicy `json:"securityPolicy" yaml:"securityPolicy"`
	// The custom domain name.
	// Experimental.
	DomainName *string `json:"domainName" yaml:"domainName"`
	// The mutual TLS authentication configuration for a custom domain name.
	// Experimental.
	Mtls *MTLSConfig `json:"mtls" yaml:"mtls"`
}

properties used for creating the DomainName.

TODO: EXAMPLE

Experimental.

type EndpointOptions 

type EndpointOptions struct {
	// The ACM certificate for this domain name.
	//
	// Certificate can be both ACM issued or imported.
	// Experimental.
	Certificate awscertificatemanager.ICertificate `json:"certificate" yaml:"certificate"`
	// The user-friendly name of the certificate that will be used by the endpoint for this domain name.
	// Experimental.
	CertificateName *string `json:"certificateName" yaml:"certificateName"`
	// The type of endpoint for this DomainName.
	// Experimental.
	EndpointType EndpointType `json:"endpointType" yaml:"endpointType"`
	// A public certificate issued by ACM to validate that you own a custom domain.
	//
	// This parameter is required
	// only when you configure mutual TLS authentication and you specify an ACM imported or private CA certificate
	// for `certificate`. The ownership certificate validates that you have permissions to use the domain name.
	// Experimental.
	OwnershipCertificate awscertificatemanager.ICertificate `json:"ownershipCertificate" yaml:"ownershipCertificate"`
	// The Transport Layer Security (TLS) version + cipher suite for this domain name.
	// Experimental.
	SecurityPolicy SecurityPolicy `json:"securityPolicy" yaml:"securityPolicy"`
}

properties for creating a domain name endpoint.

TODO: EXAMPLE

Experimental.

type EndpointType 

type EndpointType string

Endpoint type for a domain name. Experimental. 

const (
	EndpointType_EDGE     EndpointType = "EDGE"
	EndpointType_REGIONAL EndpointType = "REGIONAL"
)

type GrantInvokeOptions 

type GrantInvokeOptions struct {
	// The HTTP methods to allow.
	// Experimental.
	HttpMethods *[]HttpMethod `json:"httpMethods" yaml:"httpMethods"`
}

Options for granting invoke access.

TODO: EXAMPLE

Experimental.

type HttpApi 

type HttpApi interface {
	awscdk.Resource
	IApi
	IHttpApi
	ApiEndpoint() *string
	ApiId() *string
	DefaultStage() IHttpStage
	DisableExecuteApiEndpoint() *bool
	Env() *awscdk.ResourceEnvironment
	HttpApiId() *string
	HttpApiName() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	Url() *string
	AddRoutes(options *AddRoutesOptions) *[]HttpRoute
	AddStage(id *string, options *HttpStageOptions) HttpStage
	AddVpcLink(options *VpcLinkProps) VpcLink
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDataProcessed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Create a new API Gateway HTTP API endpoint.

TODO: EXAMPLE

Experimental.

func NewHttpApi 

func NewHttpApi(scope constructs.Construct, id *string, props *HttpApiProps) HttpApi

Experimental.

type HttpApiAttributes 

type HttpApiAttributes struct {
	// The identifier of the HttpApi.
	// Experimental.
	HttpApiId *string `json:"httpApiId" yaml:"httpApiId"`
	// The endpoint URL of the HttpApi.
	// Experimental.
	ApiEndpoint *string `json:"apiEndpoint" yaml:"apiEndpoint"`
}

Attributes for importing an HttpApi into the CDK.

TODO: EXAMPLE

Experimental.

type HttpApiProps 

type HttpApiProps struct {
	// Name for the HTTP API resource.
	// Experimental.
	ApiName *string `json:"apiName" yaml:"apiName"`
	// Specifies a CORS configuration for an API.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html
	//
	// Experimental.
	CorsPreflight *CorsPreflightOptions `json:"corsPreflight" yaml:"corsPreflight"`
	// Whether a default stage and deployment should be automatically created.
	// Experimental.
	CreateDefaultStage *bool `json:"createDefaultStage" yaml:"createDefaultStage"`
	// Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.
	// Experimental.
	DefaultAuthorizationScopes *[]*string `json:"defaultAuthorizationScopes" yaml:"defaultAuthorizationScopes"`
	// Default Authorizer to applied to all routes in the gateway.
	// Experimental.
	DefaultAuthorizer IHttpRouteAuthorizer `json:"defaultAuthorizer" yaml:"defaultAuthorizer"`
	// Configure a custom domain with the API mapping resource to the HTTP API.
	// Experimental.
	DefaultDomainMapping *DomainMappingOptions `json:"defaultDomainMapping" yaml:"defaultDomainMapping"`
	// An integration that will be configured on the catch-all route ($default).
	// Experimental.
	DefaultIntegration HttpRouteIntegration `json:"defaultIntegration" yaml:"defaultIntegration"`
	// The description of the API.
	// Experimental.
	Description *string `json:"description" yaml:"description"`
	// Specifies whether clients can invoke your API using the default endpoint.
	//
	// By default, clients can invoke your API with the default
	// `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. Enable
	// this if you would like clients to use your custom domain name.
	// Experimental.
	DisableExecuteApiEndpoint *bool `json:"disableExecuteApiEndpoint" yaml:"disableExecuteApiEndpoint"`
}

Properties to initialize an instance of `HttpApi`.

TODO: EXAMPLE

Experimental.

type HttpAuthorizer 

type HttpAuthorizer interface {
	awscdk.Resource
	IHttpAuthorizer
	AuthorizerId() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An authorizer for Http Apis.

TODO: EXAMPLE

Experimental.

func NewHttpAuthorizer 

func NewHttpAuthorizer(scope constructs.Construct, id *string, props *HttpAuthorizerProps) HttpAuthorizer

Experimental.

type HttpAuthorizerAttributes 

type HttpAuthorizerAttributes struct {
	// Id of the Authorizer.
	// Experimental.
	AuthorizerId *string `json:"authorizerId" yaml:"authorizerId"`
	// Type of authorizer.
	//
	// Possible values are:
	// - JWT - JSON Web Token Authorizer
	// - CUSTOM - Lambda Authorizer
	// - NONE - No Authorization
	// Experimental.
	AuthorizerType *string `json:"authorizerType" yaml:"authorizerType"`
}

Reference to an http authorizer.

TODO: EXAMPLE

Experimental.

type HttpAuthorizerProps 

type HttpAuthorizerProps struct {
	// HTTP Api to attach the authorizer to.
	// Experimental.
	HttpApi IHttpApi `json:"httpApi" yaml:"httpApi"`
	// The identity source for which authorization is requested.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource
	//
	// Experimental.
	IdentitySource *[]*string `json:"identitySource" yaml:"identitySource"`
	// The type of authorizer.
	// Experimental.
	Type HttpAuthorizerType `json:"type" yaml:"type"`
	// Name of the authorizer.
	// Experimental.
	AuthorizerName *string `json:"authorizerName" yaml:"authorizerName"`
	// The authorizer's Uniform Resource Identifier (URI).
	//
	// For REQUEST authorizers, this must be a well-formed Lambda function URI.
	// Experimental.
	AuthorizerUri *string `json:"authorizerUri" yaml:"authorizerUri"`
	// Specifies whether a Lambda authorizer returns a response in a simple format.
	//
	// If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy.
	// Experimental.
	EnableSimpleResponses *bool `json:"enableSimpleResponses" yaml:"enableSimpleResponses"`
	// 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.
	// Experimental.
	JwtAudience *[]*string `json:"jwtAudience" yaml:"jwtAudience"`
	// The base domain of the identity provider that issues JWT.
	// Experimental.
	JwtIssuer *string `json:"jwtIssuer" yaml:"jwtIssuer"`
	// Specifies the format of the payload sent to an HTTP API Lambda authorizer.
	// Experimental.
	PayloadFormatVersion AuthorizerPayloadVersion `json:"payloadFormatVersion" yaml:"payloadFormatVersion"`
	// How long APIGateway should cache the results.
	//
	// Max 1 hour.
	// Experimental.
	ResultsCacheTtl awscdk.Duration `json:"resultsCacheTtl" yaml:"resultsCacheTtl"`
}

Properties to initialize an instance of `HttpAuthorizer`.

TODO: EXAMPLE

Experimental.

type HttpAuthorizerType 

type HttpAuthorizerType string

Supported Authorizer types. Experimental. 

const (
	HttpAuthorizerType_IAM    HttpAuthorizerType = "IAM"
	HttpAuthorizerType_JWT    HttpAuthorizerType = "JWT"
	HttpAuthorizerType_LAMBDA HttpAuthorizerType = "LAMBDA"
)

type HttpConnectionType 

type HttpConnectionType string

Supported connection types. Experimental. 

const (
	HttpConnectionType_VPC_LINK HttpConnectionType = "VPC_LINK"
	HttpConnectionType_INTERNET HttpConnectionType = "INTERNET"
)

type HttpIntegration 

type HttpIntegration interface {
	awscdk.Resource
	IHttpIntegration
	Env() *awscdk.ResourceEnvironment
	HttpApi() IHttpApi
	IntegrationId() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

The integration for an API route.

TODO: EXAMPLE

Experimental.

func NewHttpIntegration 

func NewHttpIntegration(scope constructs.Construct, id *string, props *HttpIntegrationProps) HttpIntegration

Experimental.

type HttpIntegrationProps 

type HttpIntegrationProps struct {
	// The HTTP API to which this integration should be bound.
	// Experimental.
	HttpApi IHttpApi `json:"httpApi" yaml:"httpApi"`
	// Integration type.
	// Experimental.
	IntegrationType HttpIntegrationType `json:"integrationType" yaml:"integrationType"`
	// The ID of the VPC link for a private integration.
	//
	// Supported only for HTTP APIs.
	// Experimental.
	ConnectionId *string `json:"connectionId" yaml:"connectionId"`
	// The type of the network connection to the integration endpoint.
	// Experimental.
	ConnectionType HttpConnectionType `json:"connectionType" yaml:"connectionType"`
	// The credentials with which to invoke the integration.
	// Experimental.
	Credentials IntegrationCredentials `json:"credentials" yaml:"credentials"`
	// Integration subtype.
	//
	// Used for AWS Service integrations, specifies the target of the integration.
	// Experimental.
	IntegrationSubtype HttpIntegrationSubtype `json:"integrationSubtype" yaml:"integrationSubtype"`
	// Integration URI.
	//
	// This will be the function ARN in the case of `HttpIntegrationType.AWS_PROXY`,
	// or HTTP URL in the case of `HttpIntegrationType.HTTP_PROXY`.
	// Experimental.
	IntegrationUri *string `json:"integrationUri" yaml:"integrationUri"`
	// The HTTP method to use when calling the underlying HTTP proxy.
	// Experimental.
	Method HttpMethod `json:"method" yaml:"method"`
	// Specifies how to transform HTTP requests before sending them to the backend.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
	//
	// Experimental.
	ParameterMapping ParameterMapping `json:"parameterMapping" yaml:"parameterMapping"`
	// The version of the payload format.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
	//
	// Experimental.
	PayloadFormatVersion PayloadFormatVersion `json:"payloadFormatVersion" yaml:"payloadFormatVersion"`
	// Specifies the TLS configuration for a private integration.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html
	//
	// Experimental.
	SecureServerName *string `json:"secureServerName" yaml:"secureServerName"`
}

The integration properties.

TODO: EXAMPLE

Experimental.

type HttpIntegrationSubtype 

type HttpIntegrationSubtype string

Supported integration subtypes. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html

Experimental. 

const (
	HttpIntegrationSubtype_EVENTBRIDGE_PUT_EVENTS             HttpIntegrationSubtype = "EVENTBRIDGE_PUT_EVENTS"
	HttpIntegrationSubtype_SQS_SEND_MESSAGE                   HttpIntegrationSubtype = "SQS_SEND_MESSAGE"
	HttpIntegrationSubtype_SQS_RECEIVE_MESSAGE                HttpIntegrationSubtype = "SQS_RECEIVE_MESSAGE"
	HttpIntegrationSubtype_SQS_DELETE_MESSAGE                 HttpIntegrationSubtype = "SQS_DELETE_MESSAGE"
	HttpIntegrationSubtype_SQS_PURGE_QUEUE                    HttpIntegrationSubtype = "SQS_PURGE_QUEUE"
	HttpIntegrationSubtype_APPCONFIG_GET_CONFIGURATION        HttpIntegrationSubtype = "APPCONFIG_GET_CONFIGURATION"
	HttpIntegrationSubtype_KINESIS_PUT_RECORD                 HttpIntegrationSubtype = "KINESIS_PUT_RECORD"
	HttpIntegrationSubtype_STEPFUNCTIONS_START_EXECUTION      HttpIntegrationSubtype = "STEPFUNCTIONS_START_EXECUTION"
	HttpIntegrationSubtype_STEPFUNCTIONS_START_SYNC_EXECUTION HttpIntegrationSubtype = "STEPFUNCTIONS_START_SYNC_EXECUTION"
	HttpIntegrationSubtype_STEPFUNCTIONS_STOP_EXECUTION       HttpIntegrationSubtype = "STEPFUNCTIONS_STOP_EXECUTION"
)

type HttpIntegrationType 

type HttpIntegrationType string

Supported integration types. Experimental. 

const (
	HttpIntegrationType_HTTP_PROXY HttpIntegrationType = "HTTP_PROXY"
	HttpIntegrationType_AWS_PROXY  HttpIntegrationType = "AWS_PROXY"
)

type HttpMethod 

type HttpMethod string

Supported HTTP methods.

TODO: EXAMPLE

Experimental. 

const (
	HttpMethod_ANY     HttpMethod = "ANY"
	HttpMethod_DELETE  HttpMethod = "DELETE"
	HttpMethod_GET     HttpMethod = "GET"
	HttpMethod_HEAD    HttpMethod = "HEAD"
	HttpMethod_OPTIONS HttpMethod = "OPTIONS"
	HttpMethod_PATCH   HttpMethod = "PATCH"
	HttpMethod_POST    HttpMethod = "POST"
	HttpMethod_PUT     HttpMethod = "PUT"
)

type HttpNoneAuthorizer 

type HttpNoneAuthorizer interface {
	IHttpRouteAuthorizer
	Bind(_arg *HttpRouteAuthorizerBindOptions) *HttpRouteAuthorizerConfig
}

Explicitly configure no authorizers on specific HTTP API routes.

TODO: EXAMPLE

Experimental.

func NewHttpNoneAuthorizer 

func NewHttpNoneAuthorizer() HttpNoneAuthorizer

Experimental.

type HttpRoute 

type HttpRoute interface {
	awscdk.Resource
	IHttpRoute
	Env() *awscdk.ResourceEnvironment
	HttpApi() IHttpApi
	Node() awscdk.ConstructNode
	Path() *string
	PhysicalName() *string
	RouteArn() *string
	RouteId() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantInvoke(grantee awsiam.IGrantable, options *GrantInvokeOptions) awsiam.Grant
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Route class that creates the Route for API Gateway HTTP API.

TODO: EXAMPLE

Experimental.

func NewHttpRoute 

func NewHttpRoute(scope constructs.Construct, id *string, props *HttpRouteProps) HttpRoute

Experimental.

type HttpRouteAuthorizerBindOptions 

type HttpRouteAuthorizerBindOptions struct {
	// The route to which the authorizer is being bound.
	// Experimental.
	Route IHttpRoute `json:"route" yaml:"route"`
	// The scope for any constructs created as part of the bind.
	// Experimental.
	Scope constructs.Construct `json:"scope" yaml:"scope"`
}

Input to the bind() operation, that binds an authorizer to a route.

TODO: EXAMPLE

Experimental.

type HttpRouteAuthorizerConfig 

type HttpRouteAuthorizerConfig struct {
	// The type of authorization.
	//
	// Possible values are:
	// - AWS_IAM - IAM Authorizer
	// - JWT - JSON Web Token Authorizer
	// - CUSTOM - Lambda Authorizer
	// - NONE - No Authorization
	// Experimental.
	AuthorizationType *string `json:"authorizationType" yaml:"authorizationType"`
	// The list of OIDC scopes to include in the authorization.
	// Experimental.
	AuthorizationScopes *[]*string `json:"authorizationScopes" yaml:"authorizationScopes"`
	// The authorizer id.
	// Experimental.
	AuthorizerId *string `json:"authorizerId" yaml:"authorizerId"`
}

Results of binding an authorizer to an http route.

TODO: EXAMPLE

Experimental.

type HttpRouteIntegration 

type HttpRouteIntegration interface {
	Bind(options *HttpRouteIntegrationBindOptions) *HttpRouteIntegrationConfig
	CompleteBind(_options *HttpRouteIntegrationBindOptions)
}

The interface that various route integration classes will inherit.

TODO: EXAMPLE

Experimental.

type HttpRouteIntegrationBindOptions 

type HttpRouteIntegrationBindOptions struct {
	// The route to which this is being bound.
	// Experimental.
	Route IHttpRoute `json:"route" yaml:"route"`
	// The current scope in which the bind is occurring.
	//
	// If the `HttpRouteIntegration` being bound creates additional constructs,
	// this will be used as their parent scope.
	// Experimental.
	Scope awscdk.Construct `json:"scope" yaml:"scope"`
}

Options to the HttpRouteIntegration during its bind operation.

TODO: EXAMPLE

Experimental.

type HttpRouteIntegrationConfig 

type HttpRouteIntegrationConfig struct {
	// Payload format version in the case of lambda proxy integration.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
	//
	// Experimental.
	PayloadFormatVersion PayloadFormatVersion `json:"payloadFormatVersion" yaml:"payloadFormatVersion"`
	// Integration type.
	// Experimental.
	Type HttpIntegrationType `json:"type" yaml:"type"`
	// The ID of the VPC link for a private integration.
	//
	// Supported only for HTTP APIs.
	// Experimental.
	ConnectionId *string `json:"connectionId" yaml:"connectionId"`
	// The type of the network connection to the integration endpoint.
	// Experimental.
	ConnectionType HttpConnectionType `json:"connectionType" yaml:"connectionType"`
	// The credentials with which to invoke the integration.
	// Experimental.
	Credentials IntegrationCredentials `json:"credentials" yaml:"credentials"`
	// The HTTP method that must be used to invoke the underlying proxy.
	//
	// Required for `HttpIntegrationType.HTTP_PROXY`
	// Experimental.
	Method HttpMethod `json:"method" yaml:"method"`
	// Specifies how to transform HTTP requests before sending them to the backend.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
	//
	// Experimental.
	ParameterMapping ParameterMapping `json:"parameterMapping" yaml:"parameterMapping"`
	// Specifies the server name to verified by HTTPS when calling the backend integration.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html
	//
	// Experimental.
	SecureServerName *string `json:"secureServerName" yaml:"secureServerName"`
	// Integration subtype.
	// Experimental.
	Subtype HttpIntegrationSubtype `json:"subtype" yaml:"subtype"`
	// Integration URI.
	// Experimental.
	Uri *string `json:"uri" yaml:"uri"`
}

Config returned back as a result of the bind.

TODO: EXAMPLE

Experimental.

type HttpRouteKey 

type HttpRouteKey interface {
	Key() *string
	Method() HttpMethod
	Path() *string
}

HTTP route in APIGateway is a combination of the HTTP method and the path component.

This class models that combination.

TODO: EXAMPLE

Experimental.

func HttpRouteKey_DEFAULT 

func HttpRouteKey_DEFAULT() HttpRouteKey

func HttpRouteKey_With 

func HttpRouteKey_With(path *string, method HttpMethod) HttpRouteKey

Create a route key with the combination of the path and the method. Experimental.

type HttpRouteProps 

type HttpRouteProps struct {
	// The integration to be configured on this route.
	// Experimental.
	Integration HttpRouteIntegration `json:"integration" yaml:"integration"`
	// the API the route is associated with.
	// Experimental.
	HttpApi IHttpApi `json:"httpApi" yaml:"httpApi"`
	// The key to this route.
	//
	// This is a combination of an HTTP method and an HTTP path.
	// Experimental.
	RouteKey HttpRouteKey `json:"routeKey" yaml:"routeKey"`
	// The list of OIDC scopes to include in the authorization.
	//
	// These scopes will be merged with the scopes from the attached authorizer
	// Experimental.
	AuthorizationScopes *[]*string `json:"authorizationScopes" yaml:"authorizationScopes"`
	// Authorizer for a WebSocket API or an HTTP API.
	// Experimental.
	Authorizer IHttpRouteAuthorizer `json:"authorizer" yaml:"authorizer"`
}

Properties to initialize a new Route.

TODO: EXAMPLE

Experimental.

type HttpStage 

type HttpStage interface {
	awscdk.Resource
	IHttpStage
	IStage
	Api() IHttpApi
	BaseApi() IApi
	DomainUrl() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	StageName() *string
	Url() *string
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricDataProcessed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Represents a stage where an instance of the API is deployed.

TODO: EXAMPLE

Experimental.

func NewHttpStage 

func NewHttpStage(scope constructs.Construct, id *string, props *HttpStageProps) HttpStage

Experimental.

type HttpStageAttributes 

type HttpStageAttributes struct {
	// The name of the stage.
	// Experimental.
	StageName *string `json:"stageName" yaml:"stageName"`
	// The API to which this stage is associated.
	// Experimental.
	Api IHttpApi `json:"api" yaml:"api"`
}

The attributes used to import existing HttpStage.

TODO: EXAMPLE

Experimental.

type HttpStageOptions 

type HttpStageOptions struct {
	// Whether updates to an API automatically trigger a new deployment.
	// Experimental.
	AutoDeploy *bool `json:"autoDeploy" yaml:"autoDeploy"`
	// The options for custom domain and api mapping.
	// Experimental.
	DomainMapping *DomainMappingOptions `json:"domainMapping" yaml:"domainMapping"`
	// The name of the stage.
	//
	// See `StageName` class for more details.
	// Experimental.
	StageName *string `json:"stageName" yaml:"stageName"`
}

The options to create a new Stage for an HTTP API.

TODO: EXAMPLE

Experimental.

type HttpStageProps 

type HttpStageProps struct {
	// Whether updates to an API automatically trigger a new deployment.
	// Experimental.
	AutoDeploy *bool `json:"autoDeploy" yaml:"autoDeploy"`
	// The options for custom domain and api mapping.
	// Experimental.
	DomainMapping *DomainMappingOptions `json:"domainMapping" yaml:"domainMapping"`
	// The name of the stage.
	//
	// See `StageName` class for more details.
	// Experimental.
	StageName *string `json:"stageName" yaml:"stageName"`
	// The HTTP API to which this stage is associated.
	// Experimental.
	HttpApi IHttpApi `json:"httpApi" yaml:"httpApi"`
}

Properties to initialize an instance of `HttpStage`.

TODO: EXAMPLE

Experimental.

type IApi 

type IApi interface {
	awscdk.IResource
	// Return the given named metric for this Api Gateway.
	// Experimental.
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The default endpoint for an API.
	// Experimental.
	ApiEndpoint() *string
	// The identifier of this API Gateway API.
	// Experimental.
	ApiId() *string
}

Represents a API Gateway HTTP/WebSocket API. Experimental.

type IApiMapping 

type IApiMapping interface {
	awscdk.IResource
	// ID of the api mapping.
	// Experimental.
	ApiMappingId() *string
}

Represents an ApiGatewayV2 ApiMapping resource. See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

Experimental.

func ApiMapping_FromApiMappingAttributes 

func ApiMapping_FromApiMappingAttributes(scope constructs.Construct, id *string, attrs *ApiMappingAttributes) IApiMapping

import from API ID. Experimental.

type IAuthorizer 

type IAuthorizer interface {
	awscdk.IResource
	// Id of the Authorizer.
	// Experimental.
	AuthorizerId() *string
}

Represents an Authorizer. Experimental.

type IDomainName 

type IDomainName interface {
	awscdk.IResource
	// The custom domain name.
	// Experimental.
	Name() *string
	// The domain name associated with the regional endpoint for this custom domain name.
	// Experimental.
	RegionalDomainName() *string
	// The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
	// Experimental.
	RegionalHostedZoneId() *string
}

Represents an APIGatewayV2 DomainName. See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

Experimental.

func DomainName_FromDomainNameAttributes 

func DomainName_FromDomainNameAttributes(scope constructs.Construct, id *string, attrs *DomainNameAttributes) IDomainName

Import from attributes. Experimental.

type IHttpApi 

type IHttpApi interface {
	IApi
	// Add a new VpcLink.
	// Experimental.
	AddVpcLink(options *VpcLinkProps) VpcLink
	// Metric for the number of client-side errors captured in a given period.
	// Experimental.
	MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the total number API requests in a given period.
	// Experimental.
	MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the amount of data processed in bytes.
	// Experimental.
	MetricDataProcessed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
	// Experimental.
	MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The time between when API Gateway receives a request from a client and when it returns a response to the client.
	//
	// The latency includes the integration latency and other API Gateway overhead.
	// Experimental.
	MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the number of server-side errors captured in a given period.
	// Experimental.
	MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The identifier of this API Gateway HTTP API.
	// Deprecated: - use apiId instead
	HttpApiId() *string
}

Represents an HTTP API. Experimental.

func HttpApi_FromHttpApiAttributes 

func HttpApi_FromHttpApiAttributes(scope constructs.Construct, id *string, attrs *HttpApiAttributes) IHttpApi

Import an existing HTTP API into this CDK app. Experimental.

type IHttpAuthorizer 

type IHttpAuthorizer interface {
	IAuthorizer
}

An authorizer for HTTP APIs. Experimental.

type IHttpIntegration 

type IHttpIntegration interface {
	IIntegration
	// The HTTP API associated with this integration.
	// Experimental.
	HttpApi() IHttpApi
}

Represents an Integration for an HTTP API. Experimental.

type IHttpRoute 

type IHttpRoute interface {
	IRoute
	// Grant access to invoke the route.
	//
	// This method requires that the authorizer of the route is undefined or is
	// an `HttpIamAuthorizer`.
	// Experimental.
	GrantInvoke(grantee awsiam.IGrantable, options *GrantInvokeOptions) awsiam.Grant
	// The HTTP API associated with this route.
	// Experimental.
	HttpApi() IHttpApi
	// Returns the path component of this HTTP route, `undefined` if the path is the catch-all route.
	// Experimental.
	Path() *string
	// Returns the arn of the route.
	// Experimental.
	RouteArn() *string
}

Represents a Route for an HTTP API. Experimental.

type IHttpRouteAuthorizer 

type IHttpRouteAuthorizer interface {
	// Bind this authorizer to a specified Http route.
	// Experimental.
	Bind(options *HttpRouteAuthorizerBindOptions) *HttpRouteAuthorizerConfig
}

An authorizer that can attach to an Http Route. Experimental.

func HttpAuthorizer_FromHttpAuthorizerAttributes 

func HttpAuthorizer_FromHttpAuthorizerAttributes(scope constructs.Construct, id *string, attrs *HttpAuthorizerAttributes) IHttpRouteAuthorizer

Import an existing HTTP Authorizer into this CDK app. Experimental.

type IHttpStage 

type IHttpStage interface {
	IStage
	// Metric for the number of client-side errors captured in a given period.
	// Experimental.
	MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the total number API requests in a given period.
	// Experimental.
	MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the amount of data processed in bytes.
	// Experimental.
	MetricDataProcessed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
	// Experimental.
	MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The time between when API Gateway receives a request from a client and when it returns a response to the client.
	//
	// The latency includes the integration latency and other API Gateway overhead.
	// Experimental.
	MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the number of server-side errors captured in a given period.
	// Experimental.
	MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The API this stage is associated to.
	// Experimental.
	Api() IHttpApi
	// The custom domain URL to this stage.
	// Experimental.
	DomainUrl() *string
}

Represents the HttpStage. Experimental.

func HttpStage_FromHttpStageAttributes 

func HttpStage_FromHttpStageAttributes(scope constructs.Construct, id *string, attrs *HttpStageAttributes) IHttpStage

Import an existing stage into this CDK app. Experimental.

type IIntegration 

type IIntegration interface {
	awscdk.IResource
	// Id of the integration.
	// Experimental.
	IntegrationId() *string
}

Represents an integration to an API Route. Experimental.

type IMappingValue 

type IMappingValue interface {
	// Represents a Mapping Value.
	// Experimental.
	Value() *string
}

Represents a Mapping Value. Experimental.

type IRoute 

type IRoute interface {
	awscdk.IResource
	// Id of the Route.
	// Experimental.
	RouteId() *string
}

Represents a route. Experimental.

type IStage 

type IStage interface {
	awscdk.IResource
	// Return the given named metric for this HTTP Api Gateway Stage.
	// Experimental.
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The name of the stage;
	//
	// its primary identifier.
	// Experimental.
	StageName() *string
	// The URL to this stage.
	// Experimental.
	Url() *string
}

Represents a Stage. Experimental. 

type IVpcLink interface {
	awscdk.IResource
	// The VPC to which this VPC Link is associated with.
	// Experimental.
	Vpc() awsec2.IVpc
	// Physical ID of the VpcLink resource.
	// Experimental.
	VpcLinkId() *string
}

Represents an API Gateway VpcLink. Experimental. 

func VpcLink_FromVpcLinkAttributes(scope constructs.Construct, id *string, attrs *VpcLinkAttributes) IVpcLink

Import a VPC Link by specifying its attributes. Experimental.

type IWebSocketApi 

type IWebSocketApi interface {
	IApi
}

Represents a WebSocket API. Experimental.

func WebSocketApi_FromWebSocketApiAttributes 

func WebSocketApi_FromWebSocketApiAttributes(scope constructs.Construct, id *string, attrs *WebSocketApiAttributes) IWebSocketApi

Import an existing WebSocket API into this CDK app. Experimental.

type IWebSocketAuthorizer 

type IWebSocketAuthorizer interface {
	IAuthorizer
}

An authorizer for WebSocket APIs. Experimental.

type IWebSocketIntegration 

type IWebSocketIntegration interface {
	IIntegration
	// The WebSocket API associated with this integration.
	// Experimental.
	WebSocketApi() IWebSocketApi
}

Represents an Integration for an WebSocket API. Experimental.

type IWebSocketRoute 

type IWebSocketRoute interface {
	IRoute
	// The key to this route.
	// Experimental.
	RouteKey() *string
	// The WebSocket API associated with this route.
	// Experimental.
	WebSocketApi() IWebSocketApi
}

Represents a Route for an WebSocket API. Experimental.

type IWebSocketRouteAuthorizer 

type IWebSocketRouteAuthorizer interface {
	// Bind this authorizer to a specified WebSocket route.
	// Experimental.
	Bind(options *WebSocketRouteAuthorizerBindOptions) *WebSocketRouteAuthorizerConfig
}

An authorizer that can attach to an WebSocket Route. Experimental.

func WebSocketAuthorizer_FromWebSocketAuthorizerAttributes 

func WebSocketAuthorizer_FromWebSocketAuthorizerAttributes(scope constructs.Construct, id *string, attrs *WebSocketAuthorizerAttributes) IWebSocketRouteAuthorizer

Import an existing WebSocket Authorizer into this CDK app. Experimental.

type IWebSocketStage 

type IWebSocketStage interface {
	IStage
	// The API this stage is associated to.
	// Experimental.
	Api() IWebSocketApi
	// The callback URL to this stage.
	//
	// You can use the callback URL to send messages to the client from the backend system.
	// https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html
	// https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html
	// Experimental.
	CallbackUrl() *string
}

Represents the WebSocketStage. Experimental.

func WebSocketStage_FromWebSocketStageAttributes 

func WebSocketStage_FromWebSocketStageAttributes(scope constructs.Construct, id *string, attrs *WebSocketStageAttributes) IWebSocketStage

Import an existing stage into this CDK app. Experimental.

type IntegrationCredentials 

type IntegrationCredentials interface {
	CredentialsArn() *string
}

Credentials used for AWS Service integrations.

TODO: EXAMPLE

Experimental.

func IntegrationCredentials_FromRole 

func IntegrationCredentials_FromRole(role awsiam.IRole) IntegrationCredentials

Use the specified role for integration requests. Experimental.

func IntegrationCredentials_UseCallerIdentity 

func IntegrationCredentials_UseCallerIdentity() IntegrationCredentials

Use the calling user's identity to call the integration. Experimental.

type MTLSConfig 

type MTLSConfig struct {
	// The bucket that the trust store is hosted in.
	// Experimental.
	Bucket awss3.IBucket `json:"bucket" yaml:"bucket"`
	// The key in S3 to look at for the trust store.
	// Experimental.
	Key *string `json:"key" yaml:"key"`
	// The version of the S3 object that contains your truststore.
	//
	// To specify a version, you must have versioning enabled for the S3 bucket.
	// Experimental.
	Version *string `json:"version" yaml:"version"`
}

The mTLS authentication configuration for a custom domain name.

TODO: EXAMPLE

Experimental.

type MappingValue 

type MappingValue interface {
	IMappingValue
	Value() *string
}

Represents a Mapping Value.

TODO: EXAMPLE

Experimental.

func MappingValue_ContextVariable 

func MappingValue_ContextVariable(variableName *string) MappingValue

Creates a context variable mapping value. Experimental.

func MappingValue_Custom 

func MappingValue_Custom(value *string) MappingValue

Creates a custom mapping value. Experimental.

func MappingValue_NONE 

func MappingValue_NONE() MappingValue

func MappingValue_RequestBody 

func MappingValue_RequestBody(name *string) MappingValue

Creates a request body mapping value. Experimental.

func MappingValue_RequestHeader 

func MappingValue_RequestHeader(name *string) MappingValue

Creates a header mapping value. Experimental.

func MappingValue_RequestPath 

func MappingValue_RequestPath() MappingValue

Creates a request path mapping value. Experimental.

func MappingValue_RequestPathParam 

func MappingValue_RequestPathParam(name *string) MappingValue

Creates a request path parameter mapping value. Experimental.

func MappingValue_RequestQueryString 

func MappingValue_RequestQueryString(name *string) MappingValue

Creates a query string mapping value. Experimental.

func MappingValue_StageVariable 

func MappingValue_StageVariable(variableName *string) MappingValue

Creates a stage variable mapping value. Experimental.

func NewMappingValue 

func NewMappingValue(value *string) MappingValue

Experimental.

type ParameterMapping 

type ParameterMapping interface {
	Mappings() *map[string]*string
	AppendHeader(name *string, value MappingValue) ParameterMapping
	AppendQueryString(name *string, value MappingValue) ParameterMapping
	Custom(key *string, value *string) ParameterMapping
	OverwriteHeader(name *string, value MappingValue) ParameterMapping
	OverwritePath(value MappingValue) ParameterMapping
	OverwriteQueryString(name *string, value MappingValue) ParameterMapping
	RemoveHeader(name *string) ParameterMapping
	RemoveQueryString(name *string) ParameterMapping
}

Represents a Parameter Mapping.

TODO: EXAMPLE

Experimental.

func NewParameterMapping 

func NewParameterMapping() ParameterMapping

Experimental.

func ParameterMapping_FromObject 

func ParameterMapping_FromObject(obj *map[string]MappingValue) ParameterMapping

Creates a mapping from an object. Experimental.

type PayloadFormatVersion 

type PayloadFormatVersion interface {
	Version() *string
}

Payload format version for lambda proxy integration.

TODO: EXAMPLE

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html

Experimental.

func PayloadFormatVersion_Custom 

func PayloadFormatVersion_Custom(version *string) PayloadFormatVersion

A custom payload version.

Typically used if there is a version number that the CDK doesn't support yet Experimental.

func PayloadFormatVersion_VERSION_1_0 

func PayloadFormatVersion_VERSION_1_0() PayloadFormatVersion

func PayloadFormatVersion_VERSION_2_0 

func PayloadFormatVersion_VERSION_2_0() PayloadFormatVersion

type SecurityPolicy 

type SecurityPolicy string

The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections. Experimental. 

const (
	SecurityPolicy_TLS_1_0 SecurityPolicy = "TLS_1_0"
	SecurityPolicy_TLS_1_2 SecurityPolicy = "TLS_1_2"
)

type StageAttributes 

type StageAttributes struct {
	// The name of the stage.
	// Experimental.
	StageName *string `json:"stageName" yaml:"stageName"`
}

The attributes used to import existing Stage.

TODO: EXAMPLE

Experimental.

type StageOptions 

type StageOptions struct {
	// Whether updates to an API automatically trigger a new deployment.
	// Experimental.
	AutoDeploy *bool `json:"autoDeploy" yaml:"autoDeploy"`
	// The options for custom domain and api mapping.
	// Experimental.
	DomainMapping *DomainMappingOptions `json:"domainMapping" yaml:"domainMapping"`
}

Options required to create a new stage.

Options that are common between HTTP and Websocket APIs.

TODO: EXAMPLE

Experimental. 

type VpcLink interface {
	awscdk.Resource
	IVpcLink
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	Vpc() awsec2.IVpc
	VpcLinkId() *string
	AddSecurityGroups(groups ...awsec2.ISecurityGroup)
	AddSubnets(subnets ...awsec2.ISubnet)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Define a new VPC Link Specifies an API Gateway VPC link for a HTTP API to access resources in an Amazon Virtual Private Cloud (VPC).

TODO: EXAMPLE

Experimental. 

func NewVpcLink(scope constructs.Construct, id *string, props *VpcLinkProps) VpcLink

Experimental.

type VpcLinkAttributes 

type VpcLinkAttributes struct {
	// The VPC to which this VPC link is associated with.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"`
	// The VPC Link id.
	// Experimental.
	VpcLinkId *string `json:"vpcLinkId" yaml:"vpcLinkId"`
}

Attributes when importing a new VpcLink.

TODO: EXAMPLE

Experimental.

type VpcLinkProps 

type VpcLinkProps struct {
	// The VPC in which the private resources reside.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"`
	// A list of security groups for the VPC link.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups" yaml:"securityGroups"`
	// A list of subnets for the VPC link.
	// Experimental.
	Subnets *awsec2.SubnetSelection `json:"subnets" yaml:"subnets"`
	// The name used to label and identify the VPC link.
	// Experimental.
	VpcLinkName *string `json:"vpcLinkName" yaml:"vpcLinkName"`
}

Properties for a VpcLink.

TODO: EXAMPLE

Experimental.

type WebSocketApi 

type WebSocketApi interface {
	awscdk.Resource
	IApi
	IWebSocketApi
	ApiEndpoint() *string
	ApiId() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	WebSocketApiName() *string
	AddRoute(routeKey *string, options *WebSocketRouteOptions) WebSocketRoute
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantManageConnections(identity awsiam.IGrantable) awsiam.Grant
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Create a new API Gateway WebSocket API endpoint.

TODO: EXAMPLE

Experimental.

func NewWebSocketApi 

func NewWebSocketApi(scope constructs.Construct, id *string, props *WebSocketApiProps) WebSocketApi

Experimental.

type WebSocketApiAttributes 

type WebSocketApiAttributes struct {
	// The identifier of the WebSocketApi.
	// Experimental.
	WebSocketId *string `json:"webSocketId" yaml:"webSocketId"`
	// The endpoint URL of the WebSocketApi.
	// Experimental.
	ApiEndpoint *string `json:"apiEndpoint" yaml:"apiEndpoint"`
}

Attributes for importing a WebSocketApi into the CDK.

TODO: EXAMPLE

Experimental.

type WebSocketApiKeySelectionExpression 

type WebSocketApiKeySelectionExpression interface {
	CustomApiKeySelector() *string
}

Represents the currently available API Key Selection Expressions.

TODO: EXAMPLE

Experimental.

func NewWebSocketApiKeySelectionExpression 

func NewWebSocketApiKeySelectionExpression(customApiKeySelector *string) WebSocketApiKeySelectionExpression

Experimental.

func WebSocketApiKeySelectionExpression_AUTHORIZER_USAGE_IDENTIFIER_KEY 

func WebSocketApiKeySelectionExpression_AUTHORIZER_USAGE_IDENTIFIER_KEY() WebSocketApiKeySelectionExpression

func WebSocketApiKeySelectionExpression_HEADER_X_API_KEY 

func WebSocketApiKeySelectionExpression_HEADER_X_API_KEY() WebSocketApiKeySelectionExpression

type WebSocketApiProps 

type WebSocketApiProps struct {
	// An API key selection expression.
	//
	// Providing this option will require an API Key be provided to access the API.
	// Experimental.
	ApiKeySelectionExpression WebSocketApiKeySelectionExpression `json:"apiKeySelectionExpression" yaml:"apiKeySelectionExpression"`
	// Name for the WebSocket API resource.
	// Experimental.
	ApiName *string `json:"apiName" yaml:"apiName"`
	// Options to configure a '$connect' route.
	// Experimental.
	ConnectRouteOptions *WebSocketRouteOptions `json:"connectRouteOptions" yaml:"connectRouteOptions"`
	// Options to configure a '$default' route.
	// Experimental.
	DefaultRouteOptions *WebSocketRouteOptions `json:"defaultRouteOptions" yaml:"defaultRouteOptions"`
	// The description of the API.
	// Experimental.
	Description *string `json:"description" yaml:"description"`
	// Options to configure a '$disconnect' route.
	// Experimental.
	DisconnectRouteOptions *WebSocketRouteOptions `json:"disconnectRouteOptions" yaml:"disconnectRouteOptions"`
	// The route selection expression for the API.
	// Experimental.
	RouteSelectionExpression *string `json:"routeSelectionExpression" yaml:"routeSelectionExpression"`
}

Props for WebSocket API.

TODO: EXAMPLE

Experimental.

type WebSocketAuthorizer 

type WebSocketAuthorizer interface {
	awscdk.Resource
	IWebSocketAuthorizer
	AuthorizerId() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An authorizer for WebSocket Apis.

TODO: EXAMPLE

Experimental.

func NewWebSocketAuthorizer 

func NewWebSocketAuthorizer(scope constructs.Construct, id *string, props *WebSocketAuthorizerProps) WebSocketAuthorizer

Experimental.

type WebSocketAuthorizerAttributes 

type WebSocketAuthorizerAttributes struct {
	// Id of the Authorizer.
	// Experimental.
	AuthorizerId *string `json:"authorizerId" yaml:"authorizerId"`
	// Type of authorizer.
	//
	// Possible values are:
	// - CUSTOM - Lambda Authorizer
	// - NONE - No Authorization
	// Experimental.
	AuthorizerType *string `json:"authorizerType" yaml:"authorizerType"`
}

Reference to an WebSocket authorizer.

TODO: EXAMPLE

Experimental.

type WebSocketAuthorizerProps 

type WebSocketAuthorizerProps struct {
	// The identity source for which authorization is requested.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource
	//
	// Experimental.
	IdentitySource *[]*string `json:"identitySource" yaml:"identitySource"`
	// The type of authorizer.
	// Experimental.
	Type WebSocketAuthorizerType `json:"type" yaml:"type"`
	// WebSocket Api to attach the authorizer to.
	// Experimental.
	WebSocketApi IWebSocketApi `json:"webSocketApi" yaml:"webSocketApi"`
	// Name of the authorizer.
	// Experimental.
	AuthorizerName *string `json:"authorizerName" yaml:"authorizerName"`
	// The authorizer's Uniform Resource Identifier (URI).
	//
	// For REQUEST authorizers, this must be a well-formed Lambda function URI.
	// Experimental.
	AuthorizerUri *string `json:"authorizerUri" yaml:"authorizerUri"`
}

Properties to initialize an instance of `WebSocketAuthorizer`.

TODO: EXAMPLE

Experimental.

type WebSocketAuthorizerType 

type WebSocketAuthorizerType string

Supported Authorizer types. Experimental. 

const (
	WebSocketAuthorizerType_LAMBDA WebSocketAuthorizerType = "LAMBDA"
)

type WebSocketIntegration 

type WebSocketIntegration interface {
	awscdk.Resource
	IWebSocketIntegration
	Env() *awscdk.ResourceEnvironment
	IntegrationId() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	WebSocketApi() IWebSocketApi
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

The integration for an API route.

TODO: EXAMPLE

Experimental.

func NewWebSocketIntegration 

func NewWebSocketIntegration(scope constructs.Construct, id *string, props *WebSocketIntegrationProps) WebSocketIntegration

Experimental.

type WebSocketIntegrationProps 

type WebSocketIntegrationProps struct {
	// Integration type.
	// Experimental.
	IntegrationType WebSocketIntegrationType `json:"integrationType" yaml:"integrationType"`
	// Integration URI.
	// Experimental.
	IntegrationUri *string `json:"integrationUri" yaml:"integrationUri"`
	// The WebSocket API to which this integration should be bound.
	// Experimental.
	WebSocketApi IWebSocketApi `json:"webSocketApi" yaml:"webSocketApi"`
}

The integration properties.

TODO: EXAMPLE

Experimental.

type WebSocketIntegrationType 

type WebSocketIntegrationType string

WebSocket Integration Types. Experimental. 

const (
	WebSocketIntegrationType_AWS_PROXY WebSocketIntegrationType = "AWS_PROXY"
	WebSocketIntegrationType_MOCK      WebSocketIntegrationType = "MOCK"
)

type WebSocketNoneAuthorizer 

type WebSocketNoneAuthorizer interface {
	IWebSocketRouteAuthorizer
	Bind(_arg *WebSocketRouteAuthorizerBindOptions) *WebSocketRouteAuthorizerConfig
}

Explicitly configure no authorizers on specific WebSocket API routes.

TODO: EXAMPLE

Experimental.

func NewWebSocketNoneAuthorizer 

func NewWebSocketNoneAuthorizer() WebSocketNoneAuthorizer

Experimental.

type WebSocketRoute 

type WebSocketRoute interface {
	awscdk.Resource
	IWebSocketRoute
	Env() *awscdk.ResourceEnvironment
	IntegrationResponseId() *string
	Node() awscdk.ConstructNode
	PhysicalName() *string
	RouteId() *string
	RouteKey() *string
	Stack() awscdk.Stack
	WebSocketApi() IWebSocketApi
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Route class that creates the Route for API Gateway WebSocket API.

TODO: EXAMPLE

Experimental.

func NewWebSocketRoute 

func NewWebSocketRoute(scope constructs.Construct, id *string, props *WebSocketRouteProps) WebSocketRoute

Experimental.

type WebSocketRouteAuthorizerBindOptions 

type WebSocketRouteAuthorizerBindOptions struct {
	// The route to which the authorizer is being bound.
	// Experimental.
	Route IWebSocketRoute `json:"route" yaml:"route"`
	// The scope for any constructs created as part of the bind.
	// Experimental.
	Scope constructs.Construct `json:"scope" yaml:"scope"`
}

Input to the bind() operation, that binds an authorizer to a route.

TODO: EXAMPLE

Experimental.

type WebSocketRouteAuthorizerConfig 

type WebSocketRouteAuthorizerConfig struct {
	// The type of authorization.
	//
	// Possible values are:
	// - CUSTOM - Lambda Authorizer
	// - NONE - No Authorization
	// Experimental.
	AuthorizationType *string `json:"authorizationType" yaml:"authorizationType"`
	// The authorizer id.
	// Experimental.
	AuthorizerId *string `json:"authorizerId" yaml:"authorizerId"`
}

Results of binding an authorizer to an WebSocket route.

TODO: EXAMPLE

Experimental.

type WebSocketRouteIntegration 

type WebSocketRouteIntegration interface {
	Bind(options *WebSocketRouteIntegrationBindOptions) *WebSocketRouteIntegrationConfig
}

The interface that various route integration classes will inherit.

TODO: EXAMPLE

Experimental.

type WebSocketRouteIntegrationBindOptions 

type WebSocketRouteIntegrationBindOptions struct {
	// The route to which this is being bound.
	// Experimental.
	Route IWebSocketRoute `json:"route" yaml:"route"`
	// The current scope in which the bind is occurring.
	//
	// If the `WebSocketRouteIntegration` being bound creates additional constructs,
	// this will be used as their parent scope.
	// Experimental.
	Scope awscdk.Construct `json:"scope" yaml:"scope"`
}

Options to the WebSocketRouteIntegration during its bind operation.

TODO: EXAMPLE

Experimental.

type WebSocketRouteIntegrationConfig 

type WebSocketRouteIntegrationConfig struct {
	// Integration type.
	// Experimental.
	Type WebSocketIntegrationType `json:"type" yaml:"type"`
	// Integration URI.
	// Experimental.
	Uri *string `json:"uri" yaml:"uri"`
}

Config returned back as a result of the bind.

TODO: EXAMPLE

Experimental.

type WebSocketRouteOptions 

type WebSocketRouteOptions struct {
	// The integration to be configured on this route.
	// Experimental.
	Integration WebSocketRouteIntegration `json:"integration" yaml:"integration"`
	// The authorize to this route.
	//
	// You can only set authorizer to a $connect route.
	// Experimental.
	Authorizer IWebSocketRouteAuthorizer `json:"authorizer" yaml:"authorizer"`
}

Options used to add route to the API.

TODO: EXAMPLE

Experimental.

type WebSocketRouteProps 

type WebSocketRouteProps struct {
	// The integration to be configured on this route.
	// Experimental.
	Integration WebSocketRouteIntegration `json:"integration" yaml:"integration"`
	// The authorize to this route.
	//
	// You can only set authorizer to a $connect route.
	// Experimental.
	Authorizer IWebSocketRouteAuthorizer `json:"authorizer" yaml:"authorizer"`
	// The key to this route.
	// Experimental.
	RouteKey *string `json:"routeKey" yaml:"routeKey"`
	// The API the route is associated with.
	// Experimental.
	WebSocketApi IWebSocketApi `json:"webSocketApi" yaml:"webSocketApi"`
	// Whether the route requires an API Key to be provided.
	// Experimental.
	ApiKeyRequired *bool `json:"apiKeyRequired" yaml:"apiKeyRequired"`
}

Properties to initialize a new Route.

TODO: EXAMPLE

Experimental.

type WebSocketStage 

type WebSocketStage interface {
	awscdk.Resource
	IStage
	IWebSocketStage
	Api() IWebSocketApi
	BaseApi() IApi
	CallbackUrl() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	StageName() *string
	Url() *string
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantManagementApiAccess(identity awsiam.IGrantable) awsiam.Grant
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Represents a stage where an instance of the API is deployed.

TODO: EXAMPLE

Experimental.

func NewWebSocketStage 

func NewWebSocketStage(scope constructs.Construct, id *string, props *WebSocketStageProps) WebSocketStage

Experimental.

type WebSocketStageAttributes 

type WebSocketStageAttributes struct {
	// The name of the stage.
	// Experimental.
	StageName *string `json:"stageName" yaml:"stageName"`
	// The API to which this stage is associated.
	// Experimental.
	Api IWebSocketApi `json:"api" yaml:"api"`
}

The attributes used to import existing WebSocketStage.

TODO: EXAMPLE

Experimental.

type WebSocketStageProps 

type WebSocketStageProps struct {
	// Whether updates to an API automatically trigger a new deployment.
	// Experimental.
	AutoDeploy *bool `json:"autoDeploy" yaml:"autoDeploy"`
	// The options for custom domain and api mapping.
	// Experimental.
	DomainMapping *DomainMappingOptions `json:"domainMapping" yaml:"domainMapping"`
	// The name of the stage.
	// Experimental.
	StageName *string `json:"stageName" yaml:"stageName"`
	// The WebSocket API to which this stage is associated.
	// Experimental.
	WebSocketApi IWebSocketApi `json:"webSocketApi" yaml:"webSocketApi"`
}

Properties to initialize an instance of `WebSocketStage`.

TODO: EXAMPLE

Experimental.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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