software.amazon.awscdk.services.apigateway

Class CfnRequestValidator

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.535Z")
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 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
	CfnRequestValidator(Construct scope, java.lang.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
java.lang.String	getAttrRequestValidatorId() The ID for the request validator.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() The name of this RequestValidator.
java.lang.String	getRestApiId() The string identifier of the associated RestApi.
java.lang.Object	getValidateRequestBody() A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
java.lang.Object	getValidateRequestParameters() A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).
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	setName(java.lang.String value) The name of this RequestValidator.
void	setRestApiId(java.lang.String value) The string identifier of the associated RestApi.
void	setValidateRequestBody(java.lang.Boolean value) A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
void	setValidateRequestBody(IResolvable value) A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
void	setValidateRequestParameters(java.lang.Boolean value) A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).
void	setValidateRequestParameters(IResolvable value) A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).

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

CfnRequestValidator

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

CfnRequestValidator

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

CfnRequestValidator

public CfnRequestValidator(Construct scope,
                           java.lang.String id,
                           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

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.

getAttrRequestValidatorId

public java.lang.String getAttrRequestValidatorId()

The ID for the request validator.

For example: abc123 .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getRestApiId

public java.lang.String getRestApiId()

The string identifier of the associated RestApi.

setRestApiId

public void setRestApiId(java.lang.String value)

The string identifier of the associated RestApi.

getName

public java.lang.String getName()

The name of this RequestValidator.

setName

public void setName(java.lang.String value)

The name of this RequestValidator.

getValidateRequestBody

public java.lang.Object getValidateRequestBody()

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

setValidateRequestBody

public void setValidateRequestBody(java.lang.Boolean value)

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

setValidateRequestBody

public void setValidateRequestBody(IResolvable value)

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

getValidateRequestParameters

public java.lang.Object getValidateRequestParameters()

A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).

setValidateRequestParameters

public void setValidateRequestParameters(java.lang.Boolean value)

A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).

setValidateRequestParameters

public void setValidateRequestParameters(IResolvable value)

A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).