Package software.amazon.awscdk.services.apigateway

Class CfnDocumentationVersion.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDocumentationVersion.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentationVersion>

Enclosing class:

CfnDocumentationVersion

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

A fluent builder for CfnDocumentationVersion.

Method Summary

Modifier and Type	Method	Description
CfnDocumentationVersion	build()
static CfnDocumentationVersion.Builder	create(software.constructs.Construct scope, String id)
CfnDocumentationVersion.Builder	description(String description)	A description about the new documentation snapshot.
CfnDocumentationVersion.Builder	documentationVersion(String documentationVersion)	The version identifier of the to-be-updated documentation version.
CfnDocumentationVersion.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 CfnDocumentationVersion.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 CfnDocumentationVersion.Builder.

documentationVersion

@Stability(Stable)
public CfnDocumentationVersion.Builder documentationVersion(String documentationVersion)

The version identifier of the to-be-updated documentation version.

Parameters:

documentationVersion - The version identifier of the to-be-updated documentation version. This parameter is required.

Returns:

this

See Also:

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

restApiId

@Stability(Stable)
public CfnDocumentationVersion.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-documentationversion.html#cfn-apigateway-documentationversion-restapiid

description

@Stability(Stable)
public CfnDocumentationVersion.Builder description(String description)

A description about the new documentation snapshot.

Parameters:

description - A description about the new documentation snapshot. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnDocumentationVersion build()

Specified by:

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

Returns:

a newly built instance of CfnDocumentationVersion.