interface RestApiBaseProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.RestApiBaseProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#RestApiBaseProps
Java	software.amazon.awscdk.services.apigateway.RestApiBaseProps
Python	aws_cdk.aws_apigateway.RestApiBaseProps
TypeScript (source)	aws-cdk-lib » aws_apigateway » RestApiBaseProps

Represents the props that all Rest APIs share.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
import { aws_certificatemanager as certificatemanager } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_s3 as s3 } from 'aws-cdk-lib';

declare const accessLogDestination: apigateway.IAccessLogDestination;
declare const accessLogFormat: apigateway.AccessLogFormat;
declare const bucket: s3.Bucket;
declare const certificate: certificatemanager.Certificate;
declare const policyDocument: iam.PolicyDocument;
const restApiBaseProps: apigateway.RestApiBaseProps = {
  cloudWatchRole: false,
  cloudWatchRoleRemovalPolicy: cdk.RemovalPolicy.DESTROY,
  deploy: false,
  deployOptions: {
    accessLogDestination: accessLogDestination,
    accessLogFormat: accessLogFormat,
    cacheClusterEnabled: false,
    cacheClusterSize: 'cacheClusterSize',
    cacheDataEncrypted: false,
    cacheTtl: cdk.Duration.minutes(30),
    cachingEnabled: false,
    clientCertificateId: 'clientCertificateId',
    dataTraceEnabled: false,
    description: 'description',
    documentationVersion: 'documentationVersion',
    loggingLevel: apigateway.MethodLoggingLevel.OFF,
    methodOptions: {
      methodOptionsKey: {
        cacheDataEncrypted: false,
        cacheTtl: cdk.Duration.minutes(30),
        cachingEnabled: false,
        dataTraceEnabled: false,
        loggingLevel: apigateway.MethodLoggingLevel.OFF,
        metricsEnabled: false,
        throttlingBurstLimit: 123,
        throttlingRateLimit: 123,
      },
    },
    metricsEnabled: false,
    stageName: 'stageName',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
    tracingEnabled: false,
    variables: {
      variablesKey: 'variables',
    },
  },
  description: 'description',
  disableExecuteApiEndpoint: false,
  domainName: {
    certificate: certificate,
    domainName: 'domainName',

    // the properties below are optional
    basePath: 'basePath',
    endpointType: apigateway.EndpointType.EDGE,
    mtls: {
      bucket: bucket,
      key: 'key',

      // the properties below are optional
      version: 'version',
    },
    securityPolicy: apigateway.SecurityPolicy.TLS_1_0,
  },
  endpointExportName: 'endpointExportName',
  endpointTypes: [apigateway.EndpointType.EDGE],
  failOnWarnings: false,
  parameters: {
    parametersKey: 'parameters',
  },
  policy: policyDocument,
  restApiName: 'restApiName',
  retainDeployments: false,
};

Properties

Name	Type	Description
cloudWatchRole?	boolean	Automatically configure an AWS CloudWatch role for API Gateway.
cloudWatchRoleRemovalPolicy?	RemovalPolicy	The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
deploy?	boolean	Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
deployOptions?	StageOptions	Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.
description?	string	A description of the RestApi construct.
disableExecuteApiEndpoint?	boolean	Specifies whether clients can invoke the API using the default execute-api endpoint.
domainName?	DomainNameOptions	Configure a custom domain name and map it to this API.
endpointExportName?	string	Export name for the CfnOutput containing the API endpoint.
endpointTypes?	EndpointType[]	A list of the endpoint types of the API.
failOnWarnings?	boolean	Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
parameters?	{ [string]: string }	Custom header parameters for the request.
policy?	PolicyDocument	A policy document that contains the permissions for this RestApi.
restApiName?	string	A name for the API Gateway RestApi resource.
retainDeployments?	boolean	Retains old deployment resources when the API changes.

---

cloudWatchRole?

Type: boolean (optional, default: false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise)

Automatically configure an AWS CloudWatch role for API Gateway.

---

cloudWatchRoleRemovalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.

Requires cloudWatchRole to be enabled.

---

deploy?

Type: boolean (optional, default: true)

Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.

Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.

If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.

A CloudFormation Output will also be defined with the root URL endpoint of this REST API.

---

deployOptions?

Type: StageOptions (optional, default: Based on defaults of StageOptions.)

Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.

If deploy is disabled, this value cannot be set.

---

description?

Type: string (optional, default: 'Automatically created by the RestApi construct')

A description of the RestApi construct.

---

disableExecuteApiEndpoint?

Type: boolean (optional, default: false)

Specifies whether clients can invoke the API using the default execute-api endpoint.

To require that clients use a custom domain name to invoke the API, disable the default endpoint.

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

---

domainName?

Type: DomainNameOptions (optional, default: no domain name is defined, use addDomainName or directly define a DomainName.)

Configure a custom domain name and map it to this API.

---

endpointExportName?

Type: string (optional, default: when no export name is given, output will be created without export)

Export name for the CfnOutput containing the API endpoint.

---

endpointTypes?

Type: EndpointType[] (optional, default: EndpointType.EDGE)

A list of the endpoint types of the API.

Use this property when creating an API.

---

failOnWarnings?

Type: boolean (optional, default: false)

Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

---

parameters?

Type: { [string]: string } (optional, default: No parameters.)

Custom header parameters for the request.

See also: https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

---

policy?

Type: PolicyDocument (optional, default: No policy.)

A policy document that contains the permissions for this RestApi.

---

restApiName?

Type: string (optional, default: ID of the RestApi construct.)

A name for the API Gateway RestApi resource.

---

retainDeployments?

Type: boolean (optional, default: false)

Retains old deployment resources when the API changes.

This allows manually reverting stages to point to old deployments via the AWS Console.