Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.SAM

AWS Serverless Application Model Construct Library

--- End-of-Support
AWS CDK v1 has reached End-of-Support on 2023-06-01.
This package is no longer being updated, and users should migrate to AWS CDK v2.

For more information on how to migrate, see the Migrating to AWS CDK v2 guide.


This module is part of the AWS Cloud Development Kit project.

using Amazon.CDK.AWS.SAM;

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

    There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

    For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Serverless.

    (Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

    Classes

    CfnApi

    A CloudFormation AWS::Serverless::Api.

    CfnApi.AccessLogSettingProperty
    CfnApi.AuthProperty
    CfnApi.CanarySettingProperty
    CfnApi.CorsConfigurationProperty
    CfnApi.DomainConfigurationProperty
    CfnApi.EndpointConfigurationProperty
    CfnApi.MutualTlsAuthenticationProperty
    CfnApi.Route53ConfigurationProperty
    CfnApi.S3LocationProperty
    CfnApiProps

    Properties for defining a CfnApi.

    CfnApplication

    A CloudFormation AWS::Serverless::Application.

    CfnApplication.ApplicationLocationProperty
    CfnApplicationProps

    Properties for defining a CfnApplication.

    CfnFunction

    A CloudFormation AWS::Serverless::Function.

    CfnFunction.AlexaSkillEventProperty
    CfnFunction.ApiEventProperty
    CfnFunction.AuthProperty
    CfnFunction.AuthResourcePolicyProperty
    CfnFunction.BucketSAMPTProperty
    CfnFunction.CloudWatchEventEventProperty
    CfnFunction.CloudWatchLogsEventProperty
    CfnFunction.CognitoEventProperty
    CfnFunction.CollectionSAMPTProperty
    CfnFunction.DeadLetterQueueProperty
    CfnFunction.DeploymentPreferenceProperty
    CfnFunction.DestinationConfigProperty
    CfnFunction.DestinationProperty
    CfnFunction.DomainSAMPTProperty
    CfnFunction.DynamoDBEventProperty
    CfnFunction.EmptySAMPTProperty
    CfnFunction.EventBridgeRuleEventProperty
    CfnFunction.EventInvokeConfigProperty
    CfnFunction.EventInvokeDestinationConfigProperty
    CfnFunction.EventSourceProperty
    CfnFunction.FileSystemConfigProperty
    CfnFunction.FunctionEnvironmentProperty
    CfnFunction.FunctionSAMPTProperty
    CfnFunction.HooksProperty
    CfnFunction.HttpApiEventProperty
    CfnFunction.HttpApiFunctionAuthProperty
    CfnFunction.IAMPolicyDocumentProperty
    CfnFunction.IdentitySAMPTProperty
    CfnFunction.ImageConfigProperty
    CfnFunction.IoTRuleEventProperty
    CfnFunction.KeySAMPTProperty
    CfnFunction.KinesisEventProperty
    CfnFunction.LogGroupSAMPTProperty
    CfnFunction.ParameterNameSAMPTProperty
    CfnFunction.ProvisionedConcurrencyConfigProperty
    CfnFunction.QueueSAMPTProperty
    CfnFunction.RequestModelProperty
    CfnFunction.RequestParameterProperty
    CfnFunction.RouteSettingsProperty
    CfnFunction.S3EventProperty
    CfnFunction.S3KeyFilterProperty
    CfnFunction.S3KeyFilterRuleProperty
    CfnFunction.S3LocationProperty
    CfnFunction.S3NotificationFilterProperty
    CfnFunction.SAMPolicyTemplateProperty
    CfnFunction.ScheduleEventProperty
    CfnFunction.SecretArnSAMPTProperty
    CfnFunction.SNSEventProperty
    CfnFunction.SQSEventProperty
    CfnFunction.StateMachineSAMPTProperty
    CfnFunction.StreamSAMPTProperty
    CfnFunction.TableSAMPTProperty
    CfnFunction.TableStreamSAMPTProperty
    CfnFunction.TopicSAMPTProperty
    CfnFunction.VpcConfigProperty
    CfnFunctionProps

    Properties for defining a CfnFunction.

    CfnHttpApi

    A CloudFormation AWS::Serverless::HttpApi.

    CfnHttpApi.AccessLogSettingProperty
    CfnHttpApi.CorsConfigurationObjectProperty
    CfnHttpApi.HttpApiAuthProperty
    CfnHttpApi.HttpApiDomainConfigurationProperty
    CfnHttpApi.MutualTlsAuthenticationProperty
    CfnHttpApi.Route53ConfigurationProperty
    CfnHttpApi.RouteSettingsProperty
    CfnHttpApi.S3LocationProperty
    CfnHttpApiProps

    Properties for defining a CfnHttpApi.

    CfnLayerVersion

    A CloudFormation AWS::Serverless::LayerVersion.

    CfnLayerVersion.S3LocationProperty
    CfnLayerVersionProps

    Properties for defining a CfnLayerVersion.

    CfnSimpleTable

    A CloudFormation AWS::Serverless::SimpleTable.

    CfnSimpleTable.PrimaryKeyProperty
    CfnSimpleTable.ProvisionedThroughputProperty
    CfnSimpleTable.SSESpecificationProperty
    CfnSimpleTableProps

    Properties for defining a CfnSimpleTable.

    CfnStateMachine

    A CloudFormation AWS::Serverless::StateMachine.

    CfnStateMachine.ApiEventProperty
    CfnStateMachine.CloudWatchEventEventProperty
    CfnStateMachine.CloudWatchLogsLogGroupProperty
    CfnStateMachine.EventBridgeRuleEventProperty
    CfnStateMachine.EventSourceProperty
    CfnStateMachine.FunctionSAMPTProperty
    CfnStateMachine.IAMPolicyDocumentProperty
    CfnStateMachine.LogDestinationProperty
    CfnStateMachine.LoggingConfigurationProperty
    CfnStateMachine.S3LocationProperty
    CfnStateMachine.SAMPolicyTemplateProperty
    CfnStateMachine.ScheduleEventProperty
    CfnStateMachine.StateMachineSAMPTProperty
    CfnStateMachine.TracingConfigurationProperty
    CfnStateMachineProps

    Properties for defining a CfnStateMachine.

    Interfaces

    CfnApi.IAccessLogSettingProperty
    CfnApi.IAuthProperty
    CfnApi.ICanarySettingProperty
    CfnApi.ICorsConfigurationProperty
    CfnApi.IDomainConfigurationProperty
    CfnApi.IEndpointConfigurationProperty
    CfnApi.IMutualTlsAuthenticationProperty
    CfnApi.IRoute53ConfigurationProperty
    CfnApi.IS3LocationProperty
    CfnApplication.IApplicationLocationProperty
    CfnFunction.IAlexaSkillEventProperty
    CfnFunction.IApiEventProperty
    CfnFunction.IAuthProperty
    CfnFunction.IAuthResourcePolicyProperty
    CfnFunction.IBucketSAMPTProperty
    CfnFunction.ICloudWatchEventEventProperty
    CfnFunction.ICloudWatchLogsEventProperty
    CfnFunction.ICognitoEventProperty
    CfnFunction.ICollectionSAMPTProperty
    CfnFunction.IDeadLetterQueueProperty
    CfnFunction.IDeploymentPreferenceProperty
    CfnFunction.IDestinationConfigProperty
    CfnFunction.IDestinationProperty
    CfnFunction.IDomainSAMPTProperty
    CfnFunction.IDynamoDBEventProperty
    CfnFunction.IEmptySAMPTProperty
    CfnFunction.IEventBridgeRuleEventProperty
    CfnFunction.IEventInvokeConfigProperty
    CfnFunction.IEventInvokeDestinationConfigProperty
    CfnFunction.IEventSourceProperty
    CfnFunction.IFileSystemConfigProperty
    CfnFunction.IFunctionEnvironmentProperty
    CfnFunction.IFunctionSAMPTProperty
    CfnFunction.IHooksProperty
    CfnFunction.IHttpApiEventProperty
    CfnFunction.IHttpApiFunctionAuthProperty
    CfnFunction.IIAMPolicyDocumentProperty
    CfnFunction.IIdentitySAMPTProperty
    CfnFunction.IImageConfigProperty
    CfnFunction.IIoTRuleEventProperty
    CfnFunction.IKeySAMPTProperty
    CfnFunction.IKinesisEventProperty
    CfnFunction.ILogGroupSAMPTProperty
    CfnFunction.IParameterNameSAMPTProperty
    CfnFunction.IProvisionedConcurrencyConfigProperty
    CfnFunction.IQueueSAMPTProperty
    CfnFunction.IRequestModelProperty
    CfnFunction.IRequestParameterProperty
    CfnFunction.IRouteSettingsProperty
    CfnFunction.IS3EventProperty
    CfnFunction.IS3KeyFilterProperty
    CfnFunction.IS3KeyFilterRuleProperty
    CfnFunction.IS3LocationProperty
    CfnFunction.IS3NotificationFilterProperty
    CfnFunction.ISAMPolicyTemplateProperty
    CfnFunction.IScheduleEventProperty
    CfnFunction.ISecretArnSAMPTProperty
    CfnFunction.ISNSEventProperty
    CfnFunction.ISQSEventProperty
    CfnFunction.IStateMachineSAMPTProperty
    CfnFunction.IStreamSAMPTProperty
    CfnFunction.ITableSAMPTProperty
    CfnFunction.ITableStreamSAMPTProperty
    CfnFunction.ITopicSAMPTProperty
    CfnFunction.IVpcConfigProperty
    CfnHttpApi.IAccessLogSettingProperty
    CfnHttpApi.ICorsConfigurationObjectProperty
    CfnHttpApi.IHttpApiAuthProperty
    CfnHttpApi.IHttpApiDomainConfigurationProperty
    CfnHttpApi.IMutualTlsAuthenticationProperty
    CfnHttpApi.IRoute53ConfigurationProperty
    CfnHttpApi.IRouteSettingsProperty
    CfnHttpApi.IS3LocationProperty
    CfnLayerVersion.IS3LocationProperty
    CfnSimpleTable.IPrimaryKeyProperty
    CfnSimpleTable.IProvisionedThroughputProperty
    CfnSimpleTable.ISSESpecificationProperty
    CfnStateMachine.IApiEventProperty
    CfnStateMachine.ICloudWatchEventEventProperty
    CfnStateMachine.ICloudWatchLogsLogGroupProperty
    CfnStateMachine.IEventBridgeRuleEventProperty
    CfnStateMachine.IEventSourceProperty
    CfnStateMachine.IFunctionSAMPTProperty
    CfnStateMachine.IIAMPolicyDocumentProperty
    CfnStateMachine.ILogDestinationProperty
    CfnStateMachine.ILoggingConfigurationProperty
    CfnStateMachine.IS3LocationProperty
    CfnStateMachine.ISAMPolicyTemplateProperty
    CfnStateMachine.IScheduleEventProperty
    CfnStateMachine.IStateMachineSAMPTProperty
    CfnStateMachine.ITracingConfigurationProperty
    ICfnApiProps

    Properties for defining a CfnApi.

    ICfnApplicationProps

    Properties for defining a CfnApplication.

    ICfnFunctionProps

    Properties for defining a CfnFunction.

    ICfnHttpApiProps

    Properties for defining a CfnHttpApi.

    ICfnLayerVersionProps

    Properties for defining a CfnLayerVersion.

    ICfnSimpleTableProps

    Properties for defining a CfnSimpleTable.

    ICfnStateMachineProps

    Properties for defining a CfnStateMachine.

    Back to top Generated by DocFX