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

Class CfnDocumentationPartPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentationPartPropsMixin>

Enclosing class:

CfnDocumentationPartPropsMixin

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

A fluent builder for CfnDocumentationPartPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDocumentationPartPropsMixin	build()
static CfnDocumentationPartPropsMixin.Builder	create()
static CfnDocumentationPartPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDocumentationPartPropsMixin.Builder	location(CfnDocumentationPartPropsMixin.LocationProperty location)	The location of the targeted API entity of the to-be-created documentation part.
CfnDocumentationPartPropsMixin.Builder	location(IResolvable location)	The location of the targeted API entity of the to-be-created documentation part.
CfnDocumentationPartPropsMixin.Builder	properties(String properties)	The new documentation content map of the targeted API entity.
CfnDocumentationPartPropsMixin.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnDocumentationPartPropsMixin.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 CfnDocumentationPartPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDocumentationPartPropsMixin.Builder.

create

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

Returns:

a new instance of CfnDocumentationPartPropsMixin.Builder.

location

@Stability(Stable)
public CfnDocumentationPartPropsMixin.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 CfnDocumentationPartPropsMixin.Builder location(CfnDocumentationPartPropsMixin.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 CfnDocumentationPartPropsMixin.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 CfnDocumentationPartPropsMixin.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

restApiId

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

build

@Stability(Stable)
public CfnDocumentationPartPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnDocumentationPartPropsMixin.