CfnAliasPropsMixin

class aws_cdk.mixins_preview.aws_lambda.mixins.CfnAliasPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Lambda::Alias resource creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html
CloudformationResource:: AWS::Lambda::Alias
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_lambda import mixins as lambda_mixins

cfn_alias_props_mixin = lambda_mixins.CfnAliasPropsMixin(lambda_mixins.CfnAliasMixinProps(
    description="description",
    function_name="functionName",
    function_version="functionVersion",
    name="name",
    provisioned_concurrency_config=lambda_mixins.CfnAliasPropsMixin.ProvisionedConcurrencyConfigurationProperty(
        provisioned_concurrent_executions=123
    ),
    routing_config=lambda_mixins.CfnAliasPropsMixin.AliasRoutingConfigurationProperty(
        additional_version_weights=[lambda_mixins.CfnAliasPropsMixin.VersionWeightProperty(
            function_version="functionVersion",
            function_weight=123
        )]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Lambda::Alias.

Parameters:

props (Union[CfnAliasMixinProps, 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 = ['description', 'functionName', 'functionVersion', 'name', 'provisionedConcurrencyConfig', 'routingConfig']

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

AliasRoutingConfigurationProperty

class CfnAliasPropsMixin.AliasRoutingConfigurationProperty(*, additional_version_weights=None)

Bases: object

The traffic-shifting configuration of a Lambda function alias.

Parameters:: additional_version_weights (Union[IResolvable, Sequence[Union[IResolvable, VersionWeightProperty, Dict[str, Any]]], None]) – The second version, and the percentage of traffic that’s routed to it.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.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_lambda import mixins as lambda_mixins

alias_routing_configuration_property = lambda_mixins.CfnAliasPropsMixin.AliasRoutingConfigurationProperty(
    additional_version_weights=[lambda_mixins.CfnAliasPropsMixin.VersionWeightProperty(
        function_version="functionVersion",
        function_weight=123
    )]
)

Attributes

additional_version_weights

The second version, and the percentage of traffic that’s routed to it.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html#cfn-lambda-alias-aliasroutingconfiguration-additionalversionweights

ProvisionedConcurrencyConfigurationProperty

class CfnAliasPropsMixin.ProvisionedConcurrencyConfigurationProperty(*, provisioned_concurrent_executions=None)

Bases: object

A provisioned concurrency configuration for a function’s alias.

Parameters:: provisioned_concurrent_executions (Union[int, float, None]) – The amount of provisioned concurrency to allocate for the alias.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.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_lambda import mixins as lambda_mixins

provisioned_concurrency_configuration_property = lambda_mixins.CfnAliasPropsMixin.ProvisionedConcurrencyConfigurationProperty(
    provisioned_concurrent_executions=123
)

Attributes

provisioned_concurrent_executions

The amount of provisioned concurrency to allocate for the alias.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html#cfn-lambda-alias-provisionedconcurrencyconfiguration-provisionedconcurrentexecutions

VersionWeightProperty

class CfnAliasPropsMixin.VersionWeightProperty(*, function_version=None, function_weight=None)

Bases: object

The traffic-shifting configuration of a Lambda function alias.

Parameters:

function_version (Optional[str]) – The qualifier of the second version.
function_weight (Union[int, float, None]) – The percentage of traffic that the alias routes to the second version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.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_lambda import mixins as lambda_mixins

version_weight_property = lambda_mixins.CfnAliasPropsMixin.VersionWeightProperty(
    function_version="functionVersion",
    function_weight=123
)

Attributes

function_version

The qualifier of the second version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionversion

function_weight

The percentage of traffic that the alias routes to the second version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionweight