software.amazon.awscdk.services.apigateway

Class Resource.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.Resource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Resource>

Enclosing class:

Resource

@Stability(value=Experimental)
public static final class Resource.Builder
extends Object
implements software.amazon.jsii.Builder<Resource>

(experimental) A fluent builder for Resource.

Method Summary

Modifier and Type	Method and Description
Resource	build()
static Resource.Builder	create(software.constructs.Construct scope, String id)
Resource.Builder	defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions) (experimental) Adds a CORS preflight OPTIONS method to this resource and all child resources.
Resource.Builder	defaultIntegration(Integration defaultIntegration) (experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
Resource.Builder	defaultMethodOptions(MethodOptions defaultMethodOptions) (experimental) Method options to use as a default for all methods created within this API unless custom options are specified.
Resource.Builder	parent(IResource parent) (experimental) The parent resource of this resource.
Resource.Builder	pathPart(String pathPart) (experimental) A path name for the resource.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Resource.Builder create(software.constructs.Construct scope,
                                                                     String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Resource.Builder.

defaultCorsPreflightOptions

@Stability(value=Experimental)
public Resource.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)

(experimental) Adds a CORS preflight OPTIONS method to this resource and all child resources.

You can add CORS at the resource-level using addCorsPreflight.

Default: - CORS is disabled

Parameters:

defaultCorsPreflightOptions - Adds a CORS preflight OPTIONS method to this resource and all child resources. This parameter is required.

Returns:

this

defaultIntegration

@Stability(value=Experimental)
public Resource.Builder defaultIntegration(Integration defaultIntegration)

(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.

Default: - Inherited from parent.

Parameters:

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

Returns:

this

defaultMethodOptions

@Stability(value=Experimental)
public Resource.Builder defaultMethodOptions(MethodOptions defaultMethodOptions)

(experimental) Method options to use as a default for all methods created within this API unless custom options are specified.

Default: - Inherited from parent.

Parameters:

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

Returns:

this

parent

@Stability(value=Experimental)
public Resource.Builder parent(IResource parent)

(experimental) The parent resource of this resource.

You can either pass another Resource object or a RestApi object here.

Parameters:

parent - The parent resource of this resource. This parameter is required.

Returns:

this

pathPart

@Stability(value=Experimental)
public Resource.Builder pathPart(String pathPart)

(experimental) A path name for the resource.

Parameters:

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

Returns:

this

build

@Stability(value=Experimental)
public Resource build()

Specified by:

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