Package software.amazon.awscdk.services.apigateway

Class CfnDocumentationPart.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDocumentationPart.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentationPart>

Enclosing class:

CfnDocumentationPart

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

A fluent builder for CfnDocumentationPart.

Method Summary

Modifier and Type	Method	Description
CfnDocumentationPart	build()
static CfnDocumentationPart.Builder	create(software.constructs.Construct scope, String id)
CfnDocumentationPart.Builder	location(IResolvable location)	The location of the targeted API entity of the to-be-created documentation part.
CfnDocumentationPart.Builder	location(CfnDocumentationPart.LocationProperty location)	The location of the targeted API entity of the to-be-created documentation part.
CfnDocumentationPart.Builder	properties(String properties)	The new documentation content map of the targeted API entity.
CfnDocumentationPart.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnDocumentationPart.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDocumentationPart.Builder.

location

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

The location of the targeted API entity of the to-be-created documentation part.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location

location

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

The location of the targeted API entity of the to-be-created documentation part.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location

properties

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

The new documentation content map of the targeted API entity.

Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Parameters:

properties - The new documentation content map of the targeted API entity. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties

restApiId

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

The string identifier of the associated RestApi.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid

build

@Stability(Stable)
public CfnDocumentationPart build()

Specified by:

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

Returns:

a newly built instance of CfnDocumentationPart.