software.amazon.awsconstructs.services.wafwebaclapigateway

Class WafwebaclToApiGateway.Builder

java.lang.Object

software.amazon.awsconstructs.services.wafwebaclapigateway.WafwebaclToApiGateway.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WafwebaclToApiGateway>

Enclosing class:

WafwebaclToApiGateway

public static final class WafwebaclToApiGateway.Builder
extends Object
implements software.amazon.jsii.Builder<WafwebaclToApiGateway>

A fluent builder for WafwebaclToApiGateway.

Method Summary

Modifier and Type	Method and Description
WafwebaclToApiGateway	build()
static WafwebaclToApiGateway.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
WafwebaclToApiGateway.Builder	existingApiGatewayInterface(software.amazon.awscdk.services.apigateway.IRestApi existingApiGatewayInterface) The existing API Gateway instance that will be protected with the WAF web ACL.
WafwebaclToApiGateway.Builder	existingWebaclObj(software.amazon.awscdk.services.wafv2.CfnWebACL existingWebaclObj) Existing instance of a WAF web ACL, an error will occur if this and props is set.
WafwebaclToApiGateway.Builder	webaclProps(software.amazon.awscdk.services.wafv2.CfnWebACLProps webaclProps) Optional user-provided props to override the default props for the AWS WAF web ACL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static WafwebaclToApiGateway.Builder create(software.amazon.awscdk.core.Construct scope,
                                                   String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of WafwebaclToApiGateway.Builder.

existingApiGatewayInterface

public WafwebaclToApiGateway.Builder existingApiGatewayInterface(software.amazon.awscdk.services.apigateway.IRestApi existingApiGatewayInterface)

The existing API Gateway instance that will be protected with the WAF web ACL.

Parameters:

existingApiGatewayInterface - The existing API Gateway instance that will be protected with the WAF web ACL. This parameter is required.

Returns:

this

existingWebaclObj

public WafwebaclToApiGateway.Builder existingWebaclObj(software.amazon.awscdk.services.wafv2.CfnWebACL existingWebaclObj)

Existing instance of a WAF web ACL, an error will occur if this and props is set.

Parameters:

existingWebaclObj - Existing instance of a WAF web ACL, an error will occur if this and props is set. This parameter is required.

Returns:

this

webaclProps

public WafwebaclToApiGateway.Builder webaclProps(software.amazon.awscdk.services.wafv2.CfnWebACLProps webaclProps)

Optional user-provided props to override the default props for the AWS WAF web ACL.

Default: - Default properties are used.

Parameters:

webaclProps - Optional user-provided props to override the default props for the AWS WAF web ACL. This parameter is required.

Returns:

this

build

public WafwebaclToApiGateway build()

Specified by:

build in interface software.amazon.jsii.Builder<WafwebaclToApiGateway>