CfnFunctionPropsMixin

class aws_cdk.mixins_preview.aws_sam.mixins.CfnFunctionPropsMixin(props, *, strategy=None)

Bases: Mixin

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
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_sam import mixins as sam_mixins

# assume_role_policy_document: Any

cfn_function_props_mixin = sam_mixins.CfnFunctionPropsMixin(sam_mixins.CfnFunctionMixinProps(
    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_mixins.CfnFunctionPropsMixin.DeadLetterQueueProperty(
        target_arn="targetArn",
        type="type"
    ),
    deployment_preference=sam_mixins.CfnFunctionPropsMixin.DeploymentPreferenceProperty(
        alarms=["alarms"],
        enabled=False,
        hooks=sam_mixins.CfnFunctionPropsMixin.HooksProperty(
            post_traffic="postTraffic",
            pre_traffic="preTraffic"
        ),
        role="role",
        type="type"
    ),
    description="description",
    environment=sam_mixins.CfnFunctionPropsMixin.FunctionEnvironmentProperty(
        variables={
            "variables_key": "variables"
        }
    ),
    ephemeral_storage=sam_mixins.CfnFunctionPropsMixin.EphemeralStorageProperty(
        size=123
    ),
    event_invoke_config=sam_mixins.CfnFunctionPropsMixin.EventInvokeConfigProperty(
        destination_config=sam_mixins.CfnFunctionPropsMixin.EventInvokeDestinationConfigProperty(
            on_failure=sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
                destination="destination",
                type="type"
            ),
            on_success=sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
                destination="destination",
                type="type"
            )
        ),
        maximum_event_age_in_seconds=123,
        maximum_retry_attempts=123
    ),
    events={
        "events_key": sam_mixins.CfnFunctionPropsMixin.EventSourceProperty(
            properties=sam_mixins.CfnFunctionPropsMixin.AlexaSkillEventProperty(
                skill_id="skillId"
            ),
            type="type"
        )
    },
    file_system_configs=[sam_mixins.CfnFunctionPropsMixin.FileSystemConfigProperty(
        arn="arn",
        local_mount_path="localMountPath"
    )],
    function_name="functionName",
    function_url_config=sam_mixins.CfnFunctionPropsMixin.FunctionUrlConfigProperty(
        auth_type="authType",
        cors="cors",
        invoke_mode="invokeMode"
    ),
    handler="handler",
    image_config=sam_mixins.CfnFunctionPropsMixin.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_mixins.CfnFunctionPropsMixin.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_mixins.CfnFunctionPropsMixin.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Serverless::Function.

Parameters:

props (Union[CfnFunctionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['architectures', 'assumeRolePolicyDocument', 'autoPublishAlias', 'autoPublishCodeSha256', 'codeSigningConfigArn', 'codeUri', 'deadLetterQueue', 'deploymentPreference', 'description', 'environment', 'ephemeralStorage', 'eventInvokeConfig', 'events', 'fileSystemConfigs', 'functionName', 'functionUrlConfig', 'handler', 'imageConfig', 'imageUri', 'inlineCode', 'kmsKeyArn', 'layers', 'memorySize', 'packageType', 'permissionsBoundary', 'policies', 'provisionedConcurrencyConfig', 'reservedConcurrentExecutions', 'role', 'runtime', 'tags', 'timeout', 'tracing', 'versionDescription', 'vpcConfig']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AlexaSkillEventProperty

class CfnFunctionPropsMixin.AlexaSkillEventProperty(*, skill_id=None)

Bases: object

Parameters:: skill_id (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

alexa_skill_event_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.ApiEventProperty(*, auth=None, method=None, path=None, request_model=None, request_parameters=None, rest_api_id=None)

Bases: object

Parameters:

auth (Union[IResolvable, AuthProperty, Dict[str, Any], None])
method (Optional[str])
path (Optional[str])
request_model (Union[IResolvable, RequestModelProperty, Dict[str, Any], None])
request_parameters (Union[IResolvable, Sequence[Union[str, IResolvable, RequestParameterProperty, Dict[str, Any]]], None])
rest_api_id (Optional[str])

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.mixins_preview.aws_sam import mixins as sam_mixins

# custom_statements: Any

api_event_property = sam_mixins.CfnFunctionPropsMixin.ApiEventProperty(
    auth=sam_mixins.CfnFunctionPropsMixin.AuthProperty(
        api_key_required=False,
        authorization_scopes=["authorizationScopes"],
        authorizer="authorizer",
        resource_policy=sam_mixins.CfnFunctionPropsMixin.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"]
        )
    ),
    method="method",
    path="path",
    request_model=sam_mixins.CfnFunctionPropsMixin.RequestModelProperty(
        model="model",
        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 CfnFunctionPropsMixin.AuthProperty(*, api_key_required=None, authorization_scopes=None, authorizer=None, resource_policy=None)

Bases: object

Parameters:

api_key_required (Union[bool, IResolvable, None])
authorization_scopes (Optional[Sequence[str]])
authorizer (Optional[str])
resource_policy (Union[IResolvable, AuthResourcePolicyProperty, Dict[str, Any], None])

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.mixins_preview.aws_sam import mixins as sam_mixins

# custom_statements: Any

auth_property = sam_mixins.CfnFunctionPropsMixin.AuthProperty(
    api_key_required=False,
    authorization_scopes=["authorizationScopes"],
    authorizer="authorizer",
    resource_policy=sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.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.mixins_preview.aws_sam import mixins as sam_mixins

# custom_statements: Any

auth_resource_policy_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.BucketSAMPTProperty(*, bucket_name=None)

Bases: object

Parameters:: bucket_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

bucket_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.CloudWatchEventEventProperty(*, input=None, input_path=None, pattern=None)

Bases: object

Parameters:

input (Optional[str])
input_path (Optional[str])
pattern (Any)

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.mixins_preview.aws_sam import mixins as sam_mixins

# pattern: Any

cloud_watch_event_event_property = sam_mixins.CfnFunctionPropsMixin.CloudWatchEventEventProperty(
    input="input",
    input_path="inputPath",
    pattern=pattern
)

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 CfnFunctionPropsMixin.CloudWatchLogsEventProperty(*, filter_pattern=None, log_group_name=None)

Bases: object

Parameters:

filter_pattern (Optional[str])
log_group_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

cloud_watch_logs_event_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.CognitoEventProperty(*, trigger=None, user_pool=None)

Bases: object

Parameters:

trigger (Optional[str])
user_pool (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

cognito_event_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.CollectionSAMPTProperty(*, collection_id=None)

Bases: object

Parameters:: collection_id (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

collection_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.CorsConfigurationProperty(*, allow_credentials=None, allow_headers=None, allow_methods=None, allow_origin=None, max_age=None)

Bases: object

Parameters:

allow_credentials (Union[bool, IResolvable, None])
allow_headers (Optional[str])
allow_methods (Optional[str])
allow_origin (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.mixins_preview.aws_sam import mixins as sam_mixins

cors_configuration_property = sam_mixins.CfnFunctionPropsMixin.CorsConfigurationProperty(
    allow_credentials=False,
    allow_headers="allowHeaders",
    allow_methods="allowMethods",
    allow_origin="allowOrigin",
    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 CfnFunctionPropsMixin.DeadLetterQueueProperty(*, target_arn=None, type=None)

Bases: object

Parameters:

target_arn (Optional[str])
type (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

dead_letter_queue_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.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.mixins_preview.aws_sam import mixins as sam_mixins

deployment_preference_property = sam_mixins.CfnFunctionPropsMixin.DeploymentPreferenceProperty(
    alarms=["alarms"],
    enabled=False,
    hooks=sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.DestinationConfigProperty(*, on_failure=None)

Bases: object

Parameters:: on_failure (Union[IResolvable, DestinationProperty, Dict[str, Any], None])
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.mixins_preview.aws_sam import mixins as sam_mixins

destination_config_property = sam_mixins.CfnFunctionPropsMixin.DestinationConfigProperty(
    on_failure=sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
        destination="destination",
        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 CfnFunctionPropsMixin.DestinationProperty(*, destination=None, type=None)

Bases: object

Parameters:

destination (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

destination_property = sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
    destination="destination",
    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 CfnFunctionPropsMixin.DomainSAMPTProperty(*, domain_name=None)

Bases: object

Parameters:: domain_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

domain_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.DynamoDBEventProperty(*, 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, starting_position=None, stream=None)

Bases: object

Parameters:

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])
starting_position (Optional[str])
stream (Optional[str])

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.mixins_preview.aws_sam import mixins as sam_mixins

dynamo_dBEvent_property = sam_mixins.CfnFunctionPropsMixin.DynamoDBEventProperty(
    batch_size=123,
    bisect_batch_on_function_error=False,
    destination_config=sam_mixins.CfnFunctionPropsMixin.DestinationConfigProperty(
        on_failure=sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
            destination="destination",
            type="type"
        )
    ),
    enabled=False,
    maximum_batching_window_in_seconds=123,
    maximum_record_age_in_seconds=123,
    maximum_retry_attempts=123,
    parallelization_factor=123,
    starting_position="startingPosition",
    stream="stream"
)

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 CfnFunctionPropsMixin.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.mixins_preview.aws_sam import mixins as sam_mixins

empty_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.EmptySAMPTProperty()

EphemeralStorageProperty

class CfnFunctionPropsMixin.EphemeralStorageProperty(*, size=None)

Bases: object

Parameters:: size (Union[int, float, None])
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.mixins_preview.aws_sam import mixins as sam_mixins

ephemeral_storage_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.EventBridgeRuleEventProperty(*, event_bus_name=None, input=None, input_path=None, pattern=None)

Bases: object

Parameters:

event_bus_name (Optional[str])
input (Optional[str])
input_path (Optional[str])
pattern (Any)

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.mixins_preview.aws_sam import mixins as sam_mixins

# pattern: Any

event_bridge_rule_event_property = sam_mixins.CfnFunctionPropsMixin.EventBridgeRuleEventProperty(
    event_bus_name="eventBusName",
    input="input",
    input_path="inputPath",
    pattern=pattern
)

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 CfnFunctionPropsMixin.EventInvokeConfigProperty(*, destination_config=None, maximum_event_age_in_seconds=None, maximum_retry_attempts=None)

Bases: object

Parameters:

destination_config (Union[IResolvable, EventInvokeDestinationConfigProperty, Dict[str, Any], None])
maximum_event_age_in_seconds (Union[int, float, None])
maximum_retry_attempts (Union[int, float, None])

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.mixins_preview.aws_sam import mixins as sam_mixins

event_invoke_config_property = sam_mixins.CfnFunctionPropsMixin.EventInvokeConfigProperty(
    destination_config=sam_mixins.CfnFunctionPropsMixin.EventInvokeDestinationConfigProperty(
        on_failure=sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
            destination="destination",
            type="type"
        ),
        on_success=sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
            destination="destination",
            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 CfnFunctionPropsMixin.EventInvokeDestinationConfigProperty(*, on_failure=None, on_success=None)

Bases: object

Parameters:

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

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.mixins_preview.aws_sam import mixins as sam_mixins

event_invoke_destination_config_property = sam_mixins.CfnFunctionPropsMixin.EventInvokeDestinationConfigProperty(
    on_failure=sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
        destination="destination",
        type="type"
    ),
    on_success=sam_mixins.CfnFunctionPropsMixin.DestinationProperty(
        destination="destination",
        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 CfnFunctionPropsMixin.EventSourceProperty(*, properties=None, type=None)

Bases: object

Parameters:

properties (Union[IResolvable, AlexaSkillEventProperty, Dict[str, Any], ApiEventProperty, CloudWatchEventEventProperty, CloudWatchLogsEventProperty, CognitoEventProperty, DynamoDBEventProperty, EventBridgeRuleEventProperty, HttpApiEventProperty, IoTRuleEventProperty, KinesisEventProperty, S3EventProperty, ScheduleEventProperty, SNSEventProperty, SQSEventProperty, None])
type (Optional[str])

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.mixins_preview.aws_sam import mixins as sam_mixins

event_source_property = sam_mixins.CfnFunctionPropsMixin.EventSourceProperty(
    properties=sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.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.mixins_preview.aws_sam import mixins as sam_mixins

file_system_config_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.FunctionEnvironmentProperty(*, variables=None)

Bases: object

Parameters:: variables (Union[Mapping[str, str], IResolvable, None])
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.mixins_preview.aws_sam import mixins as sam_mixins

function_environment_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.FunctionSAMPTProperty(*, function_name=None)

Bases: object

Parameters:: function_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

function_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.FunctionUrlConfigProperty(*, auth_type=None, cors=None, invoke_mode=None)

Bases: object

Parameters:

auth_type (Optional[str])
cors (Union[str, IResolvable, CorsConfigurationProperty, Dict[str, Any], None])
invoke_mode (Optional[str])

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.mixins_preview.aws_sam import mixins as sam_mixins

function_url_config_property = sam_mixins.CfnFunctionPropsMixin.FunctionUrlConfigProperty(
    auth_type="authType",
    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 CfnFunctionPropsMixin.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.mixins_preview.aws_sam import mixins as sam_mixins

hooks_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.HttpApiEventProperty(*, api_id=None, auth=None, method=None, path=None, payload_format_version=None, route_settings=None, timeout_in_millis=None)

Bases: object

Parameters:

api_id (Optional[str])
auth (Union[IResolvable, HttpApiFunctionAuthProperty, Dict[str, Any], None])
method (Optional[str])
path (Optional[str])
payload_format_version (Optional[str])
route_settings (Union[IResolvable, RouteSettingsProperty, Dict[str, Any], None])
timeout_in_millis (Union[int, float, None])

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.mixins_preview.aws_sam import mixins as sam_mixins

http_api_event_property = sam_mixins.CfnFunctionPropsMixin.HttpApiEventProperty(
    api_id="apiId",
    auth=sam_mixins.CfnFunctionPropsMixin.HttpApiFunctionAuthProperty(
        authorization_scopes=["authorizationScopes"],
        authorizer="authorizer"
    ),
    method="method",
    path="path",
    payload_format_version="payloadFormatVersion",
    route_settings=sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.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.mixins_preview.aws_sam import mixins as sam_mixins

http_api_function_auth_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.IAMPolicyDocumentProperty(*, statement=None, 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.mixins_preview.aws_sam import mixins as sam_mixins

# statement: Any

i_aMPolicy_document_property = {
    "statement": statement,
    "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 CfnFunctionPropsMixin.IdentitySAMPTProperty(*, identity_name=None)

Bases: object

Parameters:: identity_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

identity_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.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.mixins_preview.aws_sam import mixins as sam_mixins

image_config_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.IoTRuleEventProperty(*, aws_iot_sql_version=None, sql=None)

Bases: object

Parameters:

aws_iot_sql_version (Optional[str])
sql (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.mixins_preview.aws_sam import mixins as sam_mixins

io_tRule_event_property = sam_mixins.CfnFunctionPropsMixin.IoTRuleEventProperty(
    aws_iot_sql_version="awsIotSqlVersion",
    sql="sql"
)

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 CfnFunctionPropsMixin.KeySAMPTProperty(*, key_id=None)

Bases: object

Parameters:: key_id (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

key_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.KinesisEventProperty(*, batch_size=None, enabled=None, function_response_types=None, starting_position=None, stream=None)

Bases: object

Parameters:

batch_size (Union[int, float, None])
enabled (Union[bool, IResolvable, None])
function_response_types (Optional[Sequence[str]])
starting_position (Optional[str])
stream (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

kinesis_event_property = sam_mixins.CfnFunctionPropsMixin.KinesisEventProperty(
    batch_size=123,
    enabled=False,
    function_response_types=["functionResponseTypes"],
    starting_position="startingPosition",
    stream="stream"
)

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 CfnFunctionPropsMixin.LogGroupSAMPTProperty(*, log_group_name=None)

Bases: object

Parameters:: log_group_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

log_group_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.ParameterNameSAMPTProperty(*, parameter_name=None)

Bases: object

Parameters:: parameter_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

parameter_name_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.ProvisionedConcurrencyConfigProperty(*, provisioned_concurrent_executions=None)

Bases: object

Parameters:: provisioned_concurrent_executions (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

provisioned_concurrency_config_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.QueueSAMPTProperty(*, queue_name=None)

Bases: object

Parameters:: queue_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

queue_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.RequestModelProperty(*, model=None, required=None, validate_body=None, validate_parameters=None)

Bases: object

Parameters:

model (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

request_model_property = sam_mixins.CfnFunctionPropsMixin.RequestModelProperty(
    model="model",
    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 CfnFunctionPropsMixin.RequestParameterProperty(*, caching=None, required=None)

Bases: object

Parameters:

caching (Union[bool, IResolvable, None])
required (Union[bool, IResolvable, None])

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.mixins_preview.aws_sam import mixins as sam_mixins

request_parameter_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.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.mixins_preview.aws_sam import mixins as sam_mixins

route_settings_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.S3EventProperty(*, bucket=None, events=None, filter=None)

Bases: object

Parameters:

bucket (Optional[str])
events (Optional[str])
filter (Union[IResolvable, S3NotificationFilterProperty, Dict[str, Any], None])

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.mixins_preview.aws_sam import mixins as sam_mixins

s3_event_property = sam_mixins.CfnFunctionPropsMixin.S3EventProperty(
    bucket="bucket",
    events="events",
    filter=sam_mixins.CfnFunctionPropsMixin.S3NotificationFilterProperty(
        s3_key=sam_mixins.CfnFunctionPropsMixin.S3KeyFilterProperty(
            rules=[sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.S3KeyFilterProperty(*, rules=None)

Bases: object

Parameters:: rules (Union[IResolvable, Sequence[Union[IResolvable, S3KeyFilterRuleProperty, Dict[str, Any]]], None])
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.mixins_preview.aws_sam import mixins as sam_mixins

s3_key_filter_property = sam_mixins.CfnFunctionPropsMixin.S3KeyFilterProperty(
    rules=[sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.S3KeyFilterRuleProperty(*, name=None, value=None)

Bases: object

Parameters:

name (Optional[str])
value (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

s3_key_filter_rule_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.S3LocationProperty(*, bucket=None, key=None, version=None)

Bases: object

Parameters:

bucket (Optional[str])
key (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

s3_location_property = sam_mixins.CfnFunctionPropsMixin.S3LocationProperty(
    bucket="bucket",
    key="key",
    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 CfnFunctionPropsMixin.S3NotificationFilterProperty(*, s3_key=None)

Bases: object

Parameters:: s3_key (Union[IResolvable, S3KeyFilterProperty, Dict[str, Any], None])
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.mixins_preview.aws_sam import mixins as sam_mixins

s3_notification_filter_property = sam_mixins.CfnFunctionPropsMixin.S3NotificationFilterProperty(
    s3_key=sam_mixins.CfnFunctionPropsMixin.S3KeyFilterProperty(
        rules=[sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.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:

ami_describe_policy (Union[IResolvable, EmptySAMPTProperty, Dict[str, Any], None])
aws_secrets_manager_get_secret_value_policy (Union[IResolvable, SecretArnSAMPTProperty, Dict[str, Any], None])
cloud_formation_describe_stacks_policy (Union[IResolvable, EmptySAMPTProperty, Dict[str, Any], None])
cloud_watch_put_metric_policy (Union[IResolvable, EmptySAMPTProperty, Dict[str, Any], None])
dynamo_db_crud_policy (Union[IResolvable, TableSAMPTProperty, Dict[str, Any], None])
dynamo_db_read_policy (Union[IResolvable, TableSAMPTProperty, Dict[str, Any], None])
dynamo_db_stream_read_policy (Union[IResolvable, TableStreamSAMPTProperty, Dict[str, Any], None])
dynamo_db_write_policy (Union[IResolvable, TableSAMPTProperty, Dict[str, Any], None])
ec2_describe_policy (Union[IResolvable, EmptySAMPTProperty, Dict[str, Any], None])
elasticsearch_http_post_policy (Union[IResolvable, DomainSAMPTProperty, Dict[str, Any], None])
filter_log_events_policy (Union[IResolvable, LogGroupSAMPTProperty, Dict[str, Any], None])
kinesis_crud_policy (Union[IResolvable, StreamSAMPTProperty, Dict[str, Any], None])
kinesis_stream_read_policy (Union[IResolvable, StreamSAMPTProperty, Dict[str, Any], None])
kms_decrypt_policy (Union[IResolvable, KeySAMPTProperty, Dict[str, Any], None])
lambda_invoke_policy (Union[IResolvable, FunctionSAMPTProperty, Dict[str, Any], None])
rekognition_detect_only_policy (Union[IResolvable, EmptySAMPTProperty, Dict[str, Any], None])
rekognition_labels_policy (Union[IResolvable, EmptySAMPTProperty, Dict[str, Any], None])
rekognition_no_data_access_policy (Union[IResolvable, CollectionSAMPTProperty, Dict[str, Any], None])
rekognition_read_policy (Union[IResolvable, CollectionSAMPTProperty, Dict[str, Any], None])
rekognition_write_only_access_policy (Union[IResolvable, CollectionSAMPTProperty, Dict[str, Any], None])
s3_crud_policy (Union[IResolvable, BucketSAMPTProperty, Dict[str, Any], None])
s3_read_policy (Union[IResolvable, BucketSAMPTProperty, Dict[str, Any], None])
s3_write_policy (Union[IResolvable, BucketSAMPTProperty, Dict[str, Any], None])
ses_bulk_templated_crud_policy (Union[IResolvable, IdentitySAMPTProperty, Dict[str, Any], None])
ses_crud_policy (Union[IResolvable, IdentitySAMPTProperty, Dict[str, Any], None])
ses_email_template_crud_policy (Union[IResolvable, EmptySAMPTProperty, Dict[str, Any], None])
ses_send_bounce_policy (Union[IResolvable, IdentitySAMPTProperty, Dict[str, Any], None])
sns_crud_policy (Union[IResolvable, TopicSAMPTProperty, Dict[str, Any], None])
sns_publish_message_policy (Union[IResolvable, TopicSAMPTProperty, Dict[str, Any], None])
sqs_poller_policy (Union[IResolvable, QueueSAMPTProperty, Dict[str, Any], None])
sqs_send_message_policy (Union[IResolvable, QueueSAMPTProperty, Dict[str, Any], None])
ssm_parameter_read_policy (Union[IResolvable, ParameterNameSAMPTProperty, Dict[str, Any], None])
step_functions_execution_policy (Union[IResolvable, StateMachineSAMPTProperty, Dict[str, Any], None])
vpc_access_policy (Union[IResolvable, EmptySAMPTProperty, Dict[str, Any], None])

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.mixins_preview.aws_sam import mixins as sam_mixins

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

Bases: object

Parameters:: topic (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

s_nSEvent_property = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.SQSEventProperty(*, batch_size=None, enabled=None, queue=None)

Bases: object

Parameters:

batch_size (Union[int, float, None])
enabled (Union[bool, IResolvable, None])
queue (Optional[str])

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.mixins_preview.aws_sam import mixins as sam_mixins

s_qSEvent_property = sam_mixins.CfnFunctionPropsMixin.SQSEventProperty(
    batch_size=123,
    enabled=False,
    queue="queue"
)

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 CfnFunctionPropsMixin.ScheduleEventProperty(*, description=None, enabled=None, input=None, name=None, schedule=None)

Bases: object

Parameters:

description (Optional[str])
enabled (Union[bool, IResolvable, None])
input (Optional[str])
name (Optional[str])
schedule (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.mixins_preview.aws_sam import mixins as sam_mixins

schedule_event_property = sam_mixins.CfnFunctionPropsMixin.ScheduleEventProperty(
    description="description",
    enabled=False,
    input="input",
    name="name",
    schedule="schedule"
)

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 CfnFunctionPropsMixin.SecretArnSAMPTProperty(*, secret_arn=None)

Bases: object

Parameters:: secret_arn (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

secret_arn_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.StateMachineSAMPTProperty(*, state_machine_name=None)

Bases: object

Parameters:: state_machine_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

state_machine_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.StreamSAMPTProperty(*, stream_name=None)

Bases: object

Parameters:: stream_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

stream_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.TableSAMPTProperty(*, table_name=None)

Bases: object

Parameters:: table_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

table_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.TableStreamSAMPTProperty(*, stream_name=None, table_name=None)

Bases: object

Parameters:

stream_name (Optional[str])
table_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

table_stream_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.TopicSAMPTProperty(*, topic_name=None)

Bases: object

Parameters:: topic_name (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

topic_sAMPTProperty = sam_mixins.CfnFunctionPropsMixin.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 CfnFunctionPropsMixin.VpcConfigProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

Parameters:

security_group_ids (Optional[Sequence[str]])
subnet_ids (Optional[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.mixins_preview.aws_sam import mixins as sam_mixins

vpc_config_property = sam_mixins.CfnFunctionPropsMixin.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