interface CfnApiProps

Language	Type name
.NET	Amazon.CDK.AWS.SAM.CfnApiProps
Java	software.amazon.awscdk.services.sam.CfnApiProps
Python	aws_cdk.aws_sam.CfnApiProps
TypeScript	@aws-cdk/aws-sam » CfnApiProps

Properties for defining a CfnApi.

Example

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

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',
  },
  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	AWS::Serverless::Api.StageName.
accessLogSetting?	AccessLogSettingProperty | IResolvable	AWS::Serverless::Api.AccessLogSetting.
auth?	IResolvable | AuthProperty	AWS::Serverless::Api.Auth.
binaryMediaTypes?	string[]	AWS::Serverless::Api.BinaryMediaTypes.
cacheClusterEnabled?	boolean | IResolvable	AWS::Serverless::Api.CacheClusterEnabled.
cacheClusterSize?	string	AWS::Serverless::Api.CacheClusterSize.
canarySetting?	IResolvable | CanarySettingProperty	AWS::Serverless::Api.CanarySetting.
cors?	string | IResolvable | CorsConfigurationProperty	AWS::Serverless::Api.Cors.
definitionBody?	any	AWS::Serverless::Api.DefinitionBody.
definitionUri?	string | IResolvable | S3LocationProperty	AWS::Serverless::Api.DefinitionUri.
description?	string	AWS::Serverless::Api.Description.
disableExecuteApiEndpoint?	boolean | IResolvable	AWS::Serverless::Api.DisableExecuteApiEndpoint.
domain?	IResolvable | DomainConfigurationProperty	AWS::Serverless::Api.Domain.
endpointConfiguration?	string | IResolvable | EndpointConfigurationProperty	AWS::Serverless::Api.EndpointConfiguration.
gatewayResponses?	any	AWS::Serverless::Api.GatewayResponses.
methodSettings?	any[] | IResolvable	AWS::Serverless::Api.MethodSettings.
minimumCompressionSize?	number	AWS::Serverless::Api.MinimumCompressionSize.
models?	any	AWS::Serverless::Api.Models.
name?	string	AWS::Serverless::Api.Name.
openApiVersion?	string	AWS::Serverless::Api.OpenApiVersion.
tags?	{ [string]: string }	AWS::Serverless::Api.Tags.
tracingEnabled?	boolean | IResolvable	AWS::Serverless::Api.TracingEnabled.
variables?	IResolvable | { [string]: string }	AWS::Serverless::Api.Variables.

---

stageName

Type: string

AWS::Serverless::Api.StageName.

---

accessLogSetting?

Type: AccessLogSettingProperty | IResolvable (optional)

AWS::Serverless::Api.AccessLogSetting.

---

auth?

Type: IResolvable | AuthProperty (optional)

AWS::Serverless::Api.Auth.

---

binaryMediaTypes?

Type: string[] (optional)

AWS::Serverless::Api.BinaryMediaTypes.

---

cacheClusterEnabled?

Type: boolean | IResolvable (optional)

AWS::Serverless::Api.CacheClusterEnabled.

---

cacheClusterSize?

Type: string (optional)

AWS::Serverless::Api.CacheClusterSize.

---

canarySetting?

Type: IResolvable | CanarySettingProperty (optional)

AWS::Serverless::Api.CanarySetting.

---

cors?

Type: string | IResolvable | CorsConfigurationProperty (optional)

AWS::Serverless::Api.Cors.

---

definitionBody?

Type: any (optional)

AWS::Serverless::Api.DefinitionBody.

---

definitionUri?

Type: string | IResolvable | S3LocationProperty (optional)

AWS::Serverless::Api.DefinitionUri.

---

description?

Type: string (optional)

AWS::Serverless::Api.Description.

---

disableExecuteApiEndpoint?

Type: boolean | IResolvable (optional)

AWS::Serverless::Api.DisableExecuteApiEndpoint.

---

domain?

Type: IResolvable | DomainConfigurationProperty (optional)

AWS::Serverless::Api.Domain.

---

endpointConfiguration?

Type: string | IResolvable | EndpointConfigurationProperty (optional)

AWS::Serverless::Api.EndpointConfiguration.

---

gatewayResponses?

Type: any (optional)

AWS::Serverless::Api.GatewayResponses.

---

methodSettings?

Type: any[] | IResolvable (optional)

AWS::Serverless::Api.MethodSettings.

---

minimumCompressionSize?

Type: number (optional)

AWS::Serverless::Api.MinimumCompressionSize.

---

models?

Type: any (optional)

AWS::Serverless::Api.Models.

---

name?

Type: string (optional)

AWS::Serverless::Api.Name.

---

openApiVersion?

Type: string (optional)

AWS::Serverless::Api.OpenApiVersion.

---

tags?

Type: { [string]: string } (optional)

AWS::Serverless::Api.Tags.

---

tracingEnabled?

Type: boolean | IResolvable (optional)

AWS::Serverless::Api.TracingEnabled.

---

variables?

Type: IResolvable | { [string]: string } (optional)

AWS::Serverless::Api.Variables.