class CfnRestApiPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway.CfnRestApiPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsapigateway#CfnRestApiPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnRestApiPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_apigateway.CfnRestApiPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_apigateway » CfnRestApiPropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::RestApi resource creates a REST API.

For more information, see restapi:create in the Amazon API Gateway REST API Reference .

On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative , becoming the foundation of the OpenAPI Specification.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const body: any;
declare const mergeStrategy: cdk.IMergeStrategy;
declare const policy: any;
const cfnRestApiPropsMixin = new apigateway.CfnRestApiPropsMixin({
  apiKeySourceType: 'apiKeySourceType',
  binaryMediaTypes: ['binaryMediaTypes'],
  body: body,
  bodyS3Location: {
    bucket: 'bucket',
    eTag: 'eTag',
    key: 'key',
    version: 'version',
  },
  cloneFrom: 'cloneFrom',
  description: 'description',
  disableExecuteApiEndpoint: false,
  endpointAccessMode: 'endpointAccessMode',
  endpointConfiguration: {
    ipAddressType: 'ipAddressType',
    types: ['types'],
    vpcEndpointIds: ['vpcEndpointIds'],
  },
  failOnWarnings: false,
  minimumCompressionSize: 123,
  mode: 'mode',
  name: 'name',
  parameters: {
    parametersKey: 'parameters',
  },
  policy: policy,
  securityPolicy: 'securityPolicy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnRestApiPropsMixin(props: CfnRestApiMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

Name	Type	Description
props	CfnRestApiMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnRestApiMixinProps

---

strategy

Type: IMergeStrategy

---

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): void

Parameters

• construct 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.