class CfnHttpApiPropsMixin

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.SAM.CfnHttpApiPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awssam#CfnHttpApiPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.sam.CfnHttpApiPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_sam.CfnHttpApiPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_sam » CfnHttpApiPropsMixin

Implements IMixin

Extends Mixin

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const authorizers: any;
declare const definitionBody: any;
declare const mergeStrategy: cdk.IMergeStrategy;
const cfnHttpApiPropsMixin = new sam.CfnHttpApiPropsMixin({
  accessLogSetting: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  auth: {
    authorizers: authorizers,
    defaultAuthorizer: 'defaultAuthorizer',
  },
  corsConfiguration: false,
  defaultRouteSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  definitionBody: definitionBody,
  definitionUri: 'definitionUri',
  description: 'description',
  disableExecuteApiEndpoint: false,
  domain: {
    basePath: 'basePath',
    certificateArn: 'certificateArn',
    domainName: 'domainName',
    endpointConfiguration: 'endpointConfiguration',
    mutualTlsAuthentication: {
      truststoreUri: 'truststoreUri',
      truststoreVersion: false,
    },
    route53: {
      distributedDomainName: 'distributedDomainName',
      evaluateTargetHealth: false,
      hostedZoneId: 'hostedZoneId',
      hostedZoneName: 'hostedZoneName',
      ipV6: false,
    },
    securityPolicy: 'securityPolicy',
  },
  failOnWarnings: false,
  routeSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  stageName: 'stageName',
  stageVariables: {
    stageVariablesKey: 'stageVariables',
  },
  tags: {
    tagsKey: 'tags',
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnHttpApiPropsMixin(props: CfnHttpApiMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::Serverless::HttpApi.

Properties

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

---

props

Type: CfnHttpApiMixinProps

---

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.