software.amazon.awscdk.services.apigateway

Class CfnGatewayResponse

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnGatewayResponse

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.119Z")
 @Stability(value=Stable)
public class CfnGatewayResponse
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::GatewayResponse`.

The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see API Gateway Responses 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.apigateway.*;
 CfnGatewayResponse cfnGatewayResponse = CfnGatewayResponse.Builder.create(this, "MyCfnGatewayResponse")
         .responseType("responseType")
         .restApiId("restApiId")
         // the properties below are optional
         .responseParameters(Map.of(
                 "responseParametersKey", "responseParameters"))
         .responseTemplates(Map.of(
                 "responseTemplatesKey", "responseTemplates"))
         .statusCode("statusCode")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGatewayResponse.Builder A fluent builder for CfnGatewayResponse.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGatewayResponse(software.constructs.Construct scope, String id, CfnGatewayResponseProps props) Create a new `AWS::ApiGateway::GatewayResponse`.
protected	CfnGatewayResponse(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGatewayResponse(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId() The ID for the gateway response.
protected Map<String,Object>	getCfnProperties()
Object	getResponseParameters() The response parameters (paths, query strings, and headers) for the response.
Object	getResponseTemplates() The response templates for the response.
String	getResponseType() The response type.
String	getRestApiId() The identifier of the API.
String	getStatusCode() The HTTP status code for the response.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setResponseParameters(IResolvable value) The response parameters (paths, query strings, and headers) for the response.
void	setResponseParameters(Map<String,String> value) The response parameters (paths, query strings, and headers) for the response.
void	setResponseTemplates(IResolvable value) The response templates for the response.
void	setResponseTemplates(Map<String,String> value) The response templates for the response.
void	setResponseType(String value) The response type.
void	setRestApiId(String value) The identifier of the API.
void	setStatusCode(String value) The HTTP status code for the response.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGatewayResponse

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

CfnGatewayResponse

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

CfnGatewayResponse

@Stability(value=Stable)
public CfnGatewayResponse(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnGatewayResponseProps props)

Create a new `AWS::ApiGateway::GatewayResponse`.

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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID for the gateway response.

For example: abc123 .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getResponseType

@Stability(value=Stable)
 @NotNull
public String getResponseType()

The response type.

For valid values, see GatewayResponse in the API Gateway API Reference .

setResponseType

@Stability(value=Stable)
public void setResponseType(@NotNull
                                                     String value)

The response type.

For valid values, see GatewayResponse in the API Gateway API Reference .

getRestApiId

@Stability(value=Stable)
 @NotNull
public String getRestApiId()

The identifier of the API.

setRestApiId

@Stability(value=Stable)
public void setRestApiId(@NotNull
                                                  String value)

The identifier of the API.

getResponseParameters

@Stability(value=Stable)
 @Nullable
public Object getResponseParameters()

The response parameters (paths, query strings, and headers) for the response.

Duplicates not allowed.

setResponseParameters

@Stability(value=Stable)
public void setResponseParameters(@Nullable
                                                           IResolvable value)

The response parameters (paths, query strings, and headers) for the response.

Duplicates not allowed.

setResponseParameters

@Stability(value=Stable)
public void setResponseParameters(@Nullable
                                                           Map<String,String> value)

The response parameters (paths, query strings, and headers) for the response.

Duplicates not allowed.

getResponseTemplates

@Stability(value=Stable)
 @Nullable
public Object getResponseTemplates()

The response templates for the response.

Duplicates not allowed.

setResponseTemplates

@Stability(value=Stable)
public void setResponseTemplates(@Nullable
                                                          IResolvable value)

The response templates for the response.

Duplicates not allowed.

setResponseTemplates

@Stability(value=Stable)
public void setResponseTemplates(@Nullable
                                                          Map<String,String> value)

The response templates for the response.

Duplicates not allowed.

getStatusCode

@Stability(value=Stable)
 @Nullable
public String getStatusCode()

The HTTP status code for the response.

setStatusCode

@Stability(value=Stable)
public void setStatusCode(@Nullable
                                                   String value)

The HTTP status code for the response.