awsapigatewayv2

package
v1.126.0-devpreview Latest Latest
Warning

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

 Go to latest Published: Oct 5, 2021 License: Apache-2.0 Imports: 9 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 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 NewVpcLink_Override(v VpcLink, scope constructs.Construct, id *string, props *VpcLinkProps)

Experimental.

func NewWebSocketApi_Override 

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

Experimental.

func NewWebSocketIntegration_Override 

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

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 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 IHttpRouteIntegration `json:"integration"`
	// The path at which all of these routes are configured.
	// Experimental.
	Path *string `json:"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"`
	// Authorizer to be associated to these routes.
	//
	// Use NoneAuthorizer to remove the default authorizer for the api
	// Experimental.
	Authorizer IHttpRouteAuthorizer `json:"authorizer"`
	// The HTTP methods to be configured.
	// Experimental.
	Methods *[]HttpMethod `json:"methods"`
}

Options for the Route with Integration resource. 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. 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"`
}

The attributes used to import existing ApiMapping. Experimental.

type ApiMappingProps 

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

Properties used to create the ApiMapping resource. 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 IHttpRouteIntegration `json:"integration"`
}

Options used when configuring multiple routes, at once.

The options here are the ones that would be configured for all being set up. 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`.

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

func NewCfnApiGatewayManagedOverrides 

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

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

type CfnApiGatewayManagedOverridesProps 

type CfnApiGatewayManagedOverridesProps struct {
	// `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Integration`.
	Integration interface{} `json:"integration"`
	// `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Route`.
	Route interface{} `json:"route"`
	// `AWS::ApiGatewayV2::ApiGatewayManagedOverrides.Stage`.
	Stage interface{} `json:"stage"`
}

Properties for defining a `AWS::ApiGatewayV2::ApiGatewayManagedOverrides`.

type CfnApiGatewayManagedOverrides_AccessLogSettingsProperty 

type CfnApiGatewayManagedOverrides_AccessLogSettingsProperty struct {
	// `CfnApiGatewayManagedOverrides.AccessLogSettingsProperty.DestinationArn`.
	DestinationArn *string `json:"destinationArn"`
	// `CfnApiGatewayManagedOverrides.AccessLogSettingsProperty.Format`.
	Format *string `json:"format"`
}

type CfnApiGatewayManagedOverrides_IntegrationOverridesProperty 

type CfnApiGatewayManagedOverrides_IntegrationOverridesProperty struct {
	// `CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Description`.
	Description *string `json:"description"`
	// `CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.IntegrationMethod`.
	IntegrationMethod *string `json:"integrationMethod"`
	// `CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.PayloadFormatVersion`.
	PayloadFormatVersion *string `json:"payloadFormatVersion"`
	// `CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.TimeoutInMillis`.
	TimeoutInMillis *float64 `json:"timeoutInMillis"`
}

type CfnApiGatewayManagedOverrides_RouteOverridesProperty 

type CfnApiGatewayManagedOverrides_RouteOverridesProperty struct {
	// `CfnApiGatewayManagedOverrides.RouteOverridesProperty.AuthorizationScopes`.
	AuthorizationScopes *[]*string `json:"authorizationScopes"`
	// `CfnApiGatewayManagedOverrides.RouteOverridesProperty.AuthorizationType`.
	AuthorizationType *string `json:"authorizationType"`
	// `CfnApiGatewayManagedOverrides.RouteOverridesProperty.AuthorizerId`.
	AuthorizerId *string `json:"authorizerId"`
	// `CfnApiGatewayManagedOverrides.RouteOverridesProperty.OperationName`.
	OperationName *string `json:"operationName"`
	// `CfnApiGatewayManagedOverrides.RouteOverridesProperty.Target`.
	Target *string `json:"target"`
}

type CfnApiGatewayManagedOverrides_RouteSettingsProperty 

type CfnApiGatewayManagedOverrides_RouteSettingsProperty struct {
	// `CfnApiGatewayManagedOverrides.RouteSettingsProperty.DataTraceEnabled`.
	DataTraceEnabled interface{} `json:"dataTraceEnabled"`
	// `CfnApiGatewayManagedOverrides.RouteSettingsProperty.DetailedMetricsEnabled`.
	DetailedMetricsEnabled interface{} `json:"detailedMetricsEnabled"`
	// `CfnApiGatewayManagedOverrides.RouteSettingsProperty.LoggingLevel`.
	LoggingLevel *string `json:"loggingLevel"`
	// `CfnApiGatewayManagedOverrides.RouteSettingsProperty.ThrottlingBurstLimit`.
	ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit"`
	// `CfnApiGatewayManagedOverrides.RouteSettingsProperty.ThrottlingRateLimit`.
	ThrottlingRateLimit *float64 `json:"throttlingRateLimit"`
}

type CfnApiGatewayManagedOverrides_StageOverridesProperty 

type CfnApiGatewayManagedOverrides_StageOverridesProperty struct {
	// `CfnApiGatewayManagedOverrides.StageOverridesProperty.AccessLogSettings`.
	AccessLogSettings interface{} `json:"accessLogSettings"`
	// `CfnApiGatewayManagedOverrides.StageOverridesProperty.AutoDeploy`.
	AutoDeploy interface{} `json:"autoDeploy"`
	// `CfnApiGatewayManagedOverrides.StageOverridesProperty.DefaultRouteSettings`.
	DefaultRouteSettings interface{} `json:"defaultRouteSettings"`
	// `CfnApiGatewayManagedOverrides.StageOverridesProperty.Description`.
	Description *string `json:"description"`
	// `CfnApiGatewayManagedOverrides.StageOverridesProperty.RouteSettings`.
	RouteSettings interface{} `json:"routeSettings"`
	// `CfnApiGatewayManagedOverrides.StageOverridesProperty.StageVariables`.
	StageVariables interface{} `json:"stageVariables"`
}

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

func NewCfnApiMapping 

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

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

type CfnApiMappingProps 

type CfnApiMappingProps struct {
	// `AWS::ApiGatewayV2::ApiMapping.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::ApiMapping.DomainName`.
	DomainName *string `json:"domainName"`
	// `AWS::ApiGatewayV2::ApiMapping.Stage`.
	Stage *string `json:"stage"`
	// `AWS::ApiGatewayV2::ApiMapping.ApiMappingKey`.
	ApiMappingKey *string `json:"apiMappingKey"`
}

Properties for defining a `AWS::ApiGatewayV2::ApiMapping`.

type CfnApiProps 

type CfnApiProps struct {
	// `AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`.
	ApiKeySelectionExpression *string `json:"apiKeySelectionExpression"`
	// `AWS::ApiGatewayV2::Api.BasePath`.
	BasePath *string `json:"basePath"`
	// `AWS::ApiGatewayV2::Api.Body`.
	Body interface{} `json:"body"`
	// `AWS::ApiGatewayV2::Api.BodyS3Location`.
	BodyS3Location interface{} `json:"bodyS3Location"`
	// `AWS::ApiGatewayV2::Api.CorsConfiguration`.
	CorsConfiguration interface{} `json:"corsConfiguration"`
	// `AWS::ApiGatewayV2::Api.CredentialsArn`.
	CredentialsArn *string `json:"credentialsArn"`
	// `AWS::ApiGatewayV2::Api.Description`.
	Description *string `json:"description"`
	// `AWS::ApiGatewayV2::Api.DisableExecuteApiEndpoint`.
	DisableExecuteApiEndpoint interface{} `json:"disableExecuteApiEndpoint"`
	// `AWS::ApiGatewayV2::Api.DisableSchemaValidation`.
	DisableSchemaValidation interface{} `json:"disableSchemaValidation"`
	// `AWS::ApiGatewayV2::Api.FailOnWarnings`.
	FailOnWarnings interface{} `json:"failOnWarnings"`
	// `AWS::ApiGatewayV2::Api.Name`.
	Name *string `json:"name"`
	// `AWS::ApiGatewayV2::Api.ProtocolType`.
	ProtocolType *string `json:"protocolType"`
	// `AWS::ApiGatewayV2::Api.RouteKey`.
	RouteKey *string `json:"routeKey"`
	// `AWS::ApiGatewayV2::Api.RouteSelectionExpression`.
	RouteSelectionExpression *string `json:"routeSelectionExpression"`
	// `AWS::ApiGatewayV2::Api.Tags`.
	Tags interface{} `json:"tags"`
	// `AWS::ApiGatewayV2::Api.Target`.
	Target *string `json:"target"`
	// `AWS::ApiGatewayV2::Api.Version`.
	Version *string `json:"version"`
}

Properties for defining a `AWS::ApiGatewayV2::Api`.

type CfnApi_BodyS3LocationProperty 

type CfnApi_BodyS3LocationProperty struct {
	// `CfnApi.BodyS3LocationProperty.Bucket`.
	Bucket *string `json:"bucket"`
	// `CfnApi.BodyS3LocationProperty.Etag`.
	Etag *string `json:"etag"`
	// `CfnApi.BodyS3LocationProperty.Key`.
	Key *string `json:"key"`
	// `CfnApi.BodyS3LocationProperty.Version`.
	Version *string `json:"version"`
}

type CfnApi_CorsProperty 

type CfnApi_CorsProperty struct {
	// `CfnApi.CorsProperty.AllowCredentials`.
	AllowCredentials interface{} `json:"allowCredentials"`
	// `CfnApi.CorsProperty.AllowHeaders`.
	AllowHeaders *[]*string `json:"allowHeaders"`
	// `CfnApi.CorsProperty.AllowMethods`.
	AllowMethods *[]*string `json:"allowMethods"`
	// `CfnApi.CorsProperty.AllowOrigins`.
	AllowOrigins *[]*string `json:"allowOrigins"`
	// `CfnApi.CorsProperty.ExposeHeaders`.
	ExposeHeaders *[]*string `json:"exposeHeaders"`
	// `CfnApi.CorsProperty.MaxAge`.
	MaxAge *float64 `json:"maxAge"`
}

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

func NewCfnAuthorizer 

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

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

type CfnAuthorizerProps 

type CfnAuthorizerProps struct {
	// `AWS::ApiGatewayV2::Authorizer.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::Authorizer.AuthorizerType`.
	AuthorizerType *string `json:"authorizerType"`
	// `AWS::ApiGatewayV2::Authorizer.Name`.
	Name *string `json:"name"`
	// `AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn`.
	AuthorizerCredentialsArn *string `json:"authorizerCredentialsArn"`
	// `AWS::ApiGatewayV2::Authorizer.AuthorizerPayloadFormatVersion`.
	AuthorizerPayloadFormatVersion *string `json:"authorizerPayloadFormatVersion"`
	// `AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds`.
	AuthorizerResultTtlInSeconds *float64 `json:"authorizerResultTtlInSeconds"`
	// `AWS::ApiGatewayV2::Authorizer.AuthorizerUri`.
	AuthorizerUri *string `json:"authorizerUri"`
	// `AWS::ApiGatewayV2::Authorizer.EnableSimpleResponses`.
	EnableSimpleResponses interface{} `json:"enableSimpleResponses"`
	// `AWS::ApiGatewayV2::Authorizer.IdentitySource`.
	IdentitySource *[]*string `json:"identitySource"`
	// `AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression`.
	IdentityValidationExpression *string `json:"identityValidationExpression"`
	// `AWS::ApiGatewayV2::Authorizer.JwtConfiguration`.
	JwtConfiguration interface{} `json:"jwtConfiguration"`
}

Properties for defining a `AWS::ApiGatewayV2::Authorizer`.

type CfnAuthorizer_JWTConfigurationProperty 

type CfnAuthorizer_JWTConfigurationProperty struct {
	// `CfnAuthorizer.JWTConfigurationProperty.Audience`.
	Audience *[]*string `json:"audience"`
	// `CfnAuthorizer.JWTConfigurationProperty.Issuer`.
	Issuer *string `json:"issuer"`
}

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

func NewCfnDeployment 

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

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

type CfnDeploymentProps 

type CfnDeploymentProps struct {
	// `AWS::ApiGatewayV2::Deployment.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::Deployment.Description`.
	Description *string `json:"description"`
	// `AWS::ApiGatewayV2::Deployment.StageName`.
	StageName *string `json:"stageName"`
}

Properties for defining a `AWS::ApiGatewayV2::Deployment`.

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

func NewCfnDomainName 

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

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

type CfnDomainNameProps 

type CfnDomainNameProps struct {
	// `AWS::ApiGatewayV2::DomainName.DomainName`.
	DomainName *string `json:"domainName"`
	// `AWS::ApiGatewayV2::DomainName.DomainNameConfigurations`.
	DomainNameConfigurations interface{} `json:"domainNameConfigurations"`
	// `AWS::ApiGatewayV2::DomainName.MutualTlsAuthentication`.
	MutualTlsAuthentication interface{} `json:"mutualTlsAuthentication"`
	// `AWS::ApiGatewayV2::DomainName.Tags`.
	Tags interface{} `json:"tags"`
}

Properties for defining a `AWS::ApiGatewayV2::DomainName`.

type CfnDomainName_DomainNameConfigurationProperty 

type CfnDomainName_DomainNameConfigurationProperty struct {
	// `CfnDomainName.DomainNameConfigurationProperty.CertificateArn`.
	CertificateArn *string `json:"certificateArn"`
	// `CfnDomainName.DomainNameConfigurationProperty.CertificateName`.
	CertificateName *string `json:"certificateName"`
	// `CfnDomainName.DomainNameConfigurationProperty.EndpointType`.
	EndpointType *string `json:"endpointType"`
	// `CfnDomainName.DomainNameConfigurationProperty.OwnershipVerificationCertificateArn`.
	OwnershipVerificationCertificateArn *string `json:"ownershipVerificationCertificateArn"`
	// `CfnDomainName.DomainNameConfigurationProperty.SecurityPolicy`.
	SecurityPolicy *string `json:"securityPolicy"`
}

type CfnDomainName_MutualTlsAuthenticationProperty 

type CfnDomainName_MutualTlsAuthenticationProperty struct {
	// `CfnDomainName.MutualTlsAuthenticationProperty.TruststoreUri`.
	TruststoreUri *string `json:"truststoreUri"`
	// `CfnDomainName.MutualTlsAuthenticationProperty.TruststoreVersion`.
	TruststoreVersion *string `json:"truststoreVersion"`
}

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

func NewCfnIntegration 

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

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

type CfnIntegrationProps 

type CfnIntegrationProps struct {
	// `AWS::ApiGatewayV2::Integration.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::Integration.IntegrationType`.
	IntegrationType *string `json:"integrationType"`
	// `AWS::ApiGatewayV2::Integration.ConnectionId`.
	ConnectionId *string `json:"connectionId"`
	// `AWS::ApiGatewayV2::Integration.ConnectionType`.
	ConnectionType *string `json:"connectionType"`
	// `AWS::ApiGatewayV2::Integration.ContentHandlingStrategy`.
	ContentHandlingStrategy *string `json:"contentHandlingStrategy"`
	// `AWS::ApiGatewayV2::Integration.CredentialsArn`.
	CredentialsArn *string `json:"credentialsArn"`
	// `AWS::ApiGatewayV2::Integration.Description`.
	Description *string `json:"description"`
	// `AWS::ApiGatewayV2::Integration.IntegrationMethod`.
	IntegrationMethod *string `json:"integrationMethod"`
	// `AWS::ApiGatewayV2::Integration.IntegrationSubtype`.
	IntegrationSubtype *string `json:"integrationSubtype"`
	// `AWS::ApiGatewayV2::Integration.IntegrationUri`.
	IntegrationUri *string `json:"integrationUri"`
	// `AWS::ApiGatewayV2::Integration.PassthroughBehavior`.
	PassthroughBehavior *string `json:"passthroughBehavior"`
	// `AWS::ApiGatewayV2::Integration.PayloadFormatVersion`.
	PayloadFormatVersion *string `json:"payloadFormatVersion"`
	// `AWS::ApiGatewayV2::Integration.RequestParameters`.
	RequestParameters interface{} `json:"requestParameters"`
	// `AWS::ApiGatewayV2::Integration.RequestTemplates`.
	RequestTemplates interface{} `json:"requestTemplates"`
	// `AWS::ApiGatewayV2::Integration.ResponseParameters`.
	ResponseParameters interface{} `json:"responseParameters"`
	// `AWS::ApiGatewayV2::Integration.TemplateSelectionExpression`.
	TemplateSelectionExpression *string `json:"templateSelectionExpression"`
	// `AWS::ApiGatewayV2::Integration.TimeoutInMillis`.
	TimeoutInMillis *float64 `json:"timeoutInMillis"`
	// `AWS::ApiGatewayV2::Integration.TlsConfig`.
	TlsConfig interface{} `json:"tlsConfig"`
}

Properties for defining a `AWS::ApiGatewayV2::Integration`.

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

func NewCfnIntegrationResponse 

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

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

type CfnIntegrationResponseProps 

type CfnIntegrationResponseProps struct {
	// `AWS::ApiGatewayV2::IntegrationResponse.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::IntegrationResponse.IntegrationId`.
	IntegrationId *string `json:"integrationId"`
	// `AWS::ApiGatewayV2::IntegrationResponse.IntegrationResponseKey`.
	IntegrationResponseKey *string `json:"integrationResponseKey"`
	// `AWS::ApiGatewayV2::IntegrationResponse.ContentHandlingStrategy`.
	ContentHandlingStrategy *string `json:"contentHandlingStrategy"`
	// `AWS::ApiGatewayV2::IntegrationResponse.ResponseParameters`.
	ResponseParameters interface{} `json:"responseParameters"`
	// `AWS::ApiGatewayV2::IntegrationResponse.ResponseTemplates`.
	ResponseTemplates interface{} `json:"responseTemplates"`
	// `AWS::ApiGatewayV2::IntegrationResponse.TemplateSelectionExpression`.
	TemplateSelectionExpression *string `json:"templateSelectionExpression"`
}

Properties for defining a `AWS::ApiGatewayV2::IntegrationResponse`.

type CfnIntegration_ResponseParameterListProperty 

type CfnIntegration_ResponseParameterListProperty struct {
	// `CfnIntegration.ResponseParameterListProperty.ResponseParameters`.
	ResponseParameters interface{} `json:"responseParameters"`
}

type CfnIntegration_ResponseParameterProperty 

type CfnIntegration_ResponseParameterProperty struct {
	// `CfnIntegration.ResponseParameterProperty.Destination`.
	Destination *string `json:"destination"`
	// `CfnIntegration.ResponseParameterProperty.Source`.
	Source *string `json:"source"`
}

type CfnIntegration_TlsConfigProperty 

type CfnIntegration_TlsConfigProperty struct {
	// `CfnIntegration.TlsConfigProperty.ServerNameToVerify`.
	ServerNameToVerify *string `json:"serverNameToVerify"`
}

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

func NewCfnModel 

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

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

type CfnModelProps 

type CfnModelProps struct {
	// `AWS::ApiGatewayV2::Model.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::Model.Name`.
	Name *string `json:"name"`
	// `AWS::ApiGatewayV2::Model.Schema`.
	Schema interface{} `json:"schema"`
	// `AWS::ApiGatewayV2::Model.ContentType`.
	ContentType *string `json:"contentType"`
	// `AWS::ApiGatewayV2::Model.Description`.
	Description *string `json:"description"`
}

Properties for defining a `AWS::ApiGatewayV2::Model`.

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

func NewCfnRoute 

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

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

type CfnRouteProps 

type CfnRouteProps struct {
	// `AWS::ApiGatewayV2::Route.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::Route.RouteKey`.
	RouteKey *string `json:"routeKey"`
	// `AWS::ApiGatewayV2::Route.ApiKeyRequired`.
	ApiKeyRequired interface{} `json:"apiKeyRequired"`
	// `AWS::ApiGatewayV2::Route.AuthorizationScopes`.
	AuthorizationScopes *[]*string `json:"authorizationScopes"`
	// `AWS::ApiGatewayV2::Route.AuthorizationType`.
	AuthorizationType *string `json:"authorizationType"`
	// `AWS::ApiGatewayV2::Route.AuthorizerId`.
	AuthorizerId *string `json:"authorizerId"`
	// `AWS::ApiGatewayV2::Route.ModelSelectionExpression`.
	ModelSelectionExpression *string `json:"modelSelectionExpression"`
	// `AWS::ApiGatewayV2::Route.OperationName`.
	OperationName *string `json:"operationName"`
	// `AWS::ApiGatewayV2::Route.RequestModels`.
	RequestModels interface{} `json:"requestModels"`
	// `AWS::ApiGatewayV2::Route.RequestParameters`.
	RequestParameters interface{} `json:"requestParameters"`
	// `AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression`.
	RouteResponseSelectionExpression *string `json:"routeResponseSelectionExpression"`
	// `AWS::ApiGatewayV2::Route.Target`.
	Target *string `json:"target"`
}

Properties for defining a `AWS::ApiGatewayV2::Route`.

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

func NewCfnRouteResponse 

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

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

type CfnRouteResponseProps 

type CfnRouteResponseProps struct {
	// `AWS::ApiGatewayV2::RouteResponse.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::RouteResponse.RouteId`.
	RouteId *string `json:"routeId"`
	// `AWS::ApiGatewayV2::RouteResponse.RouteResponseKey`.
	RouteResponseKey *string `json:"routeResponseKey"`
	// `AWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression`.
	ModelSelectionExpression *string `json:"modelSelectionExpression"`
	// `AWS::ApiGatewayV2::RouteResponse.ResponseModels`.
	ResponseModels interface{} `json:"responseModels"`
	// `AWS::ApiGatewayV2::RouteResponse.ResponseParameters`.
	ResponseParameters interface{} `json:"responseParameters"`
}

Properties for defining a `AWS::ApiGatewayV2::RouteResponse`.

type CfnRouteResponse_ParameterConstraintsProperty 

type CfnRouteResponse_ParameterConstraintsProperty struct {
	// `CfnRouteResponse.ParameterConstraintsProperty.Required`.
	Required interface{} `json:"required"`
}

type CfnRoute_ParameterConstraintsProperty 

type CfnRoute_ParameterConstraintsProperty struct {
	// `CfnRoute.ParameterConstraintsProperty.Required`.
	Required interface{} `json:"required"`
}

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

func NewCfnStage 

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

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

type CfnStageProps 

type CfnStageProps struct {
	// `AWS::ApiGatewayV2::Stage.ApiId`.
	ApiId *string `json:"apiId"`
	// `AWS::ApiGatewayV2::Stage.StageName`.
	StageName *string `json:"stageName"`
	// `AWS::ApiGatewayV2::Stage.AccessLogSettings`.
	AccessLogSettings interface{} `json:"accessLogSettings"`
	// `AWS::ApiGatewayV2::Stage.AccessPolicyId`.
	AccessPolicyId *string `json:"accessPolicyId"`
	// `AWS::ApiGatewayV2::Stage.AutoDeploy`.
	AutoDeploy interface{} `json:"autoDeploy"`
	// `AWS::ApiGatewayV2::Stage.ClientCertificateId`.
	ClientCertificateId *string `json:"clientCertificateId"`
	// `AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.
	DefaultRouteSettings interface{} `json:"defaultRouteSettings"`
	// `AWS::ApiGatewayV2::Stage.DeploymentId`.
	DeploymentId *string `json:"deploymentId"`
	// `AWS::ApiGatewayV2::Stage.Description`.
	Description *string `json:"description"`
	// `AWS::ApiGatewayV2::Stage.RouteSettings`.
	RouteSettings interface{} `json:"routeSettings"`
	// `AWS::ApiGatewayV2::Stage.StageVariables`.
	StageVariables interface{} `json:"stageVariables"`
	// `AWS::ApiGatewayV2::Stage.Tags`.
	Tags interface{} `json:"tags"`
}

Properties for defining a `AWS::ApiGatewayV2::Stage`.

type CfnStage_AccessLogSettingsProperty 

type CfnStage_AccessLogSettingsProperty struct {
	// `CfnStage.AccessLogSettingsProperty.DestinationArn`.
	DestinationArn *string `json:"destinationArn"`
	// `CfnStage.AccessLogSettingsProperty.Format`.
	Format *string `json:"format"`
}

type CfnStage_RouteSettingsProperty 

type CfnStage_RouteSettingsProperty struct {
	// `CfnStage.RouteSettingsProperty.DataTraceEnabled`.
	DataTraceEnabled interface{} `json:"dataTraceEnabled"`
	// `CfnStage.RouteSettingsProperty.DetailedMetricsEnabled`.
	DetailedMetricsEnabled interface{} `json:"detailedMetricsEnabled"`
	// `CfnStage.RouteSettingsProperty.LoggingLevel`.
	LoggingLevel *string `json:"loggingLevel"`
	// `CfnStage.RouteSettingsProperty.ThrottlingBurstLimit`.
	ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit"`
	// `CfnStage.RouteSettingsProperty.ThrottlingRateLimit`.
	ThrottlingRateLimit *float64 `json:"throttlingRateLimit"`
}
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`. 

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

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

type CfnVpcLinkProps 

type CfnVpcLinkProps struct {
	// `AWS::ApiGatewayV2::VpcLink.Name`.
	Name *string `json:"name"`
	// `AWS::ApiGatewayV2::VpcLink.SubnetIds`.
	SubnetIds *[]*string `json:"subnetIds"`
	// `AWS::ApiGatewayV2::VpcLink.SecurityGroupIds`.
	SecurityGroupIds *[]*string `json:"securityGroupIds"`
	// `AWS::ApiGatewayV2::VpcLink.Tags`.
	Tags interface{} `json:"tags"`
}

Properties for defining a `AWS::ApiGatewayV2::VpcLink`.

type CorsHttpMethod 

type CorsHttpMethod string

Supported CORS HTTP methods. 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"`
	// Represents a collection of allowed headers.
	// Experimental.
	AllowHeaders *[]*string `json:"allowHeaders"`
	// Represents a collection of allowed HTTP methods.
	// Experimental.
	AllowMethods *[]CorsHttpMethod `json:"allowMethods"`
	// Represents a collection of allowed origins.
	// Experimental.
	AllowOrigins *[]*string `json:"allowOrigins"`
	// Represents a collection of exposed headers.
	// Experimental.
	ExposeHeaders *[]*string `json:"exposeHeaders"`
	// The duration that the browser should cache preflight request results.
	// Experimental.
	MaxAge awscdk.Duration `json:"maxAge"`
}

Options for the CORS Configuration. Experimental.

type DomainMappingOptions 

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

Options for DomainMapping. 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
	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. 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"`
	// The domain name associated with the regional endpoint for this custom domain name.
	// Experimental.
	RegionalDomainName *string `json:"regionalDomainName"`
	// The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
	// Experimental.
	RegionalHostedZoneId *string `json:"regionalHostedZoneId"`
}

custom domain name attributes. Experimental.

type DomainNameProps 

type DomainNameProps struct {
	// The ACM certificate for this domain name.
	// Experimental.
	Certificate awscertificatemanager.ICertificate `json:"certificate"`
	// The custom domain name.
	// Experimental.
	DomainName *string `json:"domainName"`
}

properties used for creating the DomainName. 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. 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"`
	// The endpoint URL of the HttpApi.
	// Experimental.
	ApiEndpoint *string `json:"apiEndpoint"`
}

Attributes for importing an HttpApi into the CDK. Experimental.

type HttpApiProps 

type HttpApiProps struct {
	// Name for the HTTP API resource.
	// Experimental.
	ApiName *string `json:"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"`
	// Whether a default stage and deployment should be automatically created.
	// Experimental.
	CreateDefaultStage *bool `json:"createDefaultStage"`
	// Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.
	// Experimental.
	DefaultAuthorizationScopes *[]*string `json:"defaultAuthorizationScopes"`
	// Default Authorizer to applied to all routes in the gateway.
	// Experimental.
	DefaultAuthorizer IHttpRouteAuthorizer `json:"defaultAuthorizer"`
	// Configure a custom domain with the API mapping resource to the HTTP API.
	// Experimental.
	DefaultDomainMapping *DomainMappingOptions `json:"defaultDomainMapping"`
	// An integration that will be configured on the catch-all route ($default).
	// Experimental.
	DefaultIntegration IHttpRouteIntegration `json:"defaultIntegration"`
	// The description of the API.
	// Experimental.
	Description *string `json:"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"`
}

Properties to initialize an instance of `HttpApi`. 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. 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"`
	// Type of authorizer.
	//
	// Possible values are:
	// - JWT - JSON Web Token Authorizer
	// - CUSTOM - Lambda Authorizer
	// - NONE - No Authorization
	// Experimental.
	AuthorizerType *string `json:"authorizerType"`
}

Reference to an http authorizer. Experimental.

type HttpAuthorizerProps 

type HttpAuthorizerProps struct {
	// HTTP Api to attach the authorizer to.
	// Experimental.
	HttpApi IHttpApi `json:"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"`
	// The type of authorizer.
	// Experimental.
	Type HttpAuthorizerType `json:"type"`
	// Name of the authorizer.
	// Experimental.
	AuthorizerName *string `json:"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"`
	// 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"`
	// 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"`
	// The base domain of the identity provider that issues JWT.
	// Experimental.
	JwtIssuer *string `json:"jwtIssuer"`
	// Specifies the format of the payload sent to an HTTP API Lambda authorizer.
	// Experimental.
	PayloadFormatVersion AuthorizerPayloadVersion `json:"payloadFormatVersion"`
	// How long APIGateway should cache the results.
	//
	// Max 1 hour.
	// Experimental.
	ResultsCacheTtl awscdk.Duration `json:"resultsCacheTtl"`
}

Properties to initialize an instance of `HttpAuthorizer`. Experimental.

type HttpAuthorizerType 

type HttpAuthorizerType string

Supported Authorizer types. Experimental. 

const (
	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. 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"`
	// Integration type.
	// Experimental.
	IntegrationType HttpIntegrationType `json:"integrationType"`
	// Integration URI.
	//
	// This will be the function ARN in the case of `HttpIntegrationType.LAMBDA_PROXY`,
	// or HTTP URL in the case of `HttpIntegrationType.HTTP_PROXY`.
	// Experimental.
	IntegrationUri *string `json:"integrationUri"`
	// The ID of the VPC link for a private integration.
	//
	// Supported only for HTTP APIs.
	// Experimental.
	ConnectionId *string `json:"connectionId"`
	// The type of the network connection to the integration endpoint.
	// Experimental.
	ConnectionType HttpConnectionType `json:"connectionType"`
	// The HTTP method to use when calling the underlying HTTP proxy.
	// Experimental.
	Method HttpMethod `json:"method"`
	// 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"`
	// 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"`
}

The integration properties. Experimental.

type HttpIntegrationType 

type HttpIntegrationType string

Supported integration types. Experimental. 

const (
	HttpIntegrationType_LAMBDA_PROXY HttpIntegrationType = "LAMBDA_PROXY"
	HttpIntegrationType_HTTP_PROXY   HttpIntegrationType = "HTTP_PROXY"
)

type HttpMethod 

type HttpMethod string

Supported HTTP methods. 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. 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
	RouteId() *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
}

Route class that creates the Route for API Gateway HTTP API. 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"`
	// The scope for any constructs created as part of the bind.
	// Experimental.
	Scope constructs.Construct `json:"scope"`
}

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

type HttpRouteAuthorizerConfig 

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

Results of binding an authorizer to an http route. Experimental.

type HttpRouteIntegrationBindOptions 

type HttpRouteIntegrationBindOptions struct {
	// The route to which this is being bound.
	// Experimental.
	Route IHttpRoute `json:"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"`
}

Options to the HttpRouteIntegration during its bind operation. 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"`
	// Integration type.
	// Experimental.
	Type HttpIntegrationType `json:"type"`
	// Integration URI.
	// Experimental.
	Uri *string `json:"uri"`
	// The ID of the VPC link for a private integration.
	//
	// Supported only for HTTP APIs.
	// Experimental.
	ConnectionId *string `json:"connectionId"`
	// The type of the network connection to the integration endpoint.
	// Experimental.
	ConnectionType HttpConnectionType `json:"connectionType"`
	// The HTTP method that must be used to invoke the underlying proxy.
	//
	// Required for `HttpIntegrationType.HTTP_PROXY`
	// Experimental.
	Method HttpMethod `json:"method"`
	// 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"`
}

Config returned back as a result of the bind. Experimental.

type HttpRouteKey 

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

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

This class models that combination. 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 IHttpRouteIntegration `json:"integration"`
	// the API the route is associated with.
	// Experimental.
	HttpApi IHttpApi `json:"httpApi"`
	// The key to this route.
	//
	// This is a combination of an HTTP method and an HTTP path.
	// Experimental.
	RouteKey HttpRouteKey `json:"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"`
	// Authorizer for a WebSocket API or an HTTP API.
	// Experimental.
	Authorizer IHttpRouteAuthorizer `json:"authorizer"`
}

Properties to initialize a new Route. 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. 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"`
	// The API to which this stage is associated.
	// Experimental.
	Api IHttpApi `json:"api"`
}

The attributes used to import existing HttpStage. Experimental.

type HttpStageOptions 

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

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

type HttpStageProps 

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

Properties to initialize an instance of `HttpStage`. 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
	// 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
}

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 IHttpRouteIntegration 

type IHttpRouteIntegration interface {
	// Bind this integration to the route.
	// Experimental.
	Bind(options *HttpRouteIntegrationBindOptions) *HttpRouteIntegrationConfig
}

The interface that various route integration classes will inherit. 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
}

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

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 IWebSocketRouteIntegration 

type IWebSocketRouteIntegration interface {
	// Bind this integration to the route.
	// Experimental.
	Bind(options *WebSocketRouteIntegrationBindOptions) *WebSocketRouteIntegrationConfig
}

The interface that various route integration classes will inherit. 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 PayloadFormatVersion 

type PayloadFormatVersion interface {
	Version() *string
}

Payload format version for lambda proxy integration. 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 StageAttributes 

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

The attributes used to import existing Stage. Experimental.

type StageOptions 

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

Options required to create a new stage.

Options that are common between HTTP and Websocket APIs. 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). 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"`
	// The VPC Link id.
	// Experimental.
	VpcLinkId *string `json:"vpcLinkId"`
}

Attributes when importing a new VpcLink. Experimental.

type VpcLinkProps 

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

Properties for a VpcLink. 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
	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. Experimental.

func NewWebSocketApi 

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

Experimental.

type WebSocketApiProps 

type WebSocketApiProps struct {
	// Name for the WebSocket API resoruce.
	// Experimental.
	ApiName *string `json:"apiName"`
	// Options to configure a '$connect' route.
	// Experimental.
	ConnectRouteOptions *WebSocketRouteOptions `json:"connectRouteOptions"`
	// Options to configure a '$default' route.
	// Experimental.
	DefaultRouteOptions *WebSocketRouteOptions `json:"defaultRouteOptions"`
	// The description of the API.
	// Experimental.
	Description *string `json:"description"`
	// Options to configure a '$disconnect' route.
	// Experimental.
	DisconnectRouteOptions *WebSocketRouteOptions `json:"disconnectRouteOptions"`
	// The route selection expression for the API.
	// Experimental.
	RouteSelectionExpression *string `json:"routeSelectionExpression"`
}

Props for WebSocket API. Experimental.

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. 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"`
	// Integration URI.
	// Experimental.
	IntegrationUri *string `json:"integrationUri"`
	// The WebSocket API to which this integration should be bound.
	// Experimental.
	WebSocketApi IWebSocketApi `json:"webSocketApi"`
}

The integration properties. Experimental.

type WebSocketIntegrationType 

type WebSocketIntegrationType string

WebSocket Integration Types. Experimental. 

const (
	WebSocketIntegrationType_AWS_PROXY WebSocketIntegrationType = "AWS_PROXY"
)

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

func NewWebSocketRoute 

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

Experimental.

type WebSocketRouteIntegrationBindOptions 

type WebSocketRouteIntegrationBindOptions struct {
	// The route to which this is being bound.
	// Experimental.
	Route IWebSocketRoute `json:"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"`
}

Options to the WebSocketRouteIntegration during its bind operation. Experimental.

type WebSocketRouteIntegrationConfig 

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

Config returned back as a result of the bind. Experimental.

type WebSocketRouteOptions 

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

Options used to add route to the API. Experimental.

type WebSocketRouteProps 

type WebSocketRouteProps struct {
	// The integration to be configured on this route.
	// Experimental.
	Integration IWebSocketRouteIntegration `json:"integration"`
	// The key to this route.
	// Experimental.
	RouteKey *string `json:"routeKey"`
	// the API the route is associated with.
	// Experimental.
	WebSocketApi IWebSocketApi `json:"webSocketApi"`
}

Properties to initialize a new Route. 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
	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. 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"`
	// The API to which this stage is associated.
	// Experimental.
	Api IWebSocketApi `json:"api"`
}

The attributes used to import existing WebSocketStage. Experimental.

type WebSocketStageProps 

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

Properties to initialize an instance of `WebSocketStage`. 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.