Class LambdaDeploymentGroupProps
Construction properties for {@link LambdaDeploymentGroup}.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodeDeploy
Assembly: Amazon.CDK.AWS.CodeDeploy.dll
Syntax (csharp)
public class LambdaDeploymentGroupProps : Object, ILambdaDeploymentGroupProps
Syntax (vb)
Public Class LambdaDeploymentGroupProps
Inherits Object
Implements ILambdaDeploymentGroupProps
Remarks
ExampleMetadata: infused
Examples
LambdaApplication application;
Alias alias;
var config = new CustomLambdaDeploymentConfig(this, "CustomConfig", new CustomLambdaDeploymentConfigProps {
Type = CustomLambdaDeploymentConfigType.CANARY,
Interval = Duration.Minutes(1),
Percentage = 5
});
var deploymentGroup = new LambdaDeploymentGroup(this, "BlueGreenDeployment", new LambdaDeploymentGroupProps {
Application = application,
Alias = alias,
DeploymentConfig = config
});
Synopsis
Constructors
LambdaDeploymentGroupProps() |
Properties
Alarms | The CloudWatch alarms associated with this Deployment Group. |
Alias | Lambda Alias to shift traffic. Updating the version of the alias will trigger a CodeDeploy deployment. |
Application | The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to. |
AutoRollback | The auto-rollback configuration for this Deployment Group. |
DeploymentConfig | The Deployment Configuration this Deployment Group uses. |
DeploymentGroupName | The physical, human-readable name of the CodeDeploy Deployment Group. |
IgnorePollAlarmsFailure | Whether to continue a deployment even if fetching the alarm status from CloudWatch failed. |
PostHook | The Lambda function to run after traffic routing starts. |
PreHook | The Lambda function to run before traffic routing starts. |
Role | The service Role of this Deployment Group. |
Constructors
LambdaDeploymentGroupProps()
public LambdaDeploymentGroupProps()
Properties
Alarms
The CloudWatch alarms associated with this Deployment Group.
public IAlarm[] Alarms { get; set; }
Property Value
IAlarm[]
Remarks
CodeDeploy will stop (and optionally roll back) a deployment if during it any of the alarms trigger.
Alarms can also be added after the Deployment Group is created using the {@link #addAlarm} method.
Default: []
See: https://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-create-alarms.html
Alias
Lambda Alias to shift traffic. Updating the version of the alias will trigger a CodeDeploy deployment.
public Alias Alias { get; set; }
Property Value
Remarks
[disable-awslint:ref-via-interface] since we need to modify the alias CFN resource update policy
Application
The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.
public ILambdaApplication Application { get; set; }
Property Value
Remarks
Default: - One will be created for you.
AutoRollback
The auto-rollback configuration for this Deployment Group.
public IAutoRollbackConfig AutoRollback { get; set; }
Property Value
Remarks
Default: - default AutoRollbackConfig.
DeploymentConfig
The Deployment Configuration this Deployment Group uses.
public ILambdaDeploymentConfig DeploymentConfig { get; set; }
Property Value
Remarks
Default: LambdaDeploymentConfig.CANARY_10PERCENT_5MINUTES
DeploymentGroupName
The physical, human-readable name of the CodeDeploy Deployment Group.
public string DeploymentGroupName { get; set; }
Property Value
System.String
Remarks
Default: - An auto-generated name will be used.
IgnorePollAlarmsFailure
Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
public Nullable<bool> IgnorePollAlarmsFailure { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
PostHook
The Lambda function to run after traffic routing starts.
public IFunction PostHook { get; set; }
Property Value
Remarks
Default: - None.
PreHook
The Lambda function to run before traffic routing starts.
public IFunction PreHook { get; set; }
Property Value
Remarks
Default: - None.
Role
The service Role of this Deployment Group.
public IRole Role { get; set; }
Property Value
Remarks
Default: - A new Role will be created.