Package software.amazon.awscdk.services.apigateway

Class RestApiAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.RestApiAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RestApiAttributes>

Enclosing interface:

RestApiAttributes

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

A builder for RestApiAttributes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RestApiAttributes	build()	Builds the configured instance.
RestApiAttributes.Builder	restApiId(String restApiId)	Sets the value of RestApiAttributes.getRestApiId()
RestApiAttributes.Builder	restApiName(String restApiName)	Sets the value of RestApiAttributes.getRestApiName()
RestApiAttributes.Builder	rootResourceId(String rootResourceId)	Sets the value of RestApiAttributes.getRootResourceId()

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

restApiId

@Stability(Stable)
public RestApiAttributes.Builder restApiId(String restApiId)

Sets the value of RestApiAttributes.getRestApiId()

Parameters:

restApiId - The ID of the API Gateway RestApi. This parameter is required.

Returns:

this

rootResourceId

@Stability(Stable)
public RestApiAttributes.Builder rootResourceId(String rootResourceId)

Sets the value of RestApiAttributes.getRootResourceId()

Parameters:

rootResourceId - The resource ID of the root resource. This parameter is required.

Returns:

this

restApiName

@Stability(Stable)
public RestApiAttributes.Builder restApiName(String restApiName)

Sets the value of RestApiAttributes.getRestApiName()

Parameters:

restApiName - The name of the API Gateway RestApi.

Returns:

this

build

@Stability(Stable)
public RestApiAttributes build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of RestApiAttributes

Throws:

NullPointerException - if any required attribute was not provided