software.amazon.awscdk.services.codedeploy

Interface LambdaDeploymentGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LambdaDeploymentGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.15.0 (build 585166b)",
           date="2020-12-12T01:56:51.998Z")
 @Stability(value=Stable)
public interface LambdaDeploymentGroupProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for LambdaDeploymentGroup.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LambdaDeploymentGroupProps.Builder A builder for LambdaDeploymentGroupProps
static class	LambdaDeploymentGroupProps.Jsii$Proxy An implementation for LambdaDeploymentGroupProps

Method Summary

Modifier and Type	Method and Description
static LambdaDeploymentGroupProps.Builder	builder()
default List<IAlarm>	getAlarms() The CloudWatch alarms associated with this Deployment Group.
Alias	getAlias() Lambda Alias to shift traffic.
default ILambdaApplication	getApplication() The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.
default AutoRollbackConfig	getAutoRollback() The auto-rollback configuration for this Deployment Group.
default ILambdaDeploymentConfig	getDeploymentConfig() The Deployment Configuration this Deployment Group uses.
default String	getDeploymentGroupName() The physical, human-readable name of the CodeDeploy Deployment Group.
default Boolean	getIgnorePollAlarmsFailure() Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
default IFunction	getPostHook() The Lambda function to run after traffic routing starts.
default IFunction	getPreHook() The Lambda function to run before traffic routing starts.
default IRole	getRole() The service Role of this Deployment Group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlias

@Stability(value=Stable)
 @NotNull
Alias getAlias()

Lambda Alias to shift traffic. Updating the version of the alias will trigger a CodeDeploy deployment.

[disable-awslint:ref-via-interface] since we need to modify the alias CFN resource update policy

getAlarms

@Stability(value=Stable)
 @Nullable
default List<IAlarm> getAlarms()

The CloudWatch alarms associated with this Deployment Group.

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 Also:

https://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-create-alarms.html

getApplication

@Stability(value=Stable)
 @Nullable
default ILambdaApplication getApplication()

The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.

Default: - One will be created for you.

getAutoRollback

@Stability(value=Stable)
 @Nullable
default AutoRollbackConfig getAutoRollback()

The auto-rollback configuration for this Deployment Group.

Default: - default AutoRollbackConfig.

getDeploymentConfig

@Stability(value=Stable)
 @Nullable
default ILambdaDeploymentConfig getDeploymentConfig()

The Deployment Configuration this Deployment Group uses.

Default: LambdaDeploymentConfig.CANARY_10PERCENT_5MINUTES

getDeploymentGroupName

@Stability(value=Stable)
 @Nullable
default String getDeploymentGroupName()

The physical, human-readable name of the CodeDeploy Deployment Group.

Default: - An auto-generated name will be used.

getIgnorePollAlarmsFailure

@Stability(value=Stable)
 @Nullable
default Boolean getIgnorePollAlarmsFailure()

Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

Default: false

getPostHook

@Stability(value=Stable)
 @Nullable
default IFunction getPostHook()

The Lambda function to run after traffic routing starts.

Default: - None.

getPreHook

@Stability(value=Stable)
 @Nullable
default IFunction getPreHook()

The Lambda function to run before traffic routing starts.

Default: - None.

getRole

@Stability(value=Stable)
 @Nullable
default IRole getRole()

The service Role of this Deployment Group.

Default: - A new Role will be created.

builder

@Stability(value=Stable)
static LambdaDeploymentGroupProps.Builder builder()

Returns:

a LambdaDeploymentGroupProps.Builder of LambdaDeploymentGroupProps