Package software.amazon.awscdk.services.apigateway

Class MethodProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.MethodProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MethodProps>

Enclosing interface:

MethodProps

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

A builder for MethodProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MethodProps	build()	Builds the configured instance.
MethodProps.Builder	httpMethod(String httpMethod)	Sets the value of MethodProps.getHttpMethod()
MethodProps.Builder	integration(Integration integration)	Sets the value of MethodProps.getIntegration()
MethodProps.Builder	options(MethodOptions options)	Sets the value of MethodProps.getOptions()
MethodProps.Builder	resource(IResource resource)	Sets the value of MethodProps.getResource()

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

httpMethod

@Stability(Stable)
public MethodProps.Builder httpMethod(String httpMethod)

Sets the value of MethodProps.getHttpMethod()

Parameters:

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

Returns:

this

resource

@Stability(Stable)
public MethodProps.Builder resource(IResource resource)

Sets the value of MethodProps.getResource()

Parameters:

resource - The resource this method is associated with. This parameter is required. For root resource methods, specify the RestApi object.

Returns:

this

integration

@Stability(Stable)
public MethodProps.Builder integration(Integration integration)

Sets the value of MethodProps.getIntegration()

Parameters:

integration - The backend system that the method calls when it receives a request.

Returns:

this

options

@Stability(Stable)
public MethodProps.Builder options(MethodOptions options)

Sets the value of MethodProps.getOptions()

Parameters:

options - Method options.

Returns:

this

build

@Stability(Stable)
public MethodProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of MethodProps

Throws:

NullPointerException - if any required attribute was not provided