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.103.1 (build bef2dea)",
date="2024-10-11T15:55:52.410Z")
@Stability(Stable)
public class CfnGatewayResponse
extends CfnResource
implements IInspectable
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();
- See Also:
-
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnGatewayResponse
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnGatewayResponse
(software.amazon.jsii.JsiiObjectRef objRef) CfnGatewayResponse
(software.constructs.Construct scope, String id, CfnGatewayResponseProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ID for the gateway response.Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.Response templates of the GatewayResponse as a string-to-string map of key-value pairs.The response type of the associated GatewayResponse.The string identifier of the associated RestApi.The HTTP status code for this GatewayResponse.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setResponseParameters
(Map<String, String> value) Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.void
setResponseParameters
(IResolvable value) Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.void
setResponseTemplates
(Map<String, String> value) Response templates of the GatewayResponse as a string-to-string map of key-value pairs.void
setResponseTemplates
(IResolvable value) Response templates of the GatewayResponse as a string-to-string map of key-value pairs.void
setResponseType
(String value) The response type of the associated GatewayResponse.void
setRestApiId
(String value) The string identifier of the associated RestApi.void
setStatusCode
(String value) The HTTP status code for this GatewayResponse.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnGatewayResponse
protected CfnGatewayResponse(software.amazon.jsii.JsiiObjectRef objRef) -
CfnGatewayResponse
protected CfnGatewayResponse(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnGatewayResponse
@Stability(Stable) public CfnGatewayResponse(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGatewayResponseProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The ID for the gateway response.For example:
abc123
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getResponseType
The response type of the associated GatewayResponse. -
setResponseType
The response type of the associated GatewayResponse. -
getRestApiId
The string identifier of the associated RestApi. -
setRestApiId
The string identifier of the associated RestApi. -
getResponseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. -
setResponseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. -
setResponseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. -
getResponseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs. -
setResponseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs. -
setResponseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs. -
getStatusCode
The HTTP status code for this GatewayResponse. -
setStatusCode
The HTTP status code for this GatewayResponse.
-