Package software.amazon.awscdk.services.sam
package software.amazon.awscdk.services.sam
AWS Serverless Application Model Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.sam.*;
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for Serverless construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Serverless resources directly.
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.)
-
ClassDescriptionA reference to a Api resource.A builder for
ApiReferenceAn implementation forApiReferenceA reference to a Application resource.A builder forApplicationReferenceAn implementation forApplicationReferencehttps://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi.Example:A builder forCfnApi.AccessLogSettingPropertyAn implementation forCfnApi.AccessLogSettingPropertyExample:A builder forCfnApi.AuthPropertyAn implementation forCfnApi.AuthPropertyA fluent builder forCfnApi.Example:A builder forCfnApi.CanarySettingPropertyAn implementation forCfnApi.CanarySettingPropertyExample:A builder forCfnApi.CorsConfigurationPropertyAn implementation forCfnApi.CorsConfigurationPropertyExample:A builder forCfnApi.DomainConfigurationPropertyAn implementation forCfnApi.DomainConfigurationPropertyExample:A builder forCfnApi.EndpointConfigurationPropertyAn implementation forCfnApi.EndpointConfigurationPropertyExample:A builder forCfnApi.MutualTlsAuthenticationPropertyAn implementation forCfnApi.MutualTlsAuthenticationPropertyExample:A builder forCfnApi.Route53ConfigurationPropertyAn implementation forCfnApi.Route53ConfigurationPropertyExample:A builder forCfnApi.S3LocationPropertyAn implementation forCfnApi.S3LocationPropertyProperties for defining aCfnApi.A builder forCfnApiPropsAn implementation forCfnApiPropshttps://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapplication.Example:A builder forCfnApplication.ApplicationLocationPropertyAn implementation forCfnApplication.ApplicationLocationPropertyA fluent builder forCfnApplication.Properties for defining aCfnApplication.A builder forCfnApplicationPropsAn implementation forCfnApplicationPropshttps://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction.Example:A builder forCfnFunction.AlexaSkillEventPropertyAn implementation forCfnFunction.AlexaSkillEventPropertyExample:A builder forCfnFunction.ApiEventPropertyAn implementation forCfnFunction.ApiEventPropertyExample:A builder forCfnFunction.AuthPropertyAn implementation forCfnFunction.AuthPropertyExample:A builder forCfnFunction.AuthResourcePolicyPropertyAn implementation forCfnFunction.AuthResourcePolicyPropertyExample:A builder forCfnFunction.BucketSAMPTPropertyAn implementation forCfnFunction.BucketSAMPTPropertyA fluent builder forCfnFunction.Example:A builder forCfnFunction.CloudWatchEventEventPropertyAn implementation forCfnFunction.CloudWatchEventEventPropertyExample:A builder forCfnFunction.CloudWatchLogsEventPropertyAn implementation forCfnFunction.CloudWatchLogsEventPropertyExample:A builder forCfnFunction.CognitoEventPropertyAn implementation forCfnFunction.CognitoEventPropertyExample:A builder forCfnFunction.CollectionSAMPTPropertyAn implementation forCfnFunction.CollectionSAMPTPropertyExample:A builder forCfnFunction.CorsConfigurationPropertyAn implementation forCfnFunction.CorsConfigurationPropertyExample:A builder forCfnFunction.DeadLetterQueuePropertyAn implementation forCfnFunction.DeadLetterQueuePropertyExample:A builder forCfnFunction.DeploymentPreferencePropertyAn implementation forCfnFunction.DeploymentPreferencePropertyExample:A builder forCfnFunction.DestinationConfigPropertyAn implementation forCfnFunction.DestinationConfigPropertyExample:A builder forCfnFunction.DestinationPropertyAn implementation forCfnFunction.DestinationPropertyExample:A builder forCfnFunction.DomainSAMPTPropertyAn implementation forCfnFunction.DomainSAMPTPropertyExample:A builder forCfnFunction.DynamoDBEventPropertyAn implementation forCfnFunction.DynamoDBEventPropertyExample:A builder forCfnFunction.EmptySAMPTPropertyAn implementation forCfnFunction.EmptySAMPTPropertyExample:A builder forCfnFunction.EphemeralStoragePropertyAn implementation forCfnFunction.EphemeralStoragePropertyExample:A builder forCfnFunction.EventBridgeRuleEventPropertyAn implementation forCfnFunction.EventBridgeRuleEventPropertyExample:A builder forCfnFunction.EventInvokeConfigPropertyAn implementation forCfnFunction.EventInvokeConfigPropertyExample:A builder forCfnFunction.EventInvokeDestinationConfigPropertyAn implementation forCfnFunction.EventInvokeDestinationConfigPropertyExample:A builder forCfnFunction.EventSourcePropertyAn implementation forCfnFunction.EventSourcePropertyExample:A builder forCfnFunction.FileSystemConfigPropertyAn implementation forCfnFunction.FileSystemConfigPropertyExample:A builder forCfnFunction.FunctionEnvironmentPropertyAn implementation forCfnFunction.FunctionEnvironmentPropertyExample:A builder forCfnFunction.FunctionSAMPTPropertyAn implementation forCfnFunction.FunctionSAMPTPropertyExample:A builder forCfnFunction.FunctionUrlConfigPropertyAn implementation forCfnFunction.FunctionUrlConfigPropertyExample:A builder forCfnFunction.HooksPropertyAn implementation forCfnFunction.HooksPropertyExample:A builder forCfnFunction.HttpApiEventPropertyAn implementation forCfnFunction.HttpApiEventPropertyExample:A builder forCfnFunction.HttpApiFunctionAuthPropertyAn implementation forCfnFunction.HttpApiFunctionAuthPropertyExample:A builder forCfnFunction.IAMPolicyDocumentPropertyAn implementation forCfnFunction.IAMPolicyDocumentPropertyExample:A builder forCfnFunction.IdentitySAMPTPropertyAn implementation forCfnFunction.IdentitySAMPTPropertyExample:A builder forCfnFunction.ImageConfigPropertyAn implementation forCfnFunction.ImageConfigPropertyExample:A builder forCfnFunction.IoTRuleEventPropertyAn implementation forCfnFunction.IoTRuleEventPropertyExample:A builder forCfnFunction.KeySAMPTPropertyAn implementation forCfnFunction.KeySAMPTPropertyExample:A builder forCfnFunction.KinesisEventPropertyAn implementation forCfnFunction.KinesisEventPropertyExample:A builder forCfnFunction.LogGroupSAMPTPropertyAn implementation forCfnFunction.LogGroupSAMPTPropertyExample:A builder forCfnFunction.ParameterNameSAMPTPropertyAn implementation forCfnFunction.ParameterNameSAMPTPropertyExample:A builder forCfnFunction.ProvisionedConcurrencyConfigPropertyAn implementation forCfnFunction.ProvisionedConcurrencyConfigPropertyExample:A builder forCfnFunction.QueueSAMPTPropertyAn implementation forCfnFunction.QueueSAMPTPropertyExample:A builder forCfnFunction.RequestModelPropertyAn implementation forCfnFunction.RequestModelPropertyExample:A builder forCfnFunction.RequestParameterPropertyAn implementation forCfnFunction.RequestParameterPropertyExample:A builder forCfnFunction.RouteSettingsPropertyAn implementation forCfnFunction.RouteSettingsPropertyExample:A builder forCfnFunction.S3EventPropertyAn implementation forCfnFunction.S3EventPropertyExample:A builder forCfnFunction.S3KeyFilterPropertyAn implementation forCfnFunction.S3KeyFilterPropertyExample:A builder forCfnFunction.S3KeyFilterRulePropertyAn implementation forCfnFunction.S3KeyFilterRulePropertyExample:A builder forCfnFunction.S3LocationPropertyAn implementation forCfnFunction.S3LocationPropertyExample:A builder forCfnFunction.S3NotificationFilterPropertyAn implementation forCfnFunction.S3NotificationFilterPropertyExample:A builder forCfnFunction.SAMPolicyTemplatePropertyAn implementation forCfnFunction.SAMPolicyTemplatePropertyExample:A builder forCfnFunction.ScheduleEventPropertyAn implementation forCfnFunction.ScheduleEventPropertyExample:A builder forCfnFunction.SecretArnSAMPTPropertyAn implementation forCfnFunction.SecretArnSAMPTPropertyExample:A builder forCfnFunction.SNSEventPropertyAn implementation forCfnFunction.SNSEventPropertyExample:A builder forCfnFunction.SQSEventPropertyAn implementation forCfnFunction.SQSEventPropertyExample:A builder forCfnFunction.StateMachineSAMPTPropertyAn implementation forCfnFunction.StateMachineSAMPTPropertyExample:A builder forCfnFunction.StreamSAMPTPropertyAn implementation forCfnFunction.StreamSAMPTPropertyExample:A builder forCfnFunction.TableSAMPTPropertyAn implementation forCfnFunction.TableSAMPTPropertyExample:A builder forCfnFunction.TableStreamSAMPTPropertyAn implementation forCfnFunction.TableStreamSAMPTPropertyExample:A builder forCfnFunction.TopicSAMPTPropertyAn implementation forCfnFunction.TopicSAMPTPropertyExample:A builder forCfnFunction.VpcConfigPropertyAn implementation forCfnFunction.VpcConfigPropertyProperties for defining aCfnFunction.A builder forCfnFunctionPropsAn implementation forCfnFunctionPropshttps://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi.Example:A builder forCfnHttpApi.AccessLogSettingPropertyAn implementation forCfnHttpApi.AccessLogSettingPropertyA fluent builder forCfnHttpApi.Example:A builder forCfnHttpApi.CorsConfigurationObjectPropertyAn implementation forCfnHttpApi.CorsConfigurationObjectPropertyExample:A builder forCfnHttpApi.HttpApiAuthPropertyAn implementation forCfnHttpApi.HttpApiAuthPropertyExample:A builder forCfnHttpApi.HttpApiDomainConfigurationPropertyAn implementation forCfnHttpApi.HttpApiDomainConfigurationPropertyExample:A builder forCfnHttpApi.MutualTlsAuthenticationPropertyAn implementation forCfnHttpApi.MutualTlsAuthenticationPropertyExample:A builder forCfnHttpApi.Route53ConfigurationPropertyAn implementation forCfnHttpApi.Route53ConfigurationPropertyExample:A builder forCfnHttpApi.RouteSettingsPropertyAn implementation forCfnHttpApi.RouteSettingsPropertyExample:A builder forCfnHttpApi.S3LocationPropertyAn implementation forCfnHttpApi.S3LocationPropertyProperties for defining aCfnHttpApi.A builder forCfnHttpApiPropsAn implementation forCfnHttpApiPropshttps://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesslayerversion.A fluent builder forCfnLayerVersion.Example:A builder forCfnLayerVersion.S3LocationPropertyAn implementation forCfnLayerVersion.S3LocationPropertyProperties for defining aCfnLayerVersion.A builder forCfnLayerVersionPropsAn implementation forCfnLayerVersionPropshttps://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesssimpletable.A fluent builder forCfnSimpleTable.Example:A builder forCfnSimpleTable.PrimaryKeyPropertyAn implementation forCfnSimpleTable.PrimaryKeyPropertyExample:A builder forCfnSimpleTable.ProvisionedThroughputPropertyAn implementation forCfnSimpleTable.ProvisionedThroughputPropertyExample:A builder forCfnSimpleTable.SSESpecificationPropertyAn implementation forCfnSimpleTable.SSESpecificationPropertyProperties for defining aCfnSimpleTable.A builder forCfnSimpleTablePropsAn implementation forCfnSimpleTablePropshttps://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html.Example:A builder forCfnStateMachine.ApiEventPropertyAn implementation forCfnStateMachine.ApiEventPropertyA fluent builder forCfnStateMachine.Example:A builder forCfnStateMachine.CloudWatchEventEventPropertyAn implementation forCfnStateMachine.CloudWatchEventEventPropertyExample:A builder forCfnStateMachine.CloudWatchLogsLogGroupPropertyAn implementation forCfnStateMachine.CloudWatchLogsLogGroupPropertyExample:A builder forCfnStateMachine.EventBridgeRuleEventPropertyAn implementation forCfnStateMachine.EventBridgeRuleEventPropertyExample:A builder forCfnStateMachine.EventSourcePropertyAn implementation forCfnStateMachine.EventSourcePropertyExample:A builder forCfnStateMachine.FunctionSAMPTPropertyAn implementation forCfnStateMachine.FunctionSAMPTPropertyExample:A builder forCfnStateMachine.IAMPolicyDocumentPropertyAn implementation forCfnStateMachine.IAMPolicyDocumentPropertyExample:A builder forCfnStateMachine.LogDestinationPropertyAn implementation forCfnStateMachine.LogDestinationPropertyExample:A builder forCfnStateMachine.LoggingConfigurationPropertyAn implementation forCfnStateMachine.LoggingConfigurationPropertyExample:A builder forCfnStateMachine.S3LocationPropertyAn implementation forCfnStateMachine.S3LocationPropertyExample:A builder forCfnStateMachine.SAMPolicyTemplatePropertyAn implementation forCfnStateMachine.SAMPolicyTemplatePropertyExample:A builder forCfnStateMachine.ScheduleEventPropertyAn implementation forCfnStateMachine.ScheduleEventPropertyExample:A builder forCfnStateMachine.StateMachineSAMPTPropertyAn implementation forCfnStateMachine.StateMachineSAMPTPropertyExample:A builder forCfnStateMachine.TracingConfigurationPropertyAn implementation forCfnStateMachine.TracingConfigurationPropertyProperties for defining aCfnStateMachine.A builder forCfnStateMachinePropsAn implementation forCfnStateMachinePropsA reference to a Function resource.A builder forFunctionReferenceAn implementation forFunctionReferenceA reference to a HttpApi resource.A builder forHttpApiReferenceAn implementation forHttpApiReference(experimental) Indicates that this resource can be referenced as a Api.Internal default implementation forIApiRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Application.Internal default implementation forIApplicationRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Function.Internal default implementation forIFunctionRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a HttpApi.Internal default implementation forIHttpApiRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a LayerVersion.Internal default implementation forILayerVersionRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a SimpleTable.Internal default implementation forISimpleTableRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a StateMachine.Internal default implementation forIStateMachineRef.A proxy class which represents a concrete javascript instance of this type.A reference to a LayerVersion resource.A builder forLayerVersionReferenceAn implementation forLayerVersionReferenceA reference to a SimpleTable resource.A builder forSimpleTableReferenceAn implementation forSimpleTableReferenceA reference to a StateMachine resource.A builder forStateMachineReferenceAn implementation forStateMachineReference