software.amazon.awscdk.services.apigateway

Class Method.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.Method.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Method>

Enclosing class:

Method

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

(experimental) A fluent builder for Method.

Method Summary

Modifier and Type	Method and Description
Method	build()
static Method.Builder	create(software.constructs.Construct scope, String id)
Method.Builder	httpMethod(String httpMethod) (experimental) The HTTP method ("GET", "POST", "PUT", ...) that clients use to call this method.
Method.Builder	integration(Integration integration) (experimental) The backend system that the method calls when it receives a request.
Method.Builder	options(MethodOptions options) (experimental) Method options.
Method.Builder	resource(IResource resource) (experimental) The resource this method is associated with.

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 Method.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Method.Builder.

httpMethod

@Stability(value=Experimental)
public Method.Builder httpMethod(String httpMethod)

(experimental) The HTTP method ("GET", "POST", "PUT", ...) that clients use to call this method.

Parameters:

httpMethod - The HTTP method ("GET", "POST", "PUT", ...) that clients use to call this method. This parameter is required.

Returns:

this

resource

@Stability(value=Experimental)
public Method.Builder resource(IResource resource)

(experimental) The resource this method is associated with.

For root resource methods, specify the RestApi object.

Parameters:

resource - The resource this method is associated with. This parameter is required.

Returns:

this

integration

@Stability(value=Experimental)
public Method.Builder integration(Integration integration)

(experimental) The backend system that the method calls when it receives a request.

Default: - a new `MockIntegration`.

Parameters:

integration - The backend system that the method calls when it receives a request. This parameter is required.

Returns:

this

options

@Stability(value=Experimental)
public Method.Builder options(MethodOptions options)

(experimental) Method options.

Default: - No options.

Parameters:

options - Method options. This parameter is required.

Returns:

this

build

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

Specified by:

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