Interface ICfnAliasProps

Properties for defining a CfnAlias.

Namespace: Amazon.CDK.AWS.Lambda

Assembly: Amazon.CDK.AWS.Lambda.dll

Syntax (csharp)

public interface ICfnAliasProps

Syntax (vb)

Public Interface ICfnAliasProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var cfnAliasProps = new CfnAliasProps {
    FunctionName = "functionName",
    FunctionVersion = "functionVersion",
    Name = "name",

    // the properties below are optional
    Description = "description",
    ProvisionedConcurrencyConfig = new ProvisionedConcurrencyConfigurationProperty {
        ProvisionedConcurrentExecutions = 123
    },
    RoutingConfig = new AliasRoutingConfigurationProperty {
        AdditionalVersionWeights = new [] { new VersionWeightProperty {
            FunctionVersion = "functionVersion",
            FunctionWeight = 123
        } }
    }
};

Synopsis

Properties

Description	A description of the alias.
FunctionName	The name of the Lambda function.
FunctionVersion	The function version that the alias invokes.
Name	The name of the alias.
ProvisionedConcurrencyConfig	Specifies a provisioned concurrency configuration for a function's alias.
RoutingConfig	The routing configuration of the alias.

Properties

Description

A description of the alias.

virtual string Description { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description

FunctionName

The name of the Lambda function.

string FunctionName { get; }

Property Value

System.String

Remarks

Name formats - Function name - MyFunction .

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname

FunctionVersion

The function version that the alias invokes.

string FunctionVersion { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion

Name

The name of the alias.

string Name { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name

ProvisionedConcurrencyConfig

Specifies a provisioned concurrency configuration for a function's alias.

virtual object ProvisionedConcurrencyConfig { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig

RoutingConfig

The routing configuration of the alias.

virtual object RoutingConfig { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig