@Stability(value=Experimental)

Package software.amazon.awscdk.services.sam

AWS Serverless Application Model Construct Library

See: Description

Interface Summary

Interface	Description
CfnApi.AccessLogSettingProperty
CfnApi.AuthProperty
CfnApi.CorsConfigurationProperty
CfnApi.S3LocationProperty
CfnApiProps	Properties for defining a `AWS::Serverless::Api`.
CfnApplication.ApplicationLocationProperty
CfnApplicationProps	Properties for defining a `AWS::Serverless::Application`.
CfnFunction.AlexaSkillEventProperty
CfnFunction.ApiEventProperty
CfnFunction.BucketSAMPTProperty
CfnFunction.CloudWatchEventEventProperty
CfnFunction.CollectionSAMPTProperty
CfnFunction.DeadLetterQueueProperty
CfnFunction.DeploymentPreferenceProperty
CfnFunction.DomainSAMPTProperty
CfnFunction.DynamoDBEventProperty
CfnFunction.EmptySAMPTProperty
CfnFunction.EventSourceProperty
CfnFunction.FunctionEnvironmentProperty
CfnFunction.FunctionSAMPTProperty
CfnFunction.IAMPolicyDocumentProperty
CfnFunction.IdentitySAMPTProperty
CfnFunction.IoTRuleEventProperty
CfnFunction.KeySAMPTProperty
CfnFunction.KinesisEventProperty
CfnFunction.LogGroupSAMPTProperty
CfnFunction.QueueSAMPTProperty
CfnFunction.S3EventProperty
CfnFunction.S3KeyFilterProperty
CfnFunction.S3KeyFilterRuleProperty
CfnFunction.S3LocationProperty
CfnFunction.S3NotificationFilterProperty
CfnFunction.SAMPolicyTemplateProperty
CfnFunction.ScheduleEventProperty
CfnFunction.SNSEventProperty
CfnFunction.SQSEventProperty
CfnFunction.StateMachineSAMPTProperty
CfnFunction.StreamSAMPTProperty
CfnFunction.TableSAMPTProperty
CfnFunction.TableStreamSAMPTProperty
CfnFunction.TopicSAMPTProperty
CfnFunction.VpcConfigProperty
CfnFunctionProps	Properties for defining a `AWS::Serverless::Function`.
CfnLayerVersionProps	Properties for defining a `AWS::Serverless::LayerVersion`.
CfnSimpleTable.PrimaryKeyProperty
CfnSimpleTable.ProvisionedThroughputProperty
CfnSimpleTable.SSESpecificationProperty
CfnSimpleTableProps	Properties for defining a `AWS::Serverless::SimpleTable`.

Class Summary

Class	Description
CfnApi	A CloudFormation `AWS::Serverless::Api`.
CfnApi.AccessLogSettingProperty.Builder	A builder for CfnApi.AccessLogSettingProperty
CfnApi.AccessLogSettingProperty.Jsii$Proxy	An implementation for CfnApi.AccessLogSettingProperty
CfnApi.AuthProperty.Builder	A builder for CfnApi.AuthProperty
CfnApi.AuthProperty.Jsii$Proxy	An implementation for CfnApi.AuthProperty
CfnApi.Builder	A fluent builder for CfnApi.
CfnApi.CorsConfigurationProperty.Builder	A builder for CfnApi.CorsConfigurationProperty
CfnApi.CorsConfigurationProperty.Jsii$Proxy	An implementation for CfnApi.CorsConfigurationProperty
CfnApi.S3LocationProperty.Builder	A builder for CfnApi.S3LocationProperty
CfnApi.S3LocationProperty.Jsii$Proxy	An implementation for CfnApi.S3LocationProperty
CfnApiProps.Builder	A builder for CfnApiProps
CfnApiProps.Jsii$Proxy	An implementation for CfnApiProps
CfnApplication	A CloudFormation `AWS::Serverless::Application`.
CfnApplication.ApplicationLocationProperty.Builder	A builder for CfnApplication.ApplicationLocationProperty
CfnApplication.ApplicationLocationProperty.Jsii$Proxy	An implementation for CfnApplication.ApplicationLocationProperty
CfnApplication.Builder	A fluent builder for CfnApplication.
CfnApplicationProps.Builder	A builder for CfnApplicationProps
CfnApplicationProps.Jsii$Proxy	An implementation for CfnApplicationProps
CfnFunction	A CloudFormation `AWS::Serverless::Function`.
CfnFunction.AlexaSkillEventProperty.Builder	A builder for CfnFunction.AlexaSkillEventProperty
CfnFunction.AlexaSkillEventProperty.Jsii$Proxy	An implementation for CfnFunction.AlexaSkillEventProperty
CfnFunction.ApiEventProperty.Builder	A builder for CfnFunction.ApiEventProperty
CfnFunction.ApiEventProperty.Jsii$Proxy	An implementation for CfnFunction.ApiEventProperty
CfnFunction.BucketSAMPTProperty.Builder	A builder for CfnFunction.BucketSAMPTProperty
CfnFunction.BucketSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.BucketSAMPTProperty
CfnFunction.Builder	A fluent builder for CfnFunction.
CfnFunction.CloudWatchEventEventProperty.Builder	A builder for CfnFunction.CloudWatchEventEventProperty
CfnFunction.CloudWatchEventEventProperty.Jsii$Proxy	An implementation for CfnFunction.CloudWatchEventEventProperty
CfnFunction.CollectionSAMPTProperty.Builder	A builder for CfnFunction.CollectionSAMPTProperty
CfnFunction.CollectionSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.CollectionSAMPTProperty
CfnFunction.DeadLetterQueueProperty.Builder	A builder for CfnFunction.DeadLetterQueueProperty
CfnFunction.DeadLetterQueueProperty.Jsii$Proxy	An implementation for CfnFunction.DeadLetterQueueProperty
CfnFunction.DeploymentPreferenceProperty.Builder	A builder for CfnFunction.DeploymentPreferenceProperty
CfnFunction.DeploymentPreferenceProperty.Jsii$Proxy	An implementation for CfnFunction.DeploymentPreferenceProperty
CfnFunction.DomainSAMPTProperty.Builder	A builder for CfnFunction.DomainSAMPTProperty
CfnFunction.DomainSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.DomainSAMPTProperty
CfnFunction.DynamoDBEventProperty.Builder	A builder for CfnFunction.DynamoDBEventProperty
CfnFunction.DynamoDBEventProperty.Jsii$Proxy	An implementation for CfnFunction.DynamoDBEventProperty
CfnFunction.EmptySAMPTProperty.Builder	A builder for CfnFunction.EmptySAMPTProperty
CfnFunction.EmptySAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.EmptySAMPTProperty
CfnFunction.EventSourceProperty.Builder	A builder for CfnFunction.EventSourceProperty
CfnFunction.EventSourceProperty.Jsii$Proxy	An implementation for CfnFunction.EventSourceProperty
CfnFunction.FunctionEnvironmentProperty.Builder	A builder for CfnFunction.FunctionEnvironmentProperty
CfnFunction.FunctionEnvironmentProperty.Jsii$Proxy	An implementation for CfnFunction.FunctionEnvironmentProperty
CfnFunction.FunctionSAMPTProperty.Builder	A builder for CfnFunction.FunctionSAMPTProperty
CfnFunction.FunctionSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.FunctionSAMPTProperty
CfnFunction.IAMPolicyDocumentProperty.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
CfnFunction.IdentitySAMPTProperty.Builder	A builder for CfnFunction.IdentitySAMPTProperty
CfnFunction.IdentitySAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.IdentitySAMPTProperty
CfnFunction.IoTRuleEventProperty.Builder	A builder for CfnFunction.IoTRuleEventProperty
CfnFunction.IoTRuleEventProperty.Jsii$Proxy	An implementation for CfnFunction.IoTRuleEventProperty
CfnFunction.KeySAMPTProperty.Builder	A builder for CfnFunction.KeySAMPTProperty
CfnFunction.KeySAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.KeySAMPTProperty
CfnFunction.KinesisEventProperty.Builder	A builder for CfnFunction.KinesisEventProperty
CfnFunction.KinesisEventProperty.Jsii$Proxy	An implementation for CfnFunction.KinesisEventProperty
CfnFunction.LogGroupSAMPTProperty.Builder	A builder for CfnFunction.LogGroupSAMPTProperty
CfnFunction.LogGroupSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.LogGroupSAMPTProperty
CfnFunction.QueueSAMPTProperty.Builder	A builder for CfnFunction.QueueSAMPTProperty
CfnFunction.QueueSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.QueueSAMPTProperty
CfnFunction.S3EventProperty.Builder	A builder for CfnFunction.S3EventProperty
CfnFunction.S3EventProperty.Jsii$Proxy	An implementation for CfnFunction.S3EventProperty
CfnFunction.S3KeyFilterProperty.Builder	A builder for CfnFunction.S3KeyFilterProperty
CfnFunction.S3KeyFilterProperty.Jsii$Proxy	An implementation for CfnFunction.S3KeyFilterProperty
CfnFunction.S3KeyFilterRuleProperty.Builder	A builder for CfnFunction.S3KeyFilterRuleProperty
CfnFunction.S3KeyFilterRuleProperty.Jsii$Proxy	An implementation for CfnFunction.S3KeyFilterRuleProperty
CfnFunction.S3LocationProperty.Builder	A builder for CfnFunction.S3LocationProperty
CfnFunction.S3LocationProperty.Jsii$Proxy	An implementation for CfnFunction.S3LocationProperty
CfnFunction.S3NotificationFilterProperty.Builder	A builder for CfnFunction.S3NotificationFilterProperty
CfnFunction.S3NotificationFilterProperty.Jsii$Proxy	An implementation for CfnFunction.S3NotificationFilterProperty
CfnFunction.SAMPolicyTemplateProperty.Builder	A builder for CfnFunction.SAMPolicyTemplateProperty
CfnFunction.SAMPolicyTemplateProperty.Jsii$Proxy	An implementation for CfnFunction.SAMPolicyTemplateProperty
CfnFunction.ScheduleEventProperty.Builder	A builder for CfnFunction.ScheduleEventProperty
CfnFunction.ScheduleEventProperty.Jsii$Proxy	An implementation for CfnFunction.ScheduleEventProperty
CfnFunction.SNSEventProperty.Builder	A builder for CfnFunction.SNSEventProperty
CfnFunction.SNSEventProperty.Jsii$Proxy	An implementation for CfnFunction.SNSEventProperty
CfnFunction.SQSEventProperty.Builder	A builder for CfnFunction.SQSEventProperty
CfnFunction.SQSEventProperty.Jsii$Proxy	An implementation for CfnFunction.SQSEventProperty
CfnFunction.StateMachineSAMPTProperty.Builder	A builder for CfnFunction.StateMachineSAMPTProperty
CfnFunction.StateMachineSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.StateMachineSAMPTProperty
CfnFunction.StreamSAMPTProperty.Builder	A builder for CfnFunction.StreamSAMPTProperty
CfnFunction.StreamSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.StreamSAMPTProperty
CfnFunction.TableSAMPTProperty.Builder	A builder for CfnFunction.TableSAMPTProperty
CfnFunction.TableSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.TableSAMPTProperty
CfnFunction.TableStreamSAMPTProperty.Builder	A builder for CfnFunction.TableStreamSAMPTProperty
CfnFunction.TableStreamSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.TableStreamSAMPTProperty
CfnFunction.TopicSAMPTProperty.Builder	A builder for CfnFunction.TopicSAMPTProperty
CfnFunction.TopicSAMPTProperty.Jsii$Proxy	An implementation for CfnFunction.TopicSAMPTProperty
CfnFunction.VpcConfigProperty.Builder	A builder for CfnFunction.VpcConfigProperty
CfnFunction.VpcConfigProperty.Jsii$Proxy	An implementation for CfnFunction.VpcConfigProperty
CfnFunctionProps.Builder	A builder for CfnFunctionProps
CfnFunctionProps.Jsii$Proxy	An implementation for CfnFunctionProps
CfnLayerVersion	A CloudFormation `AWS::Serverless::LayerVersion`.
CfnLayerVersion.Builder	A fluent builder for CfnLayerVersion.
CfnLayerVersionProps.Builder	A builder for CfnLayerVersionProps
CfnLayerVersionProps.Jsii$Proxy	An implementation for CfnLayerVersionProps
CfnSimpleTable	A CloudFormation `AWS::Serverless::SimpleTable`.
CfnSimpleTable.Builder	A fluent builder for CfnSimpleTable.
CfnSimpleTable.PrimaryKeyProperty.Builder	A builder for CfnSimpleTable.PrimaryKeyProperty
CfnSimpleTable.PrimaryKeyProperty.Jsii$Proxy	An implementation for CfnSimpleTable.PrimaryKeyProperty
CfnSimpleTable.ProvisionedThroughputProperty.Builder	A builder for CfnSimpleTable.ProvisionedThroughputProperty
CfnSimpleTable.ProvisionedThroughputProperty.Jsii$Proxy	An implementation for CfnSimpleTable.ProvisionedThroughputProperty
CfnSimpleTable.SSESpecificationProperty.Builder	A builder for CfnSimpleTable.SSESpecificationProperty
CfnSimpleTable.SSESpecificationProperty.Jsii$Proxy	An implementation for CfnSimpleTable.SSESpecificationProperty
CfnSimpleTableProps.Builder	A builder for CfnSimpleTableProps
CfnSimpleTableProps.Jsii$Proxy	An implementation for CfnSimpleTableProps

Package software.amazon.awscdk.services.sam Description

AWS Serverless Application Model Construct Library

This is a developer preview (public beta) module. Releases might lack important features and might have future breaking changes.

This API is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the API is not recommended in production environments. Experimental APIs are not subject to the Semantic Versioning model.

This module includes low-level constructs that synthesize into AWS::Serverless resources.

// This example is in TypeScript, examples in Java are coming soon.
 const sam = require('@aws-cdk/aws-sam');
 

Related

The following AWS CDK modules include constructs that can be used to work with Amazon API Gateway and AWS Lambda:

• aws-lambda: define AWS Lambda functions
• aws-lambda-event-sources: classes that allow using various AWS services as event sources for AWS Lambda functions
• aws-apigateway: define APIs through Amazon API Gateway
• aws-codedeploy: define AWS Lambda deployment with traffic shifting support