class CfnDocumentationVersionPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnDocumentationVersionPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnDocumentationVersionPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDocumentationVersionPropsMixin
Python	aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDocumentationVersionPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigateway » mixins » CfnDocumentationVersionPropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API.

For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnDocumentationVersionPropsMixin = new apigateway_mixins.CfnDocumentationVersionPropsMixin({
  description: 'description',
  documentationVersion: 'documentationVersion',
  restApiId: 'restApiId',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDocumentationVersionPropsMixin(props: CfnDocumentationVersionMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDocumentationVersionMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ApiGateway::DocumentationVersion.

Properties

Name	Type	Description
props	CfnDocumentationVersionMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDocumentationVersionMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.