interface CfnApiProps

Language	Type name
.NET	`Amazon.CDK.AWS.SAM.CfnApiProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnApiProps`
Java	`software.amazon.awscdk.services.sam.CfnApiProps`
Python	`aws_cdk.aws_sam.CfnApiProps`
TypeScript	`aws-cdk-lib` » `aws_sam` » `CfnApiProps`

Properties for defining a CfnApi.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';

declare const authorizers: any;
declare const definitionBody: any;
declare const gatewayResponses: any;
declare const methodSettings: any;
declare const models: any;
const cfnApiProps: sam.CfnApiProps = {
  stageName: 'stageName',

  // the properties below are optional
  accessLogSetting: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  alwaysDeploy: false,
  auth: {
    addDefaultAuthorizerToCorsPreflight: false,
    authorizers: authorizers,
    defaultAuthorizer: 'defaultAuthorizer',
  },
  binaryMediaTypes: ['binaryMediaTypes'],
  cacheClusterEnabled: false,
  cacheClusterSize: 'cacheClusterSize',
  canarySetting: {
    deploymentId: 'deploymentId',
    percentTraffic: 123,
    stageVariableOverrides: {
      stageVariableOverridesKey: 'stageVariableOverrides',
    },
    useStageCache: false,
  },
  cors: 'cors',
  definitionBody: definitionBody,
  definitionUri: 'definitionUri',
  description: 'description',
  disableExecuteApiEndpoint: false,
  domain: {
    certificateArn: 'certificateArn',
    domainName: 'domainName',

    // the properties below are optional
    basePath: ['basePath'],
    endpointConfiguration: 'endpointConfiguration',
    mutualTlsAuthentication: {
      truststoreUri: 'truststoreUri',
      truststoreVersion: 'truststoreVersion',
    },
    ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
    route53: {
      distributedDomainName: 'distributedDomainName',
      evaluateTargetHealth: false,
      hostedZoneId: 'hostedZoneId',
      hostedZoneName: 'hostedZoneName',
      ipV6: false,
    },
    securityPolicy: 'securityPolicy',
  },
  endpointConfiguration: 'endpointConfiguration',
  gatewayResponses: gatewayResponses,
  methodSettings: [methodSettings],
  minimumCompressionSize: 123,
  models: models,
  name: 'name',
  openApiVersion: 'openApiVersion',
  tags: {
    tagsKey: 'tags',
  },
  tracingEnabled: false,
  variables: {
    variablesKey: 'variables',
  },
};

Properties

Name	Type	Description
stageName	`string`
accessLogSetting?	`IResolvable` `\|` `AccessLogSettingProperty`
alwaysDeploy?	`boolean \|` `IResolvable`
auth?	`IResolvable` `\|` `AuthProperty`
binaryMediaTypes?	`string[]`
cacheClusterEnabled?	`boolean \|` `IResolvable`
cacheClusterSize?	`string`
canarySetting?	`IResolvable` `\|` `CanarySettingProperty`
cors?	`string \|` `IResolvable` `\|` `CorsConfigurationProperty`
definitionBody?	`any`
definitionUri?	`string \|` `IResolvable` `\|` `S3LocationProperty`
description?	`string`
disableExecuteApiEndpoint?	`boolean \|` `IResolvable`
domain?	`IResolvable` `\|` `DomainConfigurationProperty`
endpointConfiguration?	`string \|` `IResolvable` `\|` `EndpointConfigurationProperty`
gatewayResponses?	`any`
methodSettings?	`any[] \|` `IResolvable`
minimumCompressionSize?	`number`
models?	`any`
name?	`string`
openApiVersion?	`string`
tags?	`{ [string]: string }`
tracingEnabled?	`boolean \|` `IResolvable`
variables?	`{ [string]: string } \|` `IResolvable`