Package software.amazon.awscdk.services.apigateway

Class ResourceProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.ResourceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ResourceProps>

Enclosing interface:

ResourceProps

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

A builder for ResourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ResourceProps	build()	Builds the configured instance.
ResourceProps.Builder	defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)	Sets the value of ResourceOptions.getDefaultCorsPreflightOptions()
ResourceProps.Builder	defaultIntegration(Integration defaultIntegration)	Sets the value of ResourceOptions.getDefaultIntegration()
ResourceProps.Builder	defaultMethodOptions(MethodOptions defaultMethodOptions)	Sets the value of ResourceOptions.getDefaultMethodOptions()
ResourceProps.Builder	parent(IResource parent)	Sets the value of ResourceProps.getParent()
ResourceProps.Builder	pathPart(String pathPart)	Sets the value of ResourceProps.getPathPart()

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 ResourceProps.Builder parent(IResource parent)

Sets the value of ResourceProps.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

pathPart

@Stability(Stable)
public ResourceProps.Builder pathPart(String pathPart)

Sets the value of ResourceProps.getPathPart()

Parameters:

pathPart - A path name for the resource. This parameter is required.

Returns:

this

defaultCorsPreflightOptions

@Stability(Stable)
public ResourceProps.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 ResourceProps.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 ResourceProps.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 ResourceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ResourceProps

Throws:

NullPointerException - if any required attribute was not provided