CfnFunctionProps

class aws_cdk.aws_sam.CfnFunctionProps(*, 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, event_invoke_config=None, events=None, file_system_configs=None, function_name=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: object

Properties for defining a CfnFunction.

Parameters
  • architectures (Optional[Sequence[str]]) – AWS::Serverless::Function.Architectures.

  • assume_role_policy_document (Optional[Any]) – AWS::Serverless::Function.AssumeRolePolicyDocument.

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

  • auto_publish_code_sha256 (Optional[str]) – AWS::Serverless::Function.AutoPublishCodeSha256.

  • code_signing_config_arn (Optional[str]) – AWS::Serverless::Function.CodeSigningConfigArn.

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

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

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

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

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

  • event_invoke_config (Union[IResolvable, EventInvokeConfigProperty, None]) – AWS::Serverless::Function.EventInvokeConfig.

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

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

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

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

  • image_config (Union[IResolvable, ImageConfigProperty, None]) – AWS::Serverless::Function.ImageConfig.

  • image_uri (Optional[str]) – AWS::Serverless::Function.ImageUri.

  • inline_code (Optional[str]) – AWS::Serverless::Function.InlineCode.

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

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

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

  • package_type (Optional[str]) – AWS::Serverless::Function.PackageType.

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

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

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

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

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

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

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

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

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

  • version_description (Optional[str]) – AWS::Serverless::Function.VersionDescription.

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

Link

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

ExampleMetadata

fixture=_generated

Example:

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

# assume_role_policy_document: Any

cfn_function_props = sam.CfnFunctionProps(
    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(
        enabled=False,
        type="type",

        # the properties below are optional
        alarms=["alarms"],
        hooks=sam.CfnFunction.HooksProperty(
            post_traffic="postTraffic",
            pre_traffic="preTraffic"
        )
    ),
    description="description",
    environment=sam.CfnFunction.FunctionEnvironmentProperty(
        variables={
            "variables_key": "variables"
        }
    ),
    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.S3EventProperty(
                variables={
                    "variables_key": "variables"
                }
            ),
            type="type"
        )
    },
    file_system_configs=[sam.CfnFunction.FileSystemConfigProperty(
        arn="arn",
        local_mount_path="localMountPath"
    )],
    function_name="functionName",
    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"]
    )
)

Attributes

architectures

AWS::Serverless::Function.Architectures.

Link

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

Return type

Optional[List[str]]

assume_role_policy_document

AWS::Serverless::Function.AssumeRolePolicyDocument.

Link

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

Return type

Any

auto_publish_alias

AWS::Serverless::Function.AutoPublishAlias.

Link

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

Return type

Optional[str]

auto_publish_code_sha256

AWS::Serverless::Function.AutoPublishCodeSha256.

Link

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

Return type

Optional[str]

code_signing_config_arn

AWS::Serverless::Function.CodeSigningConfigArn.

Link

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

Return type

Optional[str]

code_uri

AWS::Serverless::Function.CodeUri.

Link

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

Return type

Union[str, IResolvable, S3LocationProperty, None]

dead_letter_queue

AWS::Serverless::Function.DeadLetterQueue.

Link

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

Return type

Union[IResolvable, DeadLetterQueueProperty, None]

deployment_preference

AWS::Serverless::Function.DeploymentPreference.

Link

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

Return type

Union[IResolvable, DeploymentPreferenceProperty, None]

description

AWS::Serverless::Function.Description.

Link

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

Return type

Optional[str]

environment

AWS::Serverless::Function.Environment.

Link

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

Return type

Union[IResolvable, FunctionEnvironmentProperty, None]

event_invoke_config

AWS::Serverless::Function.EventInvokeConfig.

Link

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

Return type

Union[IResolvable, EventInvokeConfigProperty, None]

events

AWS::Serverless::Function.Events.

Link

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

Return type

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

file_system_configs

AWS::Serverless::Function.FileSystemConfigs.

Link

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

Return type

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

function_name

AWS::Serverless::Function.FunctionName.

Link

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

Return type

Optional[str]

handler

AWS::Serverless::Function.Handler.

Link

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

Return type

Optional[str]

image_config

AWS::Serverless::Function.ImageConfig.

Link

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

Return type

Union[IResolvable, ImageConfigProperty, None]

image_uri

AWS::Serverless::Function.ImageUri.

Link

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

Return type

Optional[str]

inline_code

AWS::Serverless::Function.InlineCode.

Link

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

Return type

Optional[str]

kms_key_arn

AWS::Serverless::Function.KmsKeyArn.

Link

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

Return type

Optional[str]

layers

AWS::Serverless::Function.Layers.

Link

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

Return type

Optional[List[str]]

memory_size

AWS::Serverless::Function.MemorySize.

Link

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

Return type

Union[int, float, None]

package_type

AWS::Serverless::Function.PackageType.

Link

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

Return type

Optional[str]

permissions_boundary

AWS::Serverless::Function.PermissionsBoundary.

Link

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

Return type

Optional[str]

policies

AWS::Serverless::Function.Policies.

Link

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

Return type

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

provisioned_concurrency_config

AWS::Serverless::Function.ProvisionedConcurrencyConfig.

Link

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

Return type

Union[IResolvable, ProvisionedConcurrencyConfigProperty, None]

reserved_concurrent_executions

AWS::Serverless::Function.ReservedConcurrentExecutions.

Link

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

Return type

Union[int, float, None]

role

AWS::Serverless::Function.Role.

Link

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

Return type

Optional[str]

runtime

AWS::Serverless::Function.Runtime.

Link

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

Return type

Optional[str]

tags

AWS::Serverless::Function.Tags.

Link

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

Return type

Optional[Mapping[str, str]]

timeout

AWS::Serverless::Function.Timeout.

Link

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

Return type

Union[int, float, None]

tracing

AWS::Serverless::Function.Tracing.

Link

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

Return type

Optional[str]

version_description

AWS::Serverless::Function.VersionDescription.

Link

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

Return type

Optional[str]

vpc_config

AWS::Serverless::Function.VpcConfig.

Link

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

Return type

Union[IResolvable, VpcConfigProperty, None]