Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnDocumentationVersionPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDocumentationVersionPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentationVersionPropsMixin>

Enclosing class:

CfnDocumentationVersionPropsMixin

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

A fluent builder for CfnDocumentationVersionPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDocumentationVersionPropsMixin	build()
static CfnDocumentationVersionPropsMixin.Builder	create()
static CfnDocumentationVersionPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDocumentationVersionPropsMixin.Builder	description(String description)	A description about the new documentation snapshot.
CfnDocumentationVersionPropsMixin.Builder	documentationVersion(String documentationVersion)	The version identifier of the to-be-updated documentation version.
CfnDocumentationVersionPropsMixin.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnDocumentationVersionPropsMixin.Builder	restApiId(IRestApiRef 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 CfnDocumentationVersionPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDocumentationVersionPropsMixin.Builder.

create

@Stability(Stable)
public static CfnDocumentationVersionPropsMixin.Builder create()

Returns:

a new instance of CfnDocumentationVersionPropsMixin.Builder.

description

@Stability(Stable)
public CfnDocumentationVersionPropsMixin.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

documentationVersion

@Stability(Stable)
public CfnDocumentationVersionPropsMixin.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 CfnDocumentationVersionPropsMixin.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

restApiId

@Stability(Stable)
public CfnDocumentationVersionPropsMixin.Builder restApiId(IRestApiRef 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

build

@Stability(Stable)
public CfnDocumentationVersionPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnDocumentationVersionPropsMixin.