software.amazon.awscdk.services.apigateway

Interface CfnDocumentationVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentationVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.314Z")
 @Stability(value=Stable)
public interface CfnDocumentationVersionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGateway::DocumentationVersion`.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDocumentationVersionProps.Builder A builder for CfnDocumentationVersionProps
static class	CfnDocumentationVersionProps.Jsii$Proxy An implementation for CfnDocumentationVersionProps

Method Summary

Modifier and Type	Method and Description
static CfnDocumentationVersionProps.Builder	builder()
default String	getDescription() `AWS::ApiGateway::DocumentationVersion.Description`.
String	getDocumentationVersion() `AWS::ApiGateway::DocumentationVersion.DocumentationVersion`.
String	getRestApiId() `AWS::ApiGateway::DocumentationVersion.RestApiId`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDocumentationVersion

@Stability(value=Stable)
 @NotNull
String getDocumentationVersion()

`AWS::ApiGateway::DocumentationVersion.DocumentationVersion`.

See Also:

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

getRestApiId

@Stability(value=Stable)
 @NotNull
String getRestApiId()

`AWS::ApiGateway::DocumentationVersion.RestApiId`.

See Also:

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

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::ApiGateway::DocumentationVersion.Description`.

See Also:

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

builder

@Stability(value=Stable)
static CfnDocumentationVersionProps.Builder builder()

Returns:

a CfnDocumentationVersionProps.Builder of CfnDocumentationVersionProps