Class CfnAlias
A CloudFormation AWS::Lambda::Alias
.
Inherited Members
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.AWS.Lambda.dll
Syntax (csharp)
public class CfnAlias : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAlias
Inherits CfnResource
Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Lambda::Alias
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;
CfnAlias cfnAlias = new CfnAlias(this, "MyCfnAlias", 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
Constructors
CfnAlias(Construct, String, ICfnAliasProps) | Create a new |
CfnAlias(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAlias(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAlias(Construct, String, ICfnAliasProps)
Create a new AWS::Lambda::Alias
.
public CfnAlias(Construct scope, string id, ICfnAliasProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAliasProps
- resource properties.
CfnAlias(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAlias(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAlias(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAlias(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the alias.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
FunctionName
The name of the Lambda function.
public virtual string FunctionName { get; set; }
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.
FunctionVersion
The function version that the alias invokes.
public virtual string FunctionVersion { get; set; }
Property Value
System.String
Remarks
Name
The name of the alias.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
ProvisionedConcurrencyConfig
Specifies a provisioned concurrency configuration for a function's alias.
public virtual object ProvisionedConcurrencyConfig { get; set; }
Property Value
System.Object
Remarks
RoutingConfig
The routing configuration of the alias.
public virtual object RoutingConfig { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>