Interface ICfnRequestValidatorProps

Properties for defining a CfnRequestValidator.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnRequestValidatorProps

Syntax (vb)

Public Interface ICfnRequestValidatorProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;

var cfnRequestValidatorProps = new CfnRequestValidatorProps {
    RestApiId = "restApiId",

    // the properties below are optional
    Name = "name",
    ValidateRequestBody = false,
    ValidateRequestParameters = false
};

Synopsis

Properties

Name	The name of this RequestValidator.
RestApiId	The string identifier of the associated RestApi.
ValidateRequestBody	A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
ValidateRequestParameters	A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).

Properties

Name

The name of this RequestValidator.

virtual string Name { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name

RestApiId

The string identifier of the associated RestApi.

string RestApiId { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid

ValidateRequestBody

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

virtual object ValidateRequestBody { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody

ValidateRequestParameters

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

virtual object ValidateRequestParameters { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters