Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketApiProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.WebSocketApiProps.Jsii$Proxy

All Implemented Interfaces:

WebSocketApiProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

WebSocketApiProps

@Stability(Stable)
@Internal
public static final class WebSocketApiProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements WebSocketApiProps

An implementation for WebSocketApiProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.WebSocketApiProps

WebSocketApiProps.Builder, WebSocketApiProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(WebSocketApiProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the WebSocketApiProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final WebSocketApiKeySelectionExpression	getApiKeySelectionExpression()	An API key selection expression.
final String	getApiName()	Name for the WebSocket API resource.
final WebSocketRouteOptions	getConnectRouteOptions()	Options to configure a '$connect' route.
final WebSocketRouteOptions	getDefaultRouteOptions()	Options to configure a '$default' route.
final String	getDescription()	The description of the API.
final Boolean	getDisableSchemaValidation()	Avoid validating models when creating a deployment.
final WebSocketRouteOptions	getDisconnectRouteOptions()	Options to configure a '$disconnect' route.
final IpAddressType	getIpAddressType()	The IP address types that can invoke the API.
final String	getRouteSelectionExpression()	The route selection expression for the API.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(WebSocketApiProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the WebSocketApiProps.Builder.

Method Details

getApiKeySelectionExpression

public final WebSocketApiKeySelectionExpression getApiKeySelectionExpression()

Description copied from interface: WebSocketApiProps

An API key selection expression.

Providing this option will require an API Key be provided to access the API.

Default: - Key is not required to access these APIs

Specified by:

getApiKeySelectionExpression in interface WebSocketApiProps

getApiName

public final String getApiName()

Description copied from interface: WebSocketApiProps

Name for the WebSocket API resource.

Default: - id of the WebSocketApi construct.

Specified by:

getApiName in interface WebSocketApiProps

getConnectRouteOptions

public final WebSocketRouteOptions getConnectRouteOptions()

Description copied from interface: WebSocketApiProps

Options to configure a '$connect' route.

Default: - no '$connect' route configured

Specified by:

getConnectRouteOptions in interface WebSocketApiProps

getDefaultRouteOptions

public final WebSocketRouteOptions getDefaultRouteOptions()

Description copied from interface: WebSocketApiProps

Options to configure a '$default' route.

Default: - no '$default' route configured

Specified by:

getDefaultRouteOptions in interface WebSocketApiProps

getDescription

public final String getDescription()

Description copied from interface: WebSocketApiProps

The description of the API.

Default: - none

Specified by:

getDescription in interface WebSocketApiProps

getDisableSchemaValidation

public final Boolean getDisableSchemaValidation()

Description copied from interface: WebSocketApiProps

Avoid validating models when creating a deployment.

Default: false

Specified by:

getDisableSchemaValidation in interface WebSocketApiProps

getDisconnectRouteOptions

public final WebSocketRouteOptions getDisconnectRouteOptions()

Description copied from interface: WebSocketApiProps

Options to configure a '$disconnect' route.

Default: - no '$disconnect' route configured

Specified by:

getDisconnectRouteOptions in interface WebSocketApiProps

getIpAddressType

public final IpAddressType getIpAddressType()

Description copied from interface: WebSocketApiProps

The IP address types that can invoke the API.

Default: undefined - AWS default is IPV4

Specified by:

getIpAddressType in interface WebSocketApiProps

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-ip-address-type.html

getRouteSelectionExpression

public final String getRouteSelectionExpression()

Description copied from interface: WebSocketApiProps

The route selection expression for the API.

Default: '$request.body.action'

Specified by:

getRouteSelectionExpression in interface WebSocketApiProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object