software.amazon.awscdk.services.apigateway

Class CfnRequestValidator

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.CfnRequestValidator

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.128Z")
 @Stability(value=Stable)
public class CfnRequestValidator
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::RequestValidator`.

The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. For more information, see Enable Basic Request Validation for an 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.apigateway.*;
 CfnRequestValidator cfnRequestValidator = CfnRequestValidator.Builder.create(this, "MyCfnRequestValidator")
         .restApiId("restApiId")
         // the properties below are optional
         .name("name")
         .validateRequestBody(false)
         .validateRequestParameters(false)
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnRequestValidator(software.constructs.Construct scope, String id, CfnRequestValidatorProps props) Create a new `AWS::ApiGateway::RequestValidator`.
protected	CfnRequestValidator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRequestValidator(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrRequestValidatorId() The ID for the request validator.
protected Map<String,Object>	getCfnProperties()
String	getName() The name of this request validator.
String	getRestApiId() The identifier of the targeted API entity.
Object	getValidateRequestBody() Indicates whether to validate the request body according to the configured schema for the targeted API and method.
Object	getValidateRequestParameters() Indicates whether to validate request parameters.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value) The name of this request validator.
void	setRestApiId(String value) The identifier of the targeted API entity.
void	setValidateRequestBody(Boolean value) Indicates whether to validate the request body according to the configured schema for the targeted API and method.
void	setValidateRequestBody(IResolvable value) Indicates whether to validate the request body according to the configured schema for the targeted API and method.
void	setValidateRequestParameters(Boolean value) Indicates whether to validate request parameters.
void	setValidateRequestParameters(IResolvable value) Indicates whether to validate request parameters.

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

CfnRequestValidator

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

CfnRequestValidator

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

CfnRequestValidator

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

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

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.

getAttrRequestValidatorId

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

The ID for the request validator.

For example: abc123 .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getRestApiId

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

The identifier of the targeted API entity.

setRestApiId

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

The identifier of the targeted API entity.

getName

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

The name of this request validator.

setName

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

The name of this request validator.

getValidateRequestBody

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

Indicates whether to validate the request body according to the configured schema for the targeted API and method.

setValidateRequestBody

@Stability(value=Stable)
public void setValidateRequestBody(@Nullable
                                                            Boolean value)

Indicates whether to validate the request body according to the configured schema for the targeted API and method.

setValidateRequestBody

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

Indicates whether to validate the request body according to the configured schema for the targeted API and method.

getValidateRequestParameters

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

Indicates whether to validate request parameters.

setValidateRequestParameters

@Stability(value=Stable)
public void setValidateRequestParameters(@Nullable
                                                                  Boolean value)

Indicates whether to validate request parameters.

setValidateRequestParameters

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

Indicates whether to validate request parameters.