Package software.amazon.awscdk.services.apigateway

Class ProxyResourceProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.ProxyResourceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ProxyResourceProps>

Enclosing interface:

ProxyResourceProps

@Stability(Stable)
public static final class ProxyResourceProps.Builder
extends Object
implements software.amazon.jsii.Builder<ProxyResourceProps>

A builder for ProxyResourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ProxyResourceProps.Builder	anyMethod(Boolean anyMethod)	Sets the value of ProxyResourceOptions.getAnyMethod()
ProxyResourceProps	build()	Builds the configured instance.
ProxyResourceProps.Builder	defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)	Sets the value of ResourceOptions.getDefaultCorsPreflightOptions()
ProxyResourceProps.Builder	defaultIntegration(Integration defaultIntegration)	Sets the value of ResourceOptions.getDefaultIntegration()
ProxyResourceProps.Builder	defaultMethodOptions(MethodOptions defaultMethodOptions)	Sets the value of ResourceOptions.getDefaultMethodOptions()
ProxyResourceProps.Builder	parent(IResource parent)	Sets the value of ProxyResourceProps.getParent()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

parent

@Stability(Stable)
public ProxyResourceProps.Builder parent(IResource parent)

Sets the value of ProxyResourceProps.getParent()

Parameters:

parent - The parent resource of this resource. This parameter is required. You can either pass another Resource object or a RestApi object here.

Returns:

this

anyMethod

@Stability(Stable)
public ProxyResourceProps.Builder anyMethod(Boolean anyMethod)

Sets the value of ProxyResourceOptions.getAnyMethod()

Parameters:

anyMethod - Adds an "ANY" method to this resource. If set to false, you will have to explicitly add methods to this resource after it's created.

Returns:

this

defaultCorsPreflightOptions

@Stability(Stable)
public ProxyResourceProps.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)

Sets the value of ResourceOptions.getDefaultCorsPreflightOptions()

Parameters:

defaultCorsPreflightOptions - Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using addCorsPreflight.

Returns:

this

defaultIntegration

@Stability(Stable)
public ProxyResourceProps.Builder defaultIntegration(Integration defaultIntegration)

Sets the value of ResourceOptions.getDefaultIntegration()

Parameters:

defaultIntegration - An integration to use as a default for all methods created within this API unless an integration is specified.

Returns:

this

defaultMethodOptions

@Stability(Stable)
public ProxyResourceProps.Builder defaultMethodOptions(MethodOptions defaultMethodOptions)

Sets the value of ResourceOptions.getDefaultMethodOptions()

Parameters:

defaultMethodOptions - Method options to use as a default for all methods created within this API unless custom options are specified.

Returns:

this

build

@Stability(Stable)
public ProxyResourceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ProxyResourceProps

Throws:

NullPointerException - if any required attribute was not provided