@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:58.252Z") public class CfnRouteResponse extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnRouteResponse(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnRouteResponse(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnRouteResponse(Construct scope, java.lang.String id, CfnRouteResponseProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApiId()
public void setApiId(java.lang.String value)
public java.lang.Object getResponseModels()
public void setResponseModels(java.lang.Object value)
public java.lang.Object getResponseParameters()
public void setResponseParameters(java.lang.Object value)
public java.lang.String getRouteId()
public void setRouteId(java.lang.String value)
public java.lang.String getRouteResponseKey()
public void setRouteResponseKey(java.lang.String value)
public java.lang.String getModelSelectionExpression()
Supported only for WebSocket APIs.
public void setModelSelectionExpression(java.lang.String value)
Supported only for WebSocket APIs.