Interface IAliasOptions

Options for lambda.Alias.

Inherited Members
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IAliasOptions : IEventInvokeConfigOptions
Syntax (vb)
Public Interface IAliasOptions Inherits IEventInvokeConfigOptions
Remarks

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;
            using Amazon.CDK.AWS.Lambda;

            IDestination destination;
            Version version;

            var aliasOptions = new AliasOptions {
                AdditionalVersions = new [] { new VersionWeight {
                    Version = version,
                    Weight = 123
                } },
                Description = "description",
                MaxEventAge = Duration.Minutes(30),
                OnFailure = destination,
                OnSuccess = destination,
                ProvisionedConcurrentExecutions = 123,
                RetryAttempts = 123
            };

Synopsis

Properties

AdditionalVersions

Additional versions with individual weights this alias points to.
Description

Description for the alias.
ProvisionedConcurrentExecutions

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

Properties

AdditionalVersions

Additional versions with individual weights this alias points to.

IVersionWeight[]? AdditionalVersions { get; }
Property Value

IVersionWeight[]

Remarks

Individual additional version weights specified here should add up to (less than) one. All remaining weight is routed to the default version.

For example, the config is

version: "1" additionalVersions: [{ version: "2", weight: 0.05 }]

Then 5% of traffic will be routed to function version 2, while the remaining 95% of traffic will be routed to function version 1.

Default: No additional versions

Description

Description for the alias.

string? Description { get; }
Property Value

string

Remarks

Default: No description

ProvisionedConcurrentExecutions

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

double? ProvisionedConcurrentExecutions { get; }
Property Value

double?

Remarks

Default: No provisioned concurrency