CfnFunction

class aws_cdk.aws_sam.CfnFunction(scope, id, *, architectures=None, assume_role_policy_document=None, auto_publish_alias=None, auto_publish_code_sha256=None, code_signing_config_arn=None, code_uri=None, dead_letter_queue=None, deployment_preference=None, description=None, environment=None, ephemeral_storage=None, event_invoke_config=None, events=None, file_system_configs=None, function_name=None, function_url_config=None, handler=None, image_config=None, image_uri=None, inline_code=None, kms_key_arn=None, layers=None, memory_size=None, package_type=None, permissions_boundary=None, policies=None, provisioned_concurrency_config=None, reserved_concurrent_executions=None, role=None, runtime=None, tags=None, timeout=None, tracing=None, version_description=None, vpc_config=None)

Bases: CfnResource

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html

CloudformationResource:

AWS::Serverless::Function

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

# assume_role_policy_document: Any

cfn_function = sam.CfnFunction(self, "MyCfnFunction",
    architectures=["architectures"],
    assume_role_policy_document=assume_role_policy_document,
    auto_publish_alias="autoPublishAlias",
    auto_publish_code_sha256="autoPublishCodeSha256",
    code_signing_config_arn="codeSigningConfigArn",
    code_uri="codeUri",
    dead_letter_queue=sam.CfnFunction.DeadLetterQueueProperty(
        target_arn="targetArn",
        type="type"
    ),
    deployment_preference=sam.CfnFunction.DeploymentPreferenceProperty(
        alarms=["alarms"],
        enabled=False,
        hooks=sam.CfnFunction.HooksProperty(
            post_traffic="postTraffic",
            pre_traffic="preTraffic"
        ),
        role="role",
        type="type"
    ),
    description="description",
    environment=sam.CfnFunction.FunctionEnvironmentProperty(
        variables={
            "variables_key": "variables"
        }
    ),
    ephemeral_storage=sam.CfnFunction.EphemeralStorageProperty(
        size=123
    ),
    event_invoke_config=sam.CfnFunction.EventInvokeConfigProperty(
        destination_config=sam.CfnFunction.EventInvokeDestinationConfigProperty(
            on_failure=sam.CfnFunction.DestinationProperty(
                destination="destination",

                # the properties below are optional
                type="type"
            ),
            on_success=sam.CfnFunction.DestinationProperty(
                destination="destination",

                # the properties below are optional
                type="type"
            )
        ),
        maximum_event_age_in_seconds=123,
        maximum_retry_attempts=123
    ),
    events={
        "events_key": sam.CfnFunction.EventSourceProperty(
            properties=sam.CfnFunction.AlexaSkillEventProperty(
                skill_id="skillId"
            ),
            type="type"
        )
    },
    file_system_configs=[sam.CfnFunction.FileSystemConfigProperty(
        arn="arn",
        local_mount_path="localMountPath"
    )],
    function_name="functionName",
    function_url_config=sam.CfnFunction.FunctionUrlConfigProperty(
        auth_type="authType",

        # the properties below are optional
        cors="cors",
        invoke_mode="invokeMode"
    ),
    handler="handler",
    image_config=sam.CfnFunction.ImageConfigProperty(
        command=["command"],
        entry_point=["entryPoint"],
        working_directory="workingDirectory"
    ),
    image_uri="imageUri",
    inline_code="inlineCode",
    kms_key_arn="kmsKeyArn",
    layers=["layers"],
    memory_size=123,
    package_type="packageType",
    permissions_boundary="permissionsBoundary",
    policies="policies",
    provisioned_concurrency_config=sam.CfnFunction.ProvisionedConcurrencyConfigProperty(
        provisioned_concurrent_executions="provisionedConcurrentExecutions"
    ),
    reserved_concurrent_executions=123,
    role="role",
    runtime="runtime",
    tags={
        "tags_key": "tags"
    },
    timeout=123,
    tracing="tracing",
    version_description="versionDescription",
    vpc_config=sam.CfnFunction.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)
Parameters:

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

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.

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:

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"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate 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.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
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'
architectures
assume_role_policy_document
auto_publish_alias
auto_publish_code_sha256
cfn_options

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

cfn_resource_type

AWS resource type.

code_signing_config_arn
code_uri
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.

dead_letter_queue
deployment_preference
description
environment
ephemeral_storage
event_invoke_config
events
file_system_configs
function_name
function_url_config
handler
image_config
image_uri
inline_code
kms_key_arn
layers
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).

Returns:

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

memory_size
node

The tree node.

package_type
permissions_boundary
policies
provisioned_concurrency_config
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 }).

reserved_concurrent_executions
role
runtime
stack

The stack in which this element is defined.

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

tags

Tag Manager which manages the tags for this resource.

tags_raw
timeout
tracing
version_description
vpc_config

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AlexaSkillEventProperty

class CfnFunction.AlexaSkillEventProperty(*, skill_id)

Bases: object

Parameters:

skill_id (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-alexaskillevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

alexa_skill_event_property = sam.CfnFunction.AlexaSkillEventProperty(
    skill_id="skillId"
)

Attributes

skill_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-alexaskillevent.html#cfn-serverless-function-alexaskillevent-skillid

Type:

see

ApiEventProperty

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

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

# custom_statements: Any

api_event_property = sam.CfnFunction.ApiEventProperty(
    method="method",
    path="path",

    # the properties below are optional
    auth=sam.CfnFunction.AuthProperty(
        api_key_required=False,
        authorization_scopes=["authorizationScopes"],
        authorizer="authorizer",
        resource_policy=sam.CfnFunction.AuthResourcePolicyProperty(
            aws_account_blacklist=["awsAccountBlacklist"],
            aws_account_whitelist=["awsAccountWhitelist"],
            custom_statements=[custom_statements],
            intrinsic_vpc_blacklist=["intrinsicVpcBlacklist"],
            intrinsic_vpce_blacklist=["intrinsicVpceBlacklist"],
            intrinsic_vpce_whitelist=["intrinsicVpceWhitelist"],
            intrinsic_vpc_whitelist=["intrinsicVpcWhitelist"],
            ip_range_blacklist=["ipRangeBlacklist"],
            ip_range_whitelist=["ipRangeWhitelist"],
            source_vpc_blacklist=["sourceVpcBlacklist"],
            source_vpc_whitelist=["sourceVpcWhitelist"]
        )
    ),
    request_model=sam.CfnFunction.RequestModelProperty(
        model="model",

        # the properties below are optional
        required=False,
        validate_body=False,
        validate_parameters=False
    ),
    request_parameters=["requestParameters"],
    rest_api_id="restApiId"
)

Attributes

auth

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-auth

Type:

see

method

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-method

Type:

see

path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-path

Type:

see

request_model

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-requestmodel

Type:

see

request_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-requestparameters

Type:

see

rest_api_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-restapiid

Type:

see

AuthProperty

class CfnFunction.AuthProperty(*, api_key_required=None, authorization_scopes=None, authorizer=None, resource_policy=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

# custom_statements: Any

auth_property = sam.CfnFunction.AuthProperty(
    api_key_required=False,
    authorization_scopes=["authorizationScopes"],
    authorizer="authorizer",
    resource_policy=sam.CfnFunction.AuthResourcePolicyProperty(
        aws_account_blacklist=["awsAccountBlacklist"],
        aws_account_whitelist=["awsAccountWhitelist"],
        custom_statements=[custom_statements],
        intrinsic_vpc_blacklist=["intrinsicVpcBlacklist"],
        intrinsic_vpce_blacklist=["intrinsicVpceBlacklist"],
        intrinsic_vpce_whitelist=["intrinsicVpceWhitelist"],
        intrinsic_vpc_whitelist=["intrinsicVpcWhitelist"],
        ip_range_blacklist=["ipRangeBlacklist"],
        ip_range_whitelist=["ipRangeWhitelist"],
        source_vpc_blacklist=["sourceVpcBlacklist"],
        source_vpc_whitelist=["sourceVpcWhitelist"]
    )
)

Attributes

api_key_required

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html#cfn-serverless-function-auth-apikeyrequired

Type:

see

authorization_scopes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html#cfn-serverless-function-auth-authorizationscopes

Type:

see

authorizer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html#cfn-serverless-function-auth-authorizer

Type:

see

resource_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html#cfn-serverless-function-auth-resourcepolicy

Type:

see

AuthResourcePolicyProperty

class CfnFunction.AuthResourcePolicyProperty(*, aws_account_blacklist=None, aws_account_whitelist=None, custom_statements=None, intrinsic_vpc_blacklist=None, intrinsic_vpce_blacklist=None, intrinsic_vpce_whitelist=None, intrinsic_vpc_whitelist=None, ip_range_blacklist=None, ip_range_whitelist=None, source_vpc_blacklist=None, source_vpc_whitelist=None)

Bases: object

Parameters:

  • aws_account_blacklist (Optional[Sequence[str]]) –

  • aws_account_whitelist (Optional[Sequence[str]]) –

  • custom_statements (Union[Sequence[Any], IResolvable, None]) –

  • intrinsic_vpc_blacklist (Optional[Sequence[str]]) –

  • intrinsic_vpce_blacklist (Optional[Sequence[str]]) –

  • intrinsic_vpce_whitelist (Optional[Sequence[str]]) –

  • intrinsic_vpc_whitelist (Optional[Sequence[str]]) –

  • ip_range_blacklist (Optional[Sequence[str]]) –

  • ip_range_whitelist (Optional[Sequence[str]]) –

  • source_vpc_blacklist (Optional[Sequence[str]]) –

  • source_vpc_whitelist (Optional[Sequence[str]]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

# custom_statements: Any

auth_resource_policy_property = sam.CfnFunction.AuthResourcePolicyProperty(
    aws_account_blacklist=["awsAccountBlacklist"],
    aws_account_whitelist=["awsAccountWhitelist"],
    custom_statements=[custom_statements],
    intrinsic_vpc_blacklist=["intrinsicVpcBlacklist"],
    intrinsic_vpce_blacklist=["intrinsicVpceBlacklist"],
    intrinsic_vpce_whitelist=["intrinsicVpceWhitelist"],
    intrinsic_vpc_whitelist=["intrinsicVpcWhitelist"],
    ip_range_blacklist=["ipRangeBlacklist"],
    ip_range_whitelist=["ipRangeWhitelist"],
    source_vpc_blacklist=["sourceVpcBlacklist"],
    source_vpc_whitelist=["sourceVpcWhitelist"]
)

Attributes

aws_account_blacklist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-awsaccountblacklist

Type:

see

aws_account_whitelist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-awsaccountwhitelist

Type:

see

custom_statements

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-customstatements

Type:

see

intrinsic_vpc_blacklist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-intrinsicvpcblacklist

Type:

see

intrinsic_vpc_whitelist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-intrinsicvpcwhitelist

Type:

see

intrinsic_vpce_blacklist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-intrinsicvpceblacklist

Type:

see

intrinsic_vpce_whitelist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-intrinsicvpcewhitelist

Type:

see

ip_range_blacklist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-iprangeblacklist

Type:

see

ip_range_whitelist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-iprangewhitelist

Type:

see

source_vpc_blacklist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-sourcevpcblacklist

Type:

see

source_vpc_whitelist

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-sourcevpcwhitelist

Type:

see

BucketSAMPTProperty

class CfnFunction.BucketSAMPTProperty(*, bucket_name)

Bases: object

Parameters:

bucket_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-bucketsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

bucket_sAMPTProperty = sam.CfnFunction.BucketSAMPTProperty(
    bucket_name="bucketName"
)

Attributes

bucket_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-bucketsampt.html#cfn-serverless-function-bucketsampt-bucketname

Type:

see

CloudWatchEventEventProperty

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

Bases: object

Parameters:

  • pattern (Any) –

  • input (Optional[str]) –

  • input_path (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatcheventevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

# pattern: Any

cloud_watch_event_event_property = sam.CfnFunction.CloudWatchEventEventProperty(
    pattern=pattern,

    # the properties below are optional
    input="input",
    input_path="inputPath"
)

Attributes

input

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatcheventevent.html#cfn-serverless-function-cloudwatcheventevent-input

Type:

see

input_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatcheventevent.html#cfn-serverless-function-cloudwatcheventevent-inputpath

Type:

see

pattern

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatcheventevent.html#cfn-serverless-function-cloudwatcheventevent-pattern

Type:

see

CloudWatchLogsEventProperty

class CfnFunction.CloudWatchLogsEventProperty(*, filter_pattern, log_group_name)

Bases: object

Parameters:

  • filter_pattern (str) –

  • log_group_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatchlogsevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

cloud_watch_logs_event_property = sam.CfnFunction.CloudWatchLogsEventProperty(
    filter_pattern="filterPattern",
    log_group_name="logGroupName"
)

Attributes

filter_pattern

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatchlogsevent.html#cfn-serverless-function-cloudwatchlogsevent-filterpattern

Type:

see

log_group_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatchlogsevent.html#cfn-serverless-function-cloudwatchlogsevent-loggroupname

Type:

see

CognitoEventProperty

class CfnFunction.CognitoEventProperty(*, trigger, user_pool)

Bases: object

Parameters:

  • trigger (str) –

  • user_pool (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cognitoevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

cognito_event_property = sam.CfnFunction.CognitoEventProperty(
    trigger="trigger",
    user_pool="userPool"
)

Attributes

trigger

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cognitoevent.html#cfn-serverless-function-cognitoevent-trigger

Type:

see

user_pool

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cognitoevent.html#cfn-serverless-function-cognitoevent-userpool

Type:

see

CollectionSAMPTProperty

class CfnFunction.CollectionSAMPTProperty(*, collection_id)

Bases: object

Parameters:

collection_id (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-collectionsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

collection_sAMPTProperty = sam.CfnFunction.CollectionSAMPTProperty(
    collection_id="collectionId"
)

Attributes

collection_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-collectionsampt.html#cfn-serverless-function-collectionsampt-collectionid

Type:

see

CorsConfigurationProperty

class CfnFunction.CorsConfigurationProperty(*, allow_origin, allow_credentials=None, allow_headers=None, allow_methods=None, max_age=None)

Bases: object

Parameters:

  • allow_origin (str) –

  • allow_credentials (Union[bool, IResolvable, None]) –

  • allow_headers (Optional[str]) –

  • allow_methods (Optional[str]) –

  • max_age (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-corsconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

cors_configuration_property = sam.CfnFunction.CorsConfigurationProperty(
    allow_origin="allowOrigin",

    # the properties below are optional
    allow_credentials=False,
    allow_headers="allowHeaders",
    allow_methods="allowMethods",
    max_age="maxAge"
)

Attributes

allow_credentials

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-corsconfiguration.html#cfn-serverless-function-corsconfiguration-allowcredentials

Type:

see

allow_headers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-corsconfiguration.html#cfn-serverless-function-corsconfiguration-allowheaders

Type:

see

allow_methods

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-corsconfiguration.html#cfn-serverless-function-corsconfiguration-allowmethods

Type:

see

allow_origin

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-corsconfiguration.html#cfn-serverless-function-corsconfiguration-alloworigin

Type:

see

max_age

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-corsconfiguration.html#cfn-serverless-function-corsconfiguration-maxage

Type:

see

DeadLetterQueueProperty

class CfnFunction.DeadLetterQueueProperty(*, target_arn, type)

Bases: object

Parameters:

  • target_arn (str) –

  • type (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deadletterqueue.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

dead_letter_queue_property = sam.CfnFunction.DeadLetterQueueProperty(
    target_arn="targetArn",
    type="type"
)

Attributes

target_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deadletterqueue.html#cfn-serverless-function-deadletterqueue-targetarn

Type:

see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deadletterqueue.html#cfn-serverless-function-deadletterqueue-type

Type:

see

DeploymentPreferenceProperty

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

Bases: object

Parameters:

  • alarms (Optional[Sequence[str]]) –

  • enabled (Union[bool, IResolvable, None]) –

  • hooks (Union[IResolvable, HooksProperty, Dict[str, Any], None]) –

  • role (Optional[str]) –

  • type (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

deployment_preference_property = sam.CfnFunction.DeploymentPreferenceProperty(
    alarms=["alarms"],
    enabled=False,
    hooks=sam.CfnFunction.HooksProperty(
        post_traffic="postTraffic",
        pre_traffic="preTraffic"
    ),
    role="role",
    type="type"
)

Attributes

alarms

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-alarms

Type:

see

enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-enabled

Type:

see

hooks

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-hooks

Type:

see

role

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-role

Type:

see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-type

Type:

see

DestinationConfigProperty

class CfnFunction.DestinationConfigProperty(*, on_failure)

Bases: object

Parameters:

on_failure (Union[IResolvable, DestinationProperty, Dict[str, Any]]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-destinationconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

destination_config_property = sam.CfnFunction.DestinationConfigProperty(
    on_failure=sam.CfnFunction.DestinationProperty(
        destination="destination",

        # the properties below are optional
        type="type"
    )
)

Attributes

on_failure

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-destinationconfig.html#cfn-serverless-function-destinationconfig-onfailure

Type:

see

DestinationProperty

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

Bases: object

Parameters:

  • destination (str) –

  • type (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-destination.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

destination_property = sam.CfnFunction.DestinationProperty(
    destination="destination",

    # the properties below are optional
    type="type"
)

Attributes

destination

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-destination.html#cfn-serverless-function-destination-destination

Type:

see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-destination.html#cfn-serverless-function-destination-type

Type:

see

DomainSAMPTProperty

class CfnFunction.DomainSAMPTProperty(*, domain_name)

Bases: object

Parameters:

domain_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-domainsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

domain_sAMPTProperty = sam.CfnFunction.DomainSAMPTProperty(
    domain_name="domainName"
)

Attributes

domain_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-domainsampt.html#cfn-serverless-function-domainsampt-domainname

Type:

see

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) –

  • stream (str) –

  • batch_size (Union[int, float, None]) –

  • bisect_batch_on_function_error (Union[bool, IResolvable, None]) –

  • destination_config (Union[IResolvable, DestinationConfigProperty, Dict[str, Any], None]) –

  • enabled (Union[bool, IResolvable, None]) –

  • maximum_batching_window_in_seconds (Union[int, float, None]) –

  • maximum_record_age_in_seconds (Union[int, float, None]) –

  • maximum_retry_attempts (Union[int, float, None]) –

  • parallelization_factor (Union[int, float, None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

dynamo_dBEvent_property = sam.CfnFunction.DynamoDBEventProperty(
    starting_position="startingPosition",
    stream="stream",

    # the properties below are optional
    batch_size=123,
    bisect_batch_on_function_error=False,
    destination_config=sam.CfnFunction.DestinationConfigProperty(
        on_failure=sam.CfnFunction.DestinationProperty(
            destination="destination",

            # the properties below are optional
            type="type"
        )
    ),
    enabled=False,
    maximum_batching_window_in_seconds=123,
    maximum_record_age_in_seconds=123,
    maximum_retry_attempts=123,
    parallelization_factor=123
)

Attributes

batch_size

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-batchsize

Type:

see

bisect_batch_on_function_error

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-bisectbatchonfunctionerror

Type:

see

destination_config

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-destinationconfig

Type:

see

enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-enabled

Type:

see

maximum_batching_window_in_seconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-maximumbatchingwindowinseconds

Type:

see

maximum_record_age_in_seconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-maximumrecordageinseconds

Type:

see

maximum_retry_attempts

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-maximumretryattempts

Type:

see

parallelization_factor

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-parallelizationfactor

Type:

see

starting_position

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-startingposition

Type:

see

stream

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-stream

Type:

see

EmptySAMPTProperty

class CfnFunction.EmptySAMPTProperty

Bases: object

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-emptysampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

empty_sAMPTProperty = sam.CfnFunction.EmptySAMPTProperty()

EphemeralStorageProperty

class CfnFunction.EphemeralStorageProperty(*, size)

Bases: object

Parameters:

size (Union[int, float]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-ephemeralstorage.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

ephemeral_storage_property = sam.CfnFunction.EphemeralStorageProperty(
    size=123
)

Attributes

size

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-ephemeralstorage.html#cfn-serverless-function-ephemeralstorage-size

Type:

see

EventBridgeRuleEventProperty

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

Bases: object

Parameters:

  • pattern (Any) –

  • event_bus_name (Optional[str]) –

  • input (Optional[str]) –

  • input_path (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

# pattern: Any

event_bridge_rule_event_property = sam.CfnFunction.EventBridgeRuleEventProperty(
    pattern=pattern,

    # the properties below are optional
    event_bus_name="eventBusName",
    input="input",
    input_path="inputPath"
)

Attributes

event_bus_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html#cfn-serverless-function-eventbridgeruleevent-eventbusname

Type:

see

input

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html#cfn-serverless-function-eventbridgeruleevent-input

Type:

see

input_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html#cfn-serverless-function-eventbridgeruleevent-inputpath

Type:

see

pattern

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html#cfn-serverless-function-eventbridgeruleevent-pattern

Type:

see

EventInvokeConfigProperty

class CfnFunction.EventInvokeConfigProperty(*, destination_config=None, maximum_event_age_in_seconds=None, maximum_retry_attempts=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokeconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

event_invoke_config_property = sam.CfnFunction.EventInvokeConfigProperty(
    destination_config=sam.CfnFunction.EventInvokeDestinationConfigProperty(
        on_failure=sam.CfnFunction.DestinationProperty(
            destination="destination",

            # the properties below are optional
            type="type"
        ),
        on_success=sam.CfnFunction.DestinationProperty(
            destination="destination",

            # the properties below are optional
            type="type"
        )
    ),
    maximum_event_age_in_seconds=123,
    maximum_retry_attempts=123
)

Attributes

destination_config

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokeconfig.html#cfn-serverless-function-eventinvokeconfig-destinationconfig

Type:

see

maximum_event_age_in_seconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokeconfig.html#cfn-serverless-function-eventinvokeconfig-maximumeventageinseconds

Type:

see

maximum_retry_attempts

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokeconfig.html#cfn-serverless-function-eventinvokeconfig-maximumretryattempts

Type:

see

EventInvokeDestinationConfigProperty

class CfnFunction.EventInvokeDestinationConfigProperty(*, on_failure, on_success)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokedestinationconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

event_invoke_destination_config_property = sam.CfnFunction.EventInvokeDestinationConfigProperty(
    on_failure=sam.CfnFunction.DestinationProperty(
        destination="destination",

        # the properties below are optional
        type="type"
    ),
    on_success=sam.CfnFunction.DestinationProperty(
        destination="destination",

        # the properties below are optional
        type="type"
    )
)

Attributes

on_failure

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokedestinationconfig.html#cfn-serverless-function-eventinvokedestinationconfig-onfailure

Type:

see

on_success

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokedestinationconfig.html#cfn-serverless-function-eventinvokedestinationconfig-onsuccess

Type:

see

EventSourceProperty

class CfnFunction.EventSourceProperty(*, properties, type)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventsource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

event_source_property = sam.CfnFunction.EventSourceProperty(
    properties=sam.CfnFunction.AlexaSkillEventProperty(
        skill_id="skillId"
    ),
    type="type"
)

Attributes

properties

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventsource.html#cfn-serverless-function-eventsource-properties

Type:

see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventsource.html#cfn-serverless-function-eventsource-type

Type:

see

FileSystemConfigProperty

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

Bases: object

Parameters:

  • arn (Optional[str]) –

  • local_mount_path (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-filesystemconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

file_system_config_property = sam.CfnFunction.FileSystemConfigProperty(
    arn="arn",
    local_mount_path="localMountPath"
)

Attributes

arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-filesystemconfig.html#cfn-serverless-function-filesystemconfig-arn

Type:

see

local_mount_path

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

Type:

see

FunctionEnvironmentProperty

class CfnFunction.FunctionEnvironmentProperty(*, variables)

Bases: object

Parameters:

variables (Union[Mapping[str, str], IResolvable]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionenvironment.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

function_environment_property = sam.CfnFunction.FunctionEnvironmentProperty(
    variables={
        "variables_key": "variables"
    }
)

Attributes

variables

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionenvironment.html#cfn-serverless-function-functionenvironment-variables

Type:

see

FunctionSAMPTProperty

class CfnFunction.FunctionSAMPTProperty(*, function_name)

Bases: object

Parameters:

function_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

function_sAMPTProperty = sam.CfnFunction.FunctionSAMPTProperty(
    function_name="functionName"
)

Attributes

function_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionsampt.html#cfn-serverless-function-functionsampt-functionname

Type:

see

FunctionUrlConfigProperty

class CfnFunction.FunctionUrlConfigProperty(*, auth_type, cors=None, invoke_mode=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionurlconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

function_url_config_property = sam.CfnFunction.FunctionUrlConfigProperty(
    auth_type="authType",

    # the properties below are optional
    cors="cors",
    invoke_mode="invokeMode"
)

Attributes

auth_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionurlconfig.html#cfn-serverless-function-functionurlconfig-authtype

Type:

see

cors

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionurlconfig.html#cfn-serverless-function-functionurlconfig-cors

Type:

see

invoke_mode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionurlconfig.html#cfn-serverless-function-functionurlconfig-invokemode

Type:

see

HooksProperty

class CfnFunction.HooksProperty(*, post_traffic=None, pre_traffic=None)

Bases: object

Parameters:

  • post_traffic (Optional[str]) –

  • pre_traffic (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-hooks.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

hooks_property = sam.CfnFunction.HooksProperty(
    post_traffic="postTraffic",
    pre_traffic="preTraffic"
)

Attributes

post_traffic

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-hooks.html#cfn-serverless-function-hooks-posttraffic

Type:

see

pre_traffic

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-hooks.html#cfn-serverless-function-hooks-pretraffic

Type:

see

HttpApiEventProperty

class CfnFunction.HttpApiEventProperty(*, api_id=None, auth=None, method=None, path=None, payload_format_version=None, route_settings=None, timeout_in_millis=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

http_api_event_property = sam.CfnFunction.HttpApiEventProperty(
    api_id="apiId",
    auth=sam.CfnFunction.HttpApiFunctionAuthProperty(
        authorization_scopes=["authorizationScopes"],
        authorizer="authorizer"
    ),
    method="method",
    path="path",
    payload_format_version="payloadFormatVersion",
    route_settings=sam.CfnFunction.RouteSettingsProperty(
        data_trace_enabled=False,
        detailed_metrics_enabled=False,
        logging_level="loggingLevel",
        throttling_burst_limit=123,
        throttling_rate_limit=123
    ),
    timeout_in_millis=123
)

Attributes

api_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-apiid

Type:

see

auth

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-auth

Type:

see

method

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-method

Type:

see

path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-path

Type:

see

payload_format_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-payloadformatversion

Type:

see

route_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-routesettings

Type:

see

timeout_in_millis

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-timeoutinmillis

Type:

see

HttpApiFunctionAuthProperty

class CfnFunction.HttpApiFunctionAuthProperty(*, authorization_scopes=None, authorizer=None)

Bases: object

Parameters:

  • authorization_scopes (Optional[Sequence[str]]) –

  • authorizer (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapifunctionauth.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

http_api_function_auth_property = sam.CfnFunction.HttpApiFunctionAuthProperty(
    authorization_scopes=["authorizationScopes"],
    authorizer="authorizer"
)

Attributes

authorization_scopes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapifunctionauth.html#cfn-serverless-function-httpapifunctionauth-authorizationscopes

Type:

see

authorizer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapifunctionauth.html#cfn-serverless-function-httpapifunctionauth-authorizer

Type:

see

IAMPolicyDocumentProperty

class CfnFunction.IAMPolicyDocumentProperty(*, statement, version=None)

Bases: object

Parameters:

  • statement (Any) –

  • version (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iampolicydocument.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

# statement: Any

i_aMPolicy_document_property = {
    "statement": statement,

    # the properties below are optional
    "version": "version"
}

Attributes

statement

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iampolicydocument.html#cfn-serverless-function-iampolicydocument-statement

Type:

see

version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iampolicydocument.html#cfn-serverless-function-iampolicydocument-version

Type:

see

IdentitySAMPTProperty

class CfnFunction.IdentitySAMPTProperty(*, identity_name)

Bases: object

Parameters:

identity_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-identitysampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

identity_sAMPTProperty = sam.CfnFunction.IdentitySAMPTProperty(
    identity_name="identityName"
)

Attributes

identity_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-identitysampt.html#cfn-serverless-function-identitysampt-identityname

Type:

see

ImageConfigProperty

class CfnFunction.ImageConfigProperty(*, command=None, entry_point=None, working_directory=None)

Bases: object

Parameters:

  • command (Optional[Sequence[str]]) –

  • entry_point (Optional[Sequence[str]]) –

  • working_directory (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-imageconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

image_config_property = sam.CfnFunction.ImageConfigProperty(
    command=["command"],
    entry_point=["entryPoint"],
    working_directory="workingDirectory"
)

Attributes

command

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-imageconfig.html#cfn-serverless-function-imageconfig-command

Type:

see

entry_point

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-imageconfig.html#cfn-serverless-function-imageconfig-entrypoint

Type:

see

working_directory

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-imageconfig.html#cfn-serverless-function-imageconfig-workingdirectory

Type:

see

IoTRuleEventProperty

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

Bases: object

Parameters:

  • sql (str) –

  • aws_iot_sql_version (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iotruleevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

io_tRule_event_property = sam.CfnFunction.IoTRuleEventProperty(
    sql="sql",

    # the properties below are optional
    aws_iot_sql_version="awsIotSqlVersion"
)

Attributes

aws_iot_sql_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iotruleevent.html#cfn-serverless-function-iotruleevent-awsiotsqlversion

Type:

see

sql

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iotruleevent.html#cfn-serverless-function-iotruleevent-sql

Type:

see

KeySAMPTProperty

class CfnFunction.KeySAMPTProperty(*, key_id)

Bases: object

Parameters:

key_id (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-keysampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

key_sAMPTProperty = sam.CfnFunction.KeySAMPTProperty(
    key_id="keyId"
)

Attributes

key_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-keysampt.html#cfn-serverless-function-keysampt-keyid

Type:

see

KinesisEventProperty

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

Bases: object

Parameters:

  • starting_position (str) –

  • stream (str) –

  • batch_size (Union[int, float, None]) –

  • enabled (Union[bool, IResolvable, None]) –

  • function_response_types (Optional[Sequence[str]]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

kinesis_event_property = sam.CfnFunction.KinesisEventProperty(
    starting_position="startingPosition",
    stream="stream",

    # the properties below are optional
    batch_size=123,
    enabled=False,
    function_response_types=["functionResponseTypes"]
)

Attributes

batch_size

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-batchsize

Type:

see

enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-enabled

Type:

see

function_response_types

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-functionresponsetypes

Type:

see

starting_position

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-startingposition

Type:

see

stream

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-stream

Type:

see

LogGroupSAMPTProperty

class CfnFunction.LogGroupSAMPTProperty(*, log_group_name)

Bases: object

Parameters:

log_group_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-loggroupsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

log_group_sAMPTProperty = sam.CfnFunction.LogGroupSAMPTProperty(
    log_group_name="logGroupName"
)

Attributes

log_group_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-loggroupsampt.html#cfn-serverless-function-loggroupsampt-loggroupname

Type:

see

ParameterNameSAMPTProperty

class CfnFunction.ParameterNameSAMPTProperty(*, parameter_name)

Bases: object

Parameters:

parameter_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-parameternamesampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

parameter_name_sAMPTProperty = sam.CfnFunction.ParameterNameSAMPTProperty(
    parameter_name="parameterName"
)

Attributes

parameter_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-parameternamesampt.html#cfn-serverless-function-parameternamesampt-parametername

Type:

see

ProvisionedConcurrencyConfigProperty

class CfnFunction.ProvisionedConcurrencyConfigProperty(*, provisioned_concurrent_executions)

Bases: object

Parameters:

provisioned_concurrent_executions (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-provisionedconcurrencyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

provisioned_concurrency_config_property = sam.CfnFunction.ProvisionedConcurrencyConfigProperty(
    provisioned_concurrent_executions="provisionedConcurrentExecutions"
)

Attributes

provisioned_concurrent_executions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-provisionedconcurrencyconfig.html#cfn-serverless-function-provisionedconcurrencyconfig-provisionedconcurrentexecutions

Type:

see

QueueSAMPTProperty

class CfnFunction.QueueSAMPTProperty(*, queue_name)

Bases: object

Parameters:

queue_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-queuesampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

queue_sAMPTProperty = sam.CfnFunction.QueueSAMPTProperty(
    queue_name="queueName"
)

Attributes

queue_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-queuesampt.html#cfn-serverless-function-queuesampt-queuename

Type:

see

RequestModelProperty

class CfnFunction.RequestModelProperty(*, model, required=None, validate_body=None, validate_parameters=None)

Bases: object

Parameters:

  • model (str) –

  • required (Union[bool, IResolvable, None]) –

  • validate_body (Union[bool, IResolvable, None]) –

  • validate_parameters (Union[bool, IResolvable, None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

request_model_property = sam.CfnFunction.RequestModelProperty(
    model="model",

    # the properties below are optional
    required=False,
    validate_body=False,
    validate_parameters=False
)

Attributes

model

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html#cfn-serverless-function-requestmodel-model

Type:

see

required

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html#cfn-serverless-function-requestmodel-required

Type:

see

validate_body

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html#cfn-serverless-function-requestmodel-validatebody

Type:

see

validate_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html#cfn-serverless-function-requestmodel-validateparameters

Type:

see

RequestParameterProperty

class CfnFunction.RequestParameterProperty(*, caching=None, required=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

request_parameter_property = sam.CfnFunction.RequestParameterProperty(
    caching=False,
    required=False
)

Attributes

caching

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestparameter.html#cfn-serverless-function-requestparameter-caching

Type:

see

required

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestparameter.html#cfn-serverless-function-requestparameter-required

Type:

see

RouteSettingsProperty

class CfnFunction.RouteSettingsProperty(*, data_trace_enabled=None, detailed_metrics_enabled=None, logging_level=None, throttling_burst_limit=None, throttling_rate_limit=None)

Bases: object

Parameters:

  • data_trace_enabled (Union[bool, IResolvable, None]) –

  • detailed_metrics_enabled (Union[bool, IResolvable, None]) –

  • logging_level (Optional[str]) –

  • throttling_burst_limit (Union[int, float, None]) –

  • throttling_rate_limit (Union[int, float, None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

route_settings_property = sam.CfnFunction.RouteSettingsProperty(
    data_trace_enabled=False,
    detailed_metrics_enabled=False,
    logging_level="loggingLevel",
    throttling_burst_limit=123,
    throttling_rate_limit=123
)

Attributes

data_trace_enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-datatraceenabled

Type:

see

detailed_metrics_enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-detailedmetricsenabled

Type:

see

logging_level

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-logginglevel

Type:

see

throttling_burst_limit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-throttlingburstlimit

Type:

see

throttling_rate_limit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-throttlingratelimit

Type:

see

S3EventProperty

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

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3event.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

s3_event_property = sam.CfnFunction.S3EventProperty(
    bucket="bucket",
    events="events",

    # the properties below are optional
    filter=sam.CfnFunction.S3NotificationFilterProperty(
        s3_key=sam.CfnFunction.S3KeyFilterProperty(
            rules=[sam.CfnFunction.S3KeyFilterRuleProperty(
                name="name",
                value="value"
            )]
        )
    )
)

Attributes

bucket

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3event.html#cfn-serverless-function-s3event-bucket

Type:

see

events

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3event.html#cfn-serverless-function-s3event-events

Type:

see

filter

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3event.html#cfn-serverless-function-s3event-filter

Type:

see

S3KeyFilterProperty

class CfnFunction.S3KeyFilterProperty(*, rules)

Bases: object

Parameters:

rules (Union[IResolvable, Sequence[Union[IResolvable, S3KeyFilterRuleProperty, Dict[str, Any]]]]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3keyfilter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

s3_key_filter_property = sam.CfnFunction.S3KeyFilterProperty(
    rules=[sam.CfnFunction.S3KeyFilterRuleProperty(
        name="name",
        value="value"
    )]
)

Attributes

rules

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3keyfilter.html#cfn-serverless-function-s3keyfilter-rules

Type:

see

S3KeyFilterRuleProperty

class CfnFunction.S3KeyFilterRuleProperty(*, name, value)

Bases: object

Parameters:

  • name (str) –

  • value (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3keyfilterrule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

s3_key_filter_rule_property = sam.CfnFunction.S3KeyFilterRuleProperty(
    name="name",
    value="value"
)

Attributes

name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3keyfilterrule.html#cfn-serverless-function-s3keyfilterrule-name

Type:

see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3keyfilterrule.html#cfn-serverless-function-s3keyfilterrule-value

Type:

see

S3LocationProperty

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

Bases: object

Parameters:

  • bucket (str) –

  • key (str) –

  • version (Union[int, float, None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3location.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

s3_location_property = sam.CfnFunction.S3LocationProperty(
    bucket="bucket",
    key="key",

    # the properties below are optional
    version=123
)

Attributes

bucket

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3location.html#cfn-serverless-function-s3location-bucket

Type:

see

key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3location.html#cfn-serverless-function-s3location-key

Type:

see

version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3location.html#cfn-serverless-function-s3location-version

Type:

see

S3NotificationFilterProperty

class CfnFunction.S3NotificationFilterProperty(*, s3_key)

Bases: object

Parameters:

s3_key (Union[IResolvable, S3KeyFilterProperty, Dict[str, Any]]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3notificationfilter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

s3_notification_filter_property = sam.CfnFunction.S3NotificationFilterProperty(
    s3_key=sam.CfnFunction.S3KeyFilterProperty(
        rules=[sam.CfnFunction.S3KeyFilterRuleProperty(
            name="name",
            value="value"
        )]
    )
)

Attributes

s3_key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3notificationfilter.html#cfn-serverless-function-s3notificationfilter-s3key

Type:

see

SAMPolicyTemplateProperty

class CfnFunction.SAMPolicyTemplateProperty(*, ami_describe_policy=None, aws_secrets_manager_get_secret_value_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, dynamo_db_write_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, s3_write_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, ssm_parameter_read_policy=None, step_functions_execution_policy=None, vpc_access_policy=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

s_aMPolicy_template_property = sam.CfnFunction.SAMPolicyTemplateProperty(
    ami_describe_policy=sam.CfnFunction.EmptySAMPTProperty(),
    aws_secrets_manager_get_secret_value_policy=sam.CfnFunction.SecretArnSAMPTProperty(
        secret_arn="secretArn"
    ),
    cloud_formation_describe_stacks_policy=sam.CfnFunction.EmptySAMPTProperty(),
    cloud_watch_put_metric_policy=sam.CfnFunction.EmptySAMPTProperty(),
    dynamo_db_crud_policy=sam.CfnFunction.TableSAMPTProperty(
        table_name="tableName"
    ),
    dynamo_db_read_policy=sam.CfnFunction.TableSAMPTProperty(
        table_name="tableName"
    ),
    dynamo_db_stream_read_policy=sam.CfnFunction.TableStreamSAMPTProperty(
        stream_name="streamName",
        table_name="tableName"
    ),
    dynamo_db_write_policy=sam.CfnFunction.TableSAMPTProperty(
        table_name="tableName"
    ),
    ec2_describe_policy=sam.CfnFunction.EmptySAMPTProperty(),
    elasticsearch_http_post_policy=sam.CfnFunction.DomainSAMPTProperty(
        domain_name="domainName"
    ),
    filter_log_events_policy=sam.CfnFunction.LogGroupSAMPTProperty(
        log_group_name="logGroupName"
    ),
    kinesis_crud_policy=sam.CfnFunction.StreamSAMPTProperty(
        stream_name="streamName"
    ),
    kinesis_stream_read_policy=sam.CfnFunction.StreamSAMPTProperty(
        stream_name="streamName"
    ),
    kms_decrypt_policy=sam.CfnFunction.KeySAMPTProperty(
        key_id="keyId"
    ),
    lambda_invoke_policy=sam.CfnFunction.FunctionSAMPTProperty(
        function_name="functionName"
    ),
    rekognition_detect_only_policy=sam.CfnFunction.EmptySAMPTProperty(),
    rekognition_labels_policy=sam.CfnFunction.EmptySAMPTProperty(),
    rekognition_no_data_access_policy=sam.CfnFunction.CollectionSAMPTProperty(
        collection_id="collectionId"
    ),
    rekognition_read_policy=sam.CfnFunction.CollectionSAMPTProperty(
        collection_id="collectionId"
    ),
    rekognition_write_only_access_policy=sam.CfnFunction.CollectionSAMPTProperty(
        collection_id="collectionId"
    ),
    s3_crud_policy=sam.CfnFunction.BucketSAMPTProperty(
        bucket_name="bucketName"
    ),
    s3_read_policy=sam.CfnFunction.BucketSAMPTProperty(
        bucket_name="bucketName"
    ),
    s3_write_policy=sam.CfnFunction.BucketSAMPTProperty(
        bucket_name="bucketName"
    ),
    ses_bulk_templated_crud_policy=sam.CfnFunction.IdentitySAMPTProperty(
        identity_name="identityName"
    ),
    ses_crud_policy=sam.CfnFunction.IdentitySAMPTProperty(
        identity_name="identityName"
    ),
    ses_email_template_crud_policy=sam.CfnFunction.EmptySAMPTProperty(),
    ses_send_bounce_policy=sam.CfnFunction.IdentitySAMPTProperty(
        identity_name="identityName"
    ),
    sns_crud_policy=sam.CfnFunction.TopicSAMPTProperty(
        topic_name="topicName"
    ),
    sns_publish_message_policy=sam.CfnFunction.TopicSAMPTProperty(
        topic_name="topicName"
    ),
    sqs_poller_policy=sam.CfnFunction.QueueSAMPTProperty(
        queue_name="queueName"
    ),
    sqs_send_message_policy=sam.CfnFunction.QueueSAMPTProperty(
        queue_name="queueName"
    ),
    ssm_parameter_read_policy=sam.CfnFunction.ParameterNameSAMPTProperty(
        parameter_name="parameterName"
    ),
    step_functions_execution_policy=sam.CfnFunction.StateMachineSAMPTProperty(
        state_machine_name="stateMachineName"
    ),
    vpc_access_policy=sam.CfnFunction.EmptySAMPTProperty()
)

Attributes

ami_describe_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-amidescribepolicy

Type:

see

aws_secrets_manager_get_secret_value_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-awssecretsmanagergetsecretvaluepolicy

Type:

see

cloud_formation_describe_stacks_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-cloudformationdescribestackspolicy

Type:

see

cloud_watch_put_metric_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-cloudwatchputmetricpolicy

Type:

see

dynamo_db_crud_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-dynamodbcrudpolicy

Type:

see

dynamo_db_read_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-dynamodbreadpolicy

Type:

see

dynamo_db_stream_read_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-dynamodbstreamreadpolicy

Type:

see

dynamo_db_write_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-dynamodbwritepolicy

Type:

see

ec2_describe_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-ec2describepolicy

Type:

see

elasticsearch_http_post_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-elasticsearchhttppostpolicy

Type:

see

filter_log_events_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-filterlogeventspolicy

Type:

see

kinesis_crud_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-kinesiscrudpolicy

Type:

see

kinesis_stream_read_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-kinesisstreamreadpolicy

Type:

see

kms_decrypt_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-kmsdecryptpolicy

Type:

see

lambda_invoke_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-lambdainvokepolicy

Type:

see

rekognition_detect_only_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitiondetectonlypolicy

Type:

see

rekognition_labels_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitionlabelspolicy

Type:

see

rekognition_no_data_access_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitionnodataaccesspolicy

Type:

see

rekognition_read_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitionreadpolicy

Type:

see

rekognition_write_only_access_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitionwriteonlyaccesspolicy

Type:

see

s3_crud_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-s3crudpolicy

Type:

see

s3_read_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-s3readpolicy

Type:

see

s3_write_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-s3writepolicy

Type:

see

ses_bulk_templated_crud_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sesbulktemplatedcrudpolicy

Type:

see

ses_crud_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sescrudpolicy

Type:

see

ses_email_template_crud_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sesemailtemplatecrudpolicy

Type:

see

ses_send_bounce_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sessendbouncepolicy

Type:

see

sns_crud_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-snscrudpolicy

Type:

see

sns_publish_message_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-snspublishmessagepolicy

Type:

see

sqs_poller_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sqspollerpolicy

Type:

see

sqs_send_message_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sqssendmessagepolicy

Type:

see

ssm_parameter_read_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-ssmparameterreadpolicy

Type:

see

step_functions_execution_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-stepfunctionsexecutionpolicy

Type:

see

vpc_access_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-vpcaccesspolicy

Type:

see

SNSEventProperty

class CfnFunction.SNSEventProperty(*, topic)

Bases: object

Parameters:

topic (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-snsevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

s_nSEvent_property = sam.CfnFunction.SNSEventProperty(
    topic="topic"
)

Attributes

topic

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-snsevent.html#cfn-serverless-function-snsevent-topic

Type:

see

SQSEventProperty

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

Bases: object

Parameters:

  • queue (str) –

  • batch_size (Union[int, float, None]) –

  • enabled (Union[bool, IResolvable, None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sqsevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

s_qSEvent_property = sam.CfnFunction.SQSEventProperty(
    queue="queue",

    # the properties below are optional
    batch_size=123,
    enabled=False
)

Attributes

batch_size

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sqsevent.html#cfn-serverless-function-sqsevent-batchsize

Type:

see

enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sqsevent.html#cfn-serverless-function-sqsevent-enabled

Type:

see

queue

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sqsevent.html#cfn-serverless-function-sqsevent-queue

Type:

see

ScheduleEventProperty

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

Bases: object

Parameters:

  • schedule (str) –

  • description (Optional[str]) –

  • enabled (Union[bool, IResolvable, None]) –

  • input (Optional[str]) –

  • name (Optional[str]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

schedule_event_property = sam.CfnFunction.ScheduleEventProperty(
    schedule="schedule",

    # the properties below are optional
    description="description",
    enabled=False,
    input="input",
    name="name"
)

Attributes

description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-description

Type:

see

enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-enabled

Type:

see

input

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-input

Type:

see

name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-name

Type:

see

schedule

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-schedule

Type:

see

SecretArnSAMPTProperty

class CfnFunction.SecretArnSAMPTProperty(*, secret_arn)

Bases: object

Parameters:

secret_arn (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-secretarnsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

secret_arn_sAMPTProperty = sam.CfnFunction.SecretArnSAMPTProperty(
    secret_arn="secretArn"
)

Attributes

secret_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-secretarnsampt.html#cfn-serverless-function-secretarnsampt-secretarn

Type:

see

StateMachineSAMPTProperty

class CfnFunction.StateMachineSAMPTProperty(*, state_machine_name)

Bases: object

Parameters:

state_machine_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-statemachinesampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

state_machine_sAMPTProperty = sam.CfnFunction.StateMachineSAMPTProperty(
    state_machine_name="stateMachineName"
)

Attributes

state_machine_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-statemachinesampt.html#cfn-serverless-function-statemachinesampt-statemachinename

Type:

see

StreamSAMPTProperty

class CfnFunction.StreamSAMPTProperty(*, stream_name)

Bases: object

Parameters:

stream_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-streamsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

stream_sAMPTProperty = sam.CfnFunction.StreamSAMPTProperty(
    stream_name="streamName"
)

Attributes

stream_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-streamsampt.html#cfn-serverless-function-streamsampt-streamname

Type:

see

TableSAMPTProperty

class CfnFunction.TableSAMPTProperty(*, table_name)

Bases: object

Parameters:

table_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-tablesampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

table_sAMPTProperty = sam.CfnFunction.TableSAMPTProperty(
    table_name="tableName"
)

Attributes

table_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-tablesampt.html#cfn-serverless-function-tablesampt-tablename

Type:

see

TableStreamSAMPTProperty

class CfnFunction.TableStreamSAMPTProperty(*, stream_name, table_name)

Bases: object

Parameters:

  • stream_name (str) –

  • table_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-tablestreamsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

table_stream_sAMPTProperty = sam.CfnFunction.TableStreamSAMPTProperty(
    stream_name="streamName",
    table_name="tableName"
)

Attributes

stream_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-tablestreamsampt.html#cfn-serverless-function-tablestreamsampt-streamname

Type:

see

table_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-tablestreamsampt.html#cfn-serverless-function-tablestreamsampt-tablename

Type:

see

TopicSAMPTProperty

class CfnFunction.TopicSAMPTProperty(*, topic_name)

Bases: object

Parameters:

topic_name (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-topicsampt.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

topic_sAMPTProperty = sam.CfnFunction.TopicSAMPTProperty(
    topic_name="topicName"
)

Attributes

topic_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-topicsampt.html#cfn-serverless-function-topicsampt-topicname

Type:

see

VpcConfigProperty

class CfnFunction.VpcConfigProperty(*, security_group_ids, subnet_ids)

Bases: object

Parameters:

  • security_group_ids (Sequence[str]) –

  • subnet_ids (Sequence[str]) –

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

vpc_config_property = sam.CfnFunction.VpcConfigProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-vpcconfig.html#cfn-serverless-function-vpcconfig-securitygroupids

Type:

see

subnet_ids

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-vpcconfig.html#cfn-serverless-function-vpcconfig-subnetids

Type:

see