Package software.amazon.awscdk.services.apigateway

Class CfnDocumentationPartProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDocumentationPartProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentationPartProps>

Enclosing interface:

CfnDocumentationPartProps

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

A builder for CfnDocumentationPartProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDocumentationPartProps	build()	Builds the configured instance.
CfnDocumentationPartProps.Builder	location(IResolvable location)	Sets the value of CfnDocumentationPartProps.getLocation()
CfnDocumentationPartProps.Builder	location(CfnDocumentationPart.LocationProperty location)	Sets the value of CfnDocumentationPartProps.getLocation()
CfnDocumentationPartProps.Builder	properties(String properties)	Sets the value of CfnDocumentationPartProps.getProperties()
CfnDocumentationPartProps.Builder	restApiId(String restApiId)	Sets the value of CfnDocumentationPartProps.getRestApiId()

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

location

@Stability(Stable)
public CfnDocumentationPartProps.Builder location(IResolvable location)

Sets the value of CfnDocumentationPartProps.getLocation()

Parameters:

location - The location of the targeted API entity of the to-be-created documentation part. This parameter is required.

Returns:

this

location

@Stability(Stable)
public CfnDocumentationPartProps.Builder location(CfnDocumentationPart.LocationProperty location)

Sets the value of CfnDocumentationPartProps.getLocation()

Parameters:

location - The location of the targeted API entity of the to-be-created documentation part. This parameter is required.

Returns:

this

properties

@Stability(Stable)
public CfnDocumentationPartProps.Builder properties(String properties)

Sets the value of CfnDocumentationPartProps.getProperties()

Parameters:

properties - The new documentation content map of the targeted API entity. This parameter is required. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Returns:

this

restApiId

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

Sets the value of CfnDocumentationPartProps.getRestApiId()

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

build

@Stability(Stable)
public CfnDocumentationPartProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDocumentationPartProps

Throws:

NullPointerException - if any required attribute was not provided