software.amazon.awscdk.services.apigatewayv2

Class CfnRouteResponse

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigatewayv2.CfnRouteResponse

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:12.670Z")
public class CfnRouteResponse
extends CfnResource
implements IInspectable

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

The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API. For more information, see Set up Route Responses for a WebSocket API in API Gateway in the API Gateway Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 Object responseModels;
 Object responseParameters;
 CfnRouteResponse cfnRouteResponse = CfnRouteResponse.Builder.create(this, "MyCfnRouteResponse")
         .apiId("apiId")
         .routeId("routeId")
         .routeResponseKey("routeResponseKey")
         // the properties below are optional
         .modelSelectionExpression("modelSelectionExpression")
         .responseModels(responseModels)
         .responseParameters(responseParameters)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRouteResponse.Builder A fluent builder for CfnRouteResponse.
static interface	CfnRouteResponse.ParameterConstraintsProperty Specifies whether the parameter is required.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRouteResponse(Construct scope, java.lang.String id, CfnRouteResponseProps props) Create a new `AWS::ApiGatewayV2::RouteResponse`.
protected	CfnRouteResponse(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRouteResponse(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiId() The API identifier.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getModelSelectionExpression() The model selection expression for the route response.
java.lang.Object	getResponseModels() The response models for the route response.
java.lang.Object	getResponseParameters() The route response parameters.
java.lang.String	getRouteId() The route ID.
java.lang.String	getRouteResponseKey() The route response key.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApiId(java.lang.String value) The API identifier.
void	setModelSelectionExpression(java.lang.String value) The model selection expression for the route response.
void	setResponseModels(java.lang.Object value) The response models for the route response.
void	setResponseParameters(java.lang.Object value) The route response parameters.
void	setRouteId(java.lang.String value) The route ID.
void	setRouteResponseKey(java.lang.String value) The route response key.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRouteResponse

protected CfnRouteResponse(software.amazon.jsii.JsiiObjectRef objRef)

CfnRouteResponse

protected CfnRouteResponse(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRouteResponse

public CfnRouteResponse(Construct scope,
                        java.lang.String id,
                        CfnRouteResponseProps props)

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

public java.lang.String getApiId()

The API identifier.

setApiId

public void setApiId(java.lang.String value)

The API identifier.

getResponseModels

public java.lang.Object getResponseModels()

The response models for the route response.

setResponseModels

public void setResponseModels(java.lang.Object value)

The response models for the route response.

getResponseParameters

public java.lang.Object getResponseParameters()

The route response parameters.

setResponseParameters

public void setResponseParameters(java.lang.Object value)

The route response parameters.

getRouteId

public java.lang.String getRouteId()

The route ID.

setRouteId

public void setRouteId(java.lang.String value)

The route ID.

getRouteResponseKey

public java.lang.String getRouteResponseKey()

The route response key.

setRouteResponseKey

public void setRouteResponseKey(java.lang.String value)

The route response key.

getModelSelectionExpression

public java.lang.String getModelSelectionExpression()

The model selection expression for the route response.

Supported only for WebSocket APIs.

setModelSelectionExpression

public void setModelSelectionExpression(java.lang.String value)

The model selection expression for the route response.

Supported only for WebSocket APIs.