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, Dict[str, Any], None]) – AWS::Serverless::Function.CodeUri.
dead_letter_queue (Union[IResolvable, DeadLetterQueueProperty, Dict[str, Any], None]) – AWS::Serverless::Function.DeadLetterQueue.
deployment_preference (Union[IResolvable, DeploymentPreferenceProperty, Dict[str, Any], None]) – AWS::Serverless::Function.DeploymentPreference.
description (Optional[str]) – AWS::Serverless::Function.Description.
environment (Union[IResolvable, FunctionEnvironmentProperty, Dict[str, Any], None]) – AWS::Serverless::Function.Environment.
event_invoke_config (Union[IResolvable, EventInvokeConfigProperty, Dict[str, Any], None]) – AWS::Serverless::Function.EventInvokeConfig.
events (Union[IResolvable, Mapping[str, Union[IResolvable, EventSourceProperty, Dict[str, Any]]], None]) – AWS::Serverless::Function.Events.
file_system_configs (Union[IResolvable, Sequence[Union[IResolvable, FileSystemConfigProperty, Dict[str, Any]]], 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, Dict[str, Any], 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, Dict[str, Any], Sequence[Union[str, IResolvable, IAMPolicyDocumentProperty, Dict[str, Any], SAMPolicyTemplateProperty]], None]) – AWS::Serverless::Function.Policies.
provisioned_concurrency_config (Union[IResolvable, ProvisionedConcurrencyConfigProperty, Dict[str, Any], 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, Dict[str, Any], 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"]
    )
)