CfnFunction

class aws_cdk.aws_sam.CfnFunction(scope, id, *, code_uri, handler, runtime, auto_publish_alias=None, dead_letter_queue=None, deployment_preference=None, description=None, environment=None, events=None, file_system_configs=None, function_name=None, kms_key_arn=None, layers=None, memory_size=None, permissions_boundary=None, policies=None, provisioned_concurrency_config=None, reserved_concurrent_executions=None, role=None, tags=None, timeout=None, tracing=None, vpc_config=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Serverless::Function.

CloudformationResource

AWS::Serverless::Function

Link

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

Create a new AWS::Serverless::Function.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • code_uri (Union[str, IResolvable, S3LocationProperty]) – AWS::Serverless::Function.CodeUri.

  • handler (str) – AWS::Serverless::Function.Handler.

  • runtime (str) – AWS::Serverless::Function.Runtime.

  • auto_publish_alias (Optional[str]) – AWS::Serverless::Function.AutoPublishAlias.

  • dead_letter_queue (Union[IResolvable, DeadLetterQueueProperty, None]) – AWS::Serverless::Function.DeadLetterQueue.

  • deployment_preference (Union[IResolvable, DeploymentPreferenceProperty, None]) – AWS::Serverless::Function.DeploymentPreference.

  • description (Optional[str]) – AWS::Serverless::Function.Description.

  • environment (Union[IResolvable, FunctionEnvironmentProperty, None]) – AWS::Serverless::Function.Environment.

  • events (Union[IResolvable, Mapping[str, Union[IResolvable, EventSourceProperty]], None]) – AWS::Serverless::Function.Events.

  • file_system_configs (Union[IResolvable, Sequence[Union[IResolvable, FileSystemConfigProperty]], None]) – AWS::Serverless::Function.FileSystemConfigs.

  • function_name (Optional[str]) – AWS::Serverless::Function.FunctionName.

  • kms_key_arn (Optional[str]) – AWS::Serverless::Function.KmsKeyArn.

  • layers (Optional[Sequence[str]]) – AWS::Serverless::Function.Layers.

  • memory_size (Union[int, float, None]) – AWS::Serverless::Function.MemorySize.

  • permissions_boundary (Optional[str]) – AWS::Serverless::Function.PermissionsBoundary.

  • policies (Union[str, IResolvable, IAMPolicyDocumentProperty, Sequence[Union[str, IResolvable, IAMPolicyDocumentProperty, SAMPolicyTemplateProperty]], None]) – AWS::Serverless::Function.Policies.

  • provisioned_concurrency_config (Union[IResolvable, ProvisionedConcurrencyConfigProperty, None]) – AWS::Serverless::Function.ProvisionedConcurrencyConfig.

  • reserved_concurrent_executions (Union[int, float, None]) – AWS::Serverless::Function.ReservedConcurrentExecutions.

  • role (Optional[str]) – AWS::Serverless::Function.Role.

  • tags (Optional[Mapping[str, str]]) – AWS::Serverless::Function.Tags.

  • timeout (Union[int, float, None]) – AWS::Serverless::Function.Timeout.

  • tracing (Optional[str]) – AWS::Serverless::Function.Tracing.

  • vpc_config (Union[IResolvable, VpcConfigProperty, None]) – AWS::Serverless::Function.VpcConfig.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Serverless::Function'
REQUIRED_TRANSFORM = 'AWS::Serverless-2016-10-31'
auto_publish_alias

AWS::Serverless::Function.AutoPublishAlias.

Link

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

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

code_uri

AWS::Serverless::Function.CodeUri.

Link

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

Return type

Union[str, IResolvable, S3LocationProperty]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

dead_letter_queue

AWS::Serverless::Function.DeadLetterQueue.

Link

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

Return type

Union[IResolvable, DeadLetterQueueProperty, None]

deployment_preference

AWS::Serverless::Function.DeploymentPreference.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

Return type

Union[IResolvable, DeploymentPreferenceProperty, None]

description

AWS::Serverless::Function.Description.

Link

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

Return type

Optional[str]

environment

AWS::Serverless::Function.Environment.

Link

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

Return type

Union[IResolvable, FunctionEnvironmentProperty, None]

events

AWS::Serverless::Function.Events.

Link

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

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, EventSourceProperty]], None]

file_system_configs

AWS::Serverless::Function.FileSystemConfigs.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html

Return type

Union[IResolvable, List[Union[IResolvable, FileSystemConfigProperty]], None]

function_name

AWS::Serverless::Function.FunctionName.

Link

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

Return type

Optional[str]

handler

AWS::Serverless::Function.Handler.

Link

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

Return type

str

kms_key_arn

AWS::Serverless::Function.KmsKeyArn.

Link

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

Return type

Optional[str]

layers

AWS::Serverless::Function.Layers.

Link

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

Return type

Optional[List[str]]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

memory_size

AWS::Serverless::Function.MemorySize.

Link

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

Return type

Union[int, float, None]

node

The construct tree node associated with this construct.

Return type

ConstructNode

permissions_boundary

AWS::Serverless::Function.PermissionsBoundary.

Link

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

Return type

Optional[str]

policies

AWS::Serverless::Function.Policies.

Link

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

Return type

Union[str, IResolvable, IAMPolicyDocumentProperty, List[Union[str, IResolvable, IAMPolicyDocumentProperty, SAMPolicyTemplateProperty]], None]

provisioned_concurrency_config

AWS::Serverless::Function.ProvisionedConcurrencyConfig.

Link

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

Return type

Union[IResolvable, ProvisionedConcurrencyConfigProperty, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

reserved_concurrent_executions

AWS::Serverless::Function.ReservedConcurrentExecutions.

Link

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

Return type

Union[int, float, None]

role

AWS::Serverless::Function.Role.

Link

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

Return type

Optional[str]

runtime

AWS::Serverless::Function.Runtime.

Link

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

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::Serverless::Function.Tags.

Link

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

Return type

TagManager

timeout

AWS::Serverless::Function.Timeout.

Link

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

Return type

Union[int, float, None]

tracing

AWS::Serverless::Function.Tracing.

Link

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

Return type

Optional[str]

vpc_config

AWS::Serverless::Function.VpcConfig.

Link

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

Return type

Union[IResolvable, VpcConfigProperty, None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AlexaSkillEventProperty

class CfnFunction.AlexaSkillEventProperty(*, variables=None)

Bases: object

Parameters

variables (Union[IResolvable, Mapping[str, str], None]) – CfnFunction.AlexaSkillEventProperty.Variables.

Link

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

Attributes

variables

CfnFunction.AlexaSkillEventProperty.Variables.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

ApiEventProperty

class CfnFunction.ApiEventProperty(*, method, path, rest_api_id=None)

Bases: object

Parameters
  • method (str) – CfnFunction.ApiEventProperty.Method.

  • path (str) – CfnFunction.ApiEventProperty.Path.

  • rest_api_id (Optional[str]) – CfnFunction.ApiEventProperty.RestApiId.

Link

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

Attributes

method

CfnFunction.ApiEventProperty.Method.

Link

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

Return type

str

path

CfnFunction.ApiEventProperty.Path.

Link

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

Return type

str

rest_api_id

CfnFunction.ApiEventProperty.RestApiId.

Link

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

Return type

Optional[str]

BucketSAMPTProperty

class CfnFunction.BucketSAMPTProperty(*, bucket_name)

Bases: object

Parameters

bucket_name (str) – CfnFunction.BucketSAMPTProperty.BucketName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

bucket_name

CfnFunction.BucketSAMPTProperty.BucketName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

CloudWatchEventEventProperty

class CfnFunction.CloudWatchEventEventProperty(*, pattern, input=None, input_path=None)

Bases: object

Parameters
  • pattern (Any) – CfnFunction.CloudWatchEventEventProperty.Pattern.

  • input (Optional[str]) – CfnFunction.CloudWatchEventEventProperty.Input.

  • input_path (Optional[str]) – CfnFunction.CloudWatchEventEventProperty.InputPath.

Link

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

Attributes

input

CfnFunction.CloudWatchEventEventProperty.Input.

Link

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

Return type

Optional[str]

input_path

CfnFunction.CloudWatchEventEventProperty.InputPath.

Link

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

Return type

Optional[str]

pattern

CfnFunction.CloudWatchEventEventProperty.Pattern.

Link

http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html

Return type

Any

CloudWatchLogsEventProperty

class CfnFunction.CloudWatchLogsEventProperty(*, filter_pattern, log_group_name)

Bases: object

Parameters
  • filter_pattern (str) – CfnFunction.CloudWatchLogsEventProperty.FilterPattern.

  • log_group_name (str) – CfnFunction.CloudWatchLogsEventProperty.LogGroupName.

Link

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

Attributes

filter_pattern

CfnFunction.CloudWatchLogsEventProperty.FilterPattern.

Link

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

Return type

str

log_group_name

CfnFunction.CloudWatchLogsEventProperty.LogGroupName.

Link

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

Return type

str

CollectionSAMPTProperty

class CfnFunction.CollectionSAMPTProperty(*, collection_id)

Bases: object

Parameters

collection_id (str) – CfnFunction.CollectionSAMPTProperty.CollectionId.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

collection_id

CfnFunction.CollectionSAMPTProperty.CollectionId.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

DeadLetterQueueProperty

class CfnFunction.DeadLetterQueueProperty(*, target_arn, type)

Bases: object

Parameters
  • target_arn (str) – CfnFunction.DeadLetterQueueProperty.TargetArn.

  • type (str) – CfnFunction.DeadLetterQueueProperty.Type.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deadletterqueue-object

Attributes

target_arn

CfnFunction.DeadLetterQueueProperty.TargetArn.

Link

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

Return type

str

type

CfnFunction.DeadLetterQueueProperty.Type.

Link

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

Return type

str

DeploymentPreferenceProperty

class CfnFunction.DeploymentPreferenceProperty(*, enabled, type, alarms=None, hooks=None)

Bases: object

Parameters
  • enabled (Union[bool, IResolvable]) – CfnFunction.DeploymentPreferenceProperty.Enabled.

  • type (str) – CfnFunction.DeploymentPreferenceProperty.Type.

  • alarms (Optional[Sequence[str]]) – CfnFunction.DeploymentPreferenceProperty.Alarms.

  • hooks (Optional[Sequence[str]]) – CfnFunction.DeploymentPreferenceProperty.Hooks.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/safe_lambda_deployments.rst

Attributes

alarms

CfnFunction.DeploymentPreferenceProperty.Alarms.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

Return type

Optional[List[str]]

enabled

CfnFunction.DeploymentPreferenceProperty.Enabled.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

Return type

Union[bool, IResolvable]

hooks

CfnFunction.DeploymentPreferenceProperty.Hooks.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

Return type

Optional[List[str]]

type

CfnFunction.DeploymentPreferenceProperty.Type.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#deploymentpreference-object

Return type

str

DestinationConfigProperty

class CfnFunction.DestinationConfigProperty(*, on_failure)

Bases: object

Parameters

on_failure (Union[IResolvable, OnFailureProperty]) – CfnFunction.DestinationConfigProperty.OnFailure.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#destination-config-object

Attributes

on_failure

CfnFunction.DestinationConfigProperty.OnFailure.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#destination-config-object

Return type

Union[IResolvable, OnFailureProperty]

DomainSAMPTProperty

class CfnFunction.DomainSAMPTProperty(*, domain_name)

Bases: object

Parameters

domain_name (str) – CfnFunction.DomainSAMPTProperty.DomainName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

domain_name

CfnFunction.DomainSAMPTProperty.DomainName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

DynamoDBEventProperty

class CfnFunction.DynamoDBEventProperty(*, starting_position, stream, batch_size=None, bisect_batch_on_function_error=None, destination_config=None, enabled=None, maximum_batching_window_in_seconds=None, maximum_record_age_in_seconds=None, maximum_retry_attempts=None, parallelization_factor=None)

Bases: object

Parameters
  • starting_position (str) – CfnFunction.DynamoDBEventProperty.StartingPosition.

  • stream (str) – CfnFunction.DynamoDBEventProperty.Stream.

  • batch_size (Union[int, float, None]) – CfnFunction.DynamoDBEventProperty.BatchSize.

  • bisect_batch_on_function_error (Union[bool, IResolvable, None]) – CfnFunction.DynamoDBEventProperty.BisectBatchOnFunctionError.

  • destination_config (Union[IResolvable, DestinationConfigProperty, None]) – CfnFunction.DynamoDBEventProperty.DestinationConfig.

  • enabled (Union[bool, IResolvable, None]) – CfnFunction.DynamoDBEventProperty.Enabled.

  • maximum_batching_window_in_seconds (Union[int, float, None]) – CfnFunction.DynamoDBEventProperty.MaximumBatchingWindowInSeconds.

  • maximum_record_age_in_seconds (Union[int, float, None]) – CfnFunction.DynamoDBEventProperty.MaximumRecordAgeInSeconds.

  • maximum_retry_attempts (Union[int, float, None]) – CfnFunction.DynamoDBEventProperty.MaximumRetryAttempts.

  • parallelization_factor (Union[int, float, None]) – CfnFunction.DynamoDBEventProperty.ParallelizationFactor.

Link

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

Attributes

batch_size

CfnFunction.DynamoDBEventProperty.BatchSize.

Link

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

Return type

Union[int, float, None]

bisect_batch_on_function_error

CfnFunction.DynamoDBEventProperty.BisectBatchOnFunctionError.

Link

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

Return type

Union[bool, IResolvable, None]

destination_config

CfnFunction.DynamoDBEventProperty.DestinationConfig.

Link

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

Return type

Union[IResolvable, DestinationConfigProperty, None]

enabled

CfnFunction.DynamoDBEventProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable, None]

maximum_batching_window_in_seconds

CfnFunction.DynamoDBEventProperty.MaximumBatchingWindowInSeconds.

Link

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

Return type

Union[int, float, None]

maximum_record_age_in_seconds

CfnFunction.DynamoDBEventProperty.MaximumRecordAgeInSeconds.

Link

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

Return type

Union[int, float, None]

maximum_retry_attempts

CfnFunction.DynamoDBEventProperty.MaximumRetryAttempts.

Link

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

Return type

Union[int, float, None]

parallelization_factor

CfnFunction.DynamoDBEventProperty.ParallelizationFactor.

Link

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

Return type

Union[int, float, None]

starting_position

CfnFunction.DynamoDBEventProperty.StartingPosition.

Link

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

Return type

str

stream

CfnFunction.DynamoDBEventProperty.Stream.

Link

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

Return type

str

EmptySAMPTProperty

class CfnFunction.EmptySAMPTProperty

Bases: object

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

EventBridgeRuleEventProperty

class CfnFunction.EventBridgeRuleEventProperty(*, pattern, event_bus_name=None, input=None, input_path=None)

Bases: object

Parameters
  • pattern (Any) – CfnFunction.EventBridgeRuleEventProperty.Pattern.

  • event_bus_name (Optional[str]) – CfnFunction.EventBridgeRuleEventProperty.EventBusName.

  • input (Optional[str]) – CfnFunction.EventBridgeRuleEventProperty.Input.

  • input_path (Optional[str]) – CfnFunction.EventBridgeRuleEventProperty.InputPath.

Link

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

Attributes

event_bus_name

CfnFunction.EventBridgeRuleEventProperty.EventBusName.

Link

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

Return type

Optional[str]

input

CfnFunction.EventBridgeRuleEventProperty.Input.

Link

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

Return type

Optional[str]

input_path

CfnFunction.EventBridgeRuleEventProperty.InputPath.

Link

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

Return type

Optional[str]

pattern

CfnFunction.EventBridgeRuleEventProperty.Pattern.

Link

https://docs.aws.amazon.com/eventbridge/latest/userguide/filtering-examples-structure.html

Return type

Any

FileSystemConfigProperty

class CfnFunction.FileSystemConfigProperty(*, arn=None, local_mount_path=None)

Bases: object

Parameters
  • arn (Optional[str]) – CfnFunction.FileSystemConfigProperty.Arn.

  • local_mount_path (Optional[str]) – CfnFunction.FileSystemConfigProperty.LocalMountPath.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html#cfn-lambda-function-filesystemconfig-localmountpath

Attributes

arn

CfnFunction.FileSystemConfigProperty.Arn.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html#cfn-lambda-function-filesystemconfig-localmountpath

Return type

Optional[str]

local_mount_path

CfnFunction.FileSystemConfigProperty.LocalMountPath.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html#cfn-lambda-function-filesystemconfig-localmountpath

Return type

Optional[str]

FunctionEnvironmentProperty

class CfnFunction.FunctionEnvironmentProperty(*, variables)

Bases: object

Parameters

variables (Union[IResolvable, Mapping[str, str]]) – CfnFunction.FunctionEnvironmentProperty.Variables.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#environment-object

Attributes

variables

CfnFunction.FunctionEnvironmentProperty.Variables.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#environment-object

Return type

Union[IResolvable, Mapping[str, str]]

FunctionSAMPTProperty

class CfnFunction.FunctionSAMPTProperty(*, function_name)

Bases: object

Parameters

function_name (str) – CfnFunction.FunctionSAMPTProperty.FunctionName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

function_name

CfnFunction.FunctionSAMPTProperty.FunctionName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

IAMPolicyDocumentProperty

class CfnFunction.IAMPolicyDocumentProperty(*args, **kwds)

Bases: typing_extensions.Protocol

Link

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html

Link

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html

Attributes

statement

CfnFunction.IAMPolicyDocumentProperty.Statement.

Link

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html

Return type

Any

IdentitySAMPTProperty

class CfnFunction.IdentitySAMPTProperty(*, identity_name)

Bases: object

Parameters

identity_name (str) – CfnFunction.IdentitySAMPTProperty.IdentityName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

identity_name

CfnFunction.IdentitySAMPTProperty.IdentityName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

IoTRuleEventProperty

class CfnFunction.IoTRuleEventProperty(*, sql, aws_iot_sql_version=None)

Bases: object

Parameters
  • sql (str) – CfnFunction.IoTRuleEventProperty.Sql.

  • aws_iot_sql_version (Optional[str]) – CfnFunction.IoTRuleEventProperty.AwsIotSqlVersion.

Link

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

Attributes

aws_iot_sql_version

CfnFunction.IoTRuleEventProperty.AwsIotSqlVersion.

Link

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

Return type

Optional[str]

sql

CfnFunction.IoTRuleEventProperty.Sql.

Link

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

Return type

str

KeySAMPTProperty

class CfnFunction.KeySAMPTProperty(*, key_id)

Bases: object

Parameters

key_id (str) – CfnFunction.KeySAMPTProperty.KeyId.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

key_id

CfnFunction.KeySAMPTProperty.KeyId.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

KinesisEventProperty

class CfnFunction.KinesisEventProperty(*, starting_position, stream, batch_size=None, enabled=None)

Bases: object

Parameters
  • starting_position (str) – CfnFunction.KinesisEventProperty.StartingPosition.

  • stream (str) – CfnFunction.KinesisEventProperty.Stream.

  • batch_size (Union[int, float, None]) – CfnFunction.KinesisEventProperty.BatchSize.

  • enabled (Union[bool, IResolvable, None]) – CfnFunction.KinesisEventProperty.Enabled.

Link

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

Attributes

batch_size

CfnFunction.KinesisEventProperty.BatchSize.

Link

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

Return type

Union[int, float, None]

enabled

CfnFunction.KinesisEventProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable, None]

starting_position

CfnFunction.KinesisEventProperty.StartingPosition.

Link

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

Return type

str

stream

CfnFunction.KinesisEventProperty.Stream.

Link

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

Return type

str

LogGroupSAMPTProperty

class CfnFunction.LogGroupSAMPTProperty(*, log_group_name)

Bases: object

Parameters

log_group_name (str) – CfnFunction.LogGroupSAMPTProperty.LogGroupName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

log_group_name

CfnFunction.LogGroupSAMPTProperty.LogGroupName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

OnFailureProperty

class CfnFunction.OnFailureProperty(*, destination, type=None)

Bases: object

Parameters
  • destination (str) – CfnFunction.OnFailureProperty.Destination.

  • type (Optional[str]) – CfnFunction.OnFailureProperty.Type.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#destination-config-object

Attributes

destination

CfnFunction.OnFailureProperty.Destination.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#destination-config-object

Return type

str

type

CfnFunction.OnFailureProperty.Type.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#destination-config-object

Return type

Optional[str]

ProvisionedConcurrencyConfigProperty

class CfnFunction.ProvisionedConcurrencyConfigProperty(*, provisioned_concurrent_executions)

Bases: object

Parameters

provisioned_concurrent_executions (str) – CfnFunction.ProvisionedConcurrencyConfigProperty.ProvisionedConcurrentExecutions.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#provisioned-concurrency-config-object

Attributes

provisioned_concurrent_executions

CfnFunction.ProvisionedConcurrencyConfigProperty.ProvisionedConcurrentExecutions.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#provisioned-concurrency-config-object

Return type

str

QueueSAMPTProperty

class CfnFunction.QueueSAMPTProperty(*, queue_name)

Bases: object

Parameters

queue_name (str) – CfnFunction.QueueSAMPTProperty.QueueName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

queue_name

CfnFunction.QueueSAMPTProperty.QueueName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

S3EventProperty

class CfnFunction.S3EventProperty(*, bucket, events, filter=None)

Bases: object

Parameters
Link

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

Attributes

bucket

CfnFunction.S3EventProperty.Bucket.

Link

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

Return type

str

events

CfnFunction.S3EventProperty.Events.

Link

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

Return type

Union[str, IResolvable, List[str]]

filter

CfnFunction.S3EventProperty.Filter.

Link

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

Return type

Union[IResolvable, S3NotificationFilterProperty, None]

S3KeyFilterProperty

class CfnFunction.S3KeyFilterProperty(*, rules)

Bases: object

Parameters

rules (Union[IResolvable, Sequence[Union[IResolvable, S3KeyFilterRuleProperty]]]) – CfnFunction.S3KeyFilterProperty.Rules.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html

Attributes

rules

CfnFunction.S3KeyFilterProperty.Rules.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html

Return type

Union[IResolvable, List[Union[IResolvable, S3KeyFilterRuleProperty]]]

S3KeyFilterRuleProperty

class CfnFunction.S3KeyFilterRuleProperty(*, name, value)

Bases: object

Parameters
  • name (str) – CfnFunction.S3KeyFilterRuleProperty.Name.

  • value (str) – CfnFunction.S3KeyFilterRuleProperty.Value.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html

Attributes

name

CfnFunction.S3KeyFilterRuleProperty.Name.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html

Return type

str

value

CfnFunction.S3KeyFilterRuleProperty.Value.

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html

Return type

str

S3LocationProperty

class CfnFunction.S3LocationProperty(*, bucket, key, version=None)

Bases: object

Parameters
  • bucket (str) – CfnFunction.S3LocationProperty.Bucket.

  • key (str) – CfnFunction.S3LocationProperty.Key.

  • version (Union[int, float, None]) – CfnFunction.S3LocationProperty.Version.

Link

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3-location-object

Attributes

bucket

CfnFunction.S3LocationProperty.Bucket.

Link

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

Return type

str

key

CfnFunction.S3LocationProperty.Key.

Link

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

Return type

str

version

CfnFunction.S3LocationProperty.Version.

Link

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

Return type

Union[int, float, None]

S3NotificationFilterProperty

class CfnFunction.S3NotificationFilterProperty(*, s3_key)

Bases: object

Parameters

s3_key (Union[IResolvable, S3KeyFilterProperty]) – CfnFunction.S3NotificationFilterProperty.S3Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html

Attributes

s3_key

CfnFunction.S3NotificationFilterProperty.S3Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html

Return type

Union[IResolvable, S3KeyFilterProperty]

SAMPolicyTemplateProperty

class CfnFunction.SAMPolicyTemplateProperty(*, ami_describe_policy=None, cloud_formation_describe_stacks_policy=None, cloud_watch_put_metric_policy=None, dynamo_db_crud_policy=None, dynamo_db_read_policy=None, dynamo_db_stream_read_policy=None, ec2_describe_policy=None, elasticsearch_http_post_policy=None, filter_log_events_policy=None, kinesis_crud_policy=None, kinesis_stream_read_policy=None, kms_decrypt_policy=None, lambda_invoke_policy=None, rekognition_detect_only_policy=None, rekognition_labels_policy=None, rekognition_no_data_access_policy=None, rekognition_read_policy=None, rekognition_write_only_access_policy=None, s3_crud_policy=None, s3_read_policy=None, ses_bulk_templated_crud_policy=None, ses_crud_policy=None, ses_email_template_crud_policy=None, ses_send_bounce_policy=None, sns_crud_policy=None, sns_publish_message_policy=None, sqs_poller_policy=None, sqs_send_message_policy=None, step_functions_execution_policy=None, vpc_access_policy=None)

Bases: object

Parameters
Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

ami_describe_policy

CfnFunction.SAMPolicyTemplateProperty.AMIDescribePolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, EmptySAMPTProperty, None]

cloud_formation_describe_stacks_policy

CfnFunction.SAMPolicyTemplateProperty.CloudFormationDescribeStacksPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, EmptySAMPTProperty, None]

cloud_watch_put_metric_policy

CfnFunction.SAMPolicyTemplateProperty.CloudWatchPutMetricPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, EmptySAMPTProperty, None]

dynamo_db_crud_policy

CfnFunction.SAMPolicyTemplateProperty.DynamoDBCrudPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, TableSAMPTProperty, None]

dynamo_db_read_policy

CfnFunction.SAMPolicyTemplateProperty.DynamoDBReadPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, TableSAMPTProperty, None]

dynamo_db_stream_read_policy

CfnFunction.SAMPolicyTemplateProperty.DynamoDBStreamReadPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, TableStreamSAMPTProperty, None]

ec2_describe_policy

CfnFunction.SAMPolicyTemplateProperty.EC2DescribePolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, EmptySAMPTProperty, None]

elasticsearch_http_post_policy

CfnFunction.SAMPolicyTemplateProperty.ElasticsearchHttpPostPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, DomainSAMPTProperty, None]

filter_log_events_policy

CfnFunction.SAMPolicyTemplateProperty.FilterLogEventsPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, LogGroupSAMPTProperty, None]

kinesis_crud_policy

CfnFunction.SAMPolicyTemplateProperty.KinesisCrudPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, StreamSAMPTProperty, None]

kinesis_stream_read_policy

CfnFunction.SAMPolicyTemplateProperty.KinesisStreamReadPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, StreamSAMPTProperty, None]

kms_decrypt_policy

CfnFunction.SAMPolicyTemplateProperty.KMSDecryptPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, KeySAMPTProperty, None]

lambda_invoke_policy

CfnFunction.SAMPolicyTemplateProperty.LambdaInvokePolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, FunctionSAMPTProperty, None]

rekognition_detect_only_policy

CfnFunction.SAMPolicyTemplateProperty.RekognitionDetectOnlyPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, EmptySAMPTProperty, None]

rekognition_labels_policy

CfnFunction.SAMPolicyTemplateProperty.RekognitionLabelsPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, EmptySAMPTProperty, None]

rekognition_no_data_access_policy

CfnFunction.SAMPolicyTemplateProperty.RekognitionNoDataAccessPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, CollectionSAMPTProperty, None]

rekognition_read_policy

CfnFunction.SAMPolicyTemplateProperty.RekognitionReadPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, CollectionSAMPTProperty, None]

rekognition_write_only_access_policy

CfnFunction.SAMPolicyTemplateProperty.RekognitionWriteOnlyAccessPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, CollectionSAMPTProperty, None]

s3_crud_policy

CfnFunction.SAMPolicyTemplateProperty.S3CrudPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, BucketSAMPTProperty, None]

s3_read_policy

CfnFunction.SAMPolicyTemplateProperty.S3ReadPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, BucketSAMPTProperty, None]

ses_bulk_templated_crud_policy

CfnFunction.SAMPolicyTemplateProperty.SESBulkTemplatedCrudPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, IdentitySAMPTProperty, None]

ses_crud_policy

CfnFunction.SAMPolicyTemplateProperty.SESCrudPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, IdentitySAMPTProperty, None]

ses_email_template_crud_policy

CfnFunction.SAMPolicyTemplateProperty.SESEmailTemplateCrudPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, EmptySAMPTProperty, None]

ses_send_bounce_policy

CfnFunction.SAMPolicyTemplateProperty.SESSendBouncePolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, IdentitySAMPTProperty, None]

sns_crud_policy

CfnFunction.SAMPolicyTemplateProperty.SNSCrudPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, TopicSAMPTProperty, None]

sns_publish_message_policy

CfnFunction.SAMPolicyTemplateProperty.SNSPublishMessagePolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, TopicSAMPTProperty, None]

sqs_poller_policy

CfnFunction.SAMPolicyTemplateProperty.SQSPollerPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, QueueSAMPTProperty, None]

sqs_send_message_policy

CfnFunction.SAMPolicyTemplateProperty.SQSSendMessagePolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, QueueSAMPTProperty, None]

step_functions_execution_policy

CfnFunction.SAMPolicyTemplateProperty.StepFunctionsExecutionPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, StateMachineSAMPTProperty, None]

vpc_access_policy

CfnFunction.SAMPolicyTemplateProperty.VPCAccessPolicy.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

Union[IResolvable, EmptySAMPTProperty, None]

SNSEventProperty

class CfnFunction.SNSEventProperty(*, topic)

Bases: object

Parameters

topic (str) – CfnFunction.SNSEventProperty.Topic.

Link

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

Attributes

topic

CfnFunction.SNSEventProperty.Topic.

Link

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

Return type

str

SQSEventProperty

class CfnFunction.SQSEventProperty(*, queue, batch_size=None, enabled=None)

Bases: object

Parameters
  • queue (str) – CfnFunction.SQSEventProperty.Queue.

  • batch_size (Union[int, float, None]) – CfnFunction.SQSEventProperty.BatchSize.

  • enabled (Union[bool, IResolvable, None]) – CfnFunction.SQSEventProperty.Enabled.

Link

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

Attributes

batch_size

CfnFunction.SQSEventProperty.BatchSize.

Link

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

Return type

Union[int, float, None]

enabled

CfnFunction.SQSEventProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable, None]

queue

CfnFunction.SQSEventProperty.Queue.

Link

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

Return type

str

ScheduleEventProperty

class CfnFunction.ScheduleEventProperty(*, schedule, input=None)

Bases: object

Parameters
  • schedule (str) – CfnFunction.ScheduleEventProperty.Schedule.

  • input (Optional[str]) – CfnFunction.ScheduleEventProperty.Input.

Link

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

Attributes

input

CfnFunction.ScheduleEventProperty.Input.

Link

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

Return type

Optional[str]

schedule

CfnFunction.ScheduleEventProperty.Schedule.

Link

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

Return type

str

StateMachineSAMPTProperty

class CfnFunction.StateMachineSAMPTProperty(*, state_machine_name)

Bases: object

Parameters

state_machine_name (str) – CfnFunction.StateMachineSAMPTProperty.StateMachineName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

state_machine_name

CfnFunction.StateMachineSAMPTProperty.StateMachineName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

StreamSAMPTProperty

class CfnFunction.StreamSAMPTProperty(*, stream_name)

Bases: object

Parameters

stream_name (str) – CfnFunction.StreamSAMPTProperty.StreamName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

stream_name

CfnFunction.StreamSAMPTProperty.StreamName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

TableSAMPTProperty

class CfnFunction.TableSAMPTProperty(*, table_name)

Bases: object

Parameters

table_name (str) – CfnFunction.TableSAMPTProperty.TableName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

table_name

CfnFunction.TableSAMPTProperty.TableName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

TableStreamSAMPTProperty

class CfnFunction.TableStreamSAMPTProperty(*, stream_name, table_name)

Bases: object

Parameters
  • stream_name (str) – CfnFunction.TableStreamSAMPTProperty.StreamName.

  • table_name (str) – CfnFunction.TableStreamSAMPTProperty.TableName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

stream_name

CfnFunction.TableStreamSAMPTProperty.StreamName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

table_name

CfnFunction.TableStreamSAMPTProperty.TableName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

TopicSAMPTProperty

class CfnFunction.TopicSAMPTProperty(*, topic_name)

Bases: object

Parameters

topic_name (str) – CfnFunction.TopicSAMPTProperty.TopicName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Attributes

topic_name

CfnFunction.TopicSAMPTProperty.TopicName.

Link

https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst

Return type

str

VpcConfigProperty

class CfnFunction.VpcConfigProperty(*, security_group_ids, subnet_ids)

Bases: object

Parameters
  • security_group_ids (Sequence[str]) – CfnFunction.VpcConfigProperty.SecurityGroupIds.

  • subnet_ids (Sequence[str]) – CfnFunction.VpcConfigProperty.SubnetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html

Attributes

security_group_ids

CfnFunction.VpcConfigProperty.SecurityGroupIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html

Return type

List[str]

subnet_ids

CfnFunction.VpcConfigProperty.SubnetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html

Return type

List[str]