software.amazon.awscdk.services.codedeploy

Class LambdaDeploymentGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.codedeploy.LambdaDeploymentGroup

All Implemented Interfaces:

IDependable, IResource, ILambdaDeploymentGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-05-04T20:14:15.351Z")
 @Stability(value=Stable)
public class LambdaDeploymentGroup
extends Resource
implements ILambdaDeploymentGroup

Example:

 LambdaApplication application;
 Alias alias;
 CustomLambdaDeploymentConfig config = CustomLambdaDeploymentConfig.Builder.create(this, "CustomConfig")
         .type(CustomLambdaDeploymentConfigType.CANARY)
         .interval(Duration.minutes(1))
         .percentage(5)
         .build();
 LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment")
         .application(application)
         .alias(alias)
         .deploymentConfig(config)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LambdaDeploymentGroup.Builder A fluent builder for LambdaDeploymentGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codedeploy.ILambdaDeploymentGroup

ILambdaDeploymentGroup.Jsii$Default, ILambdaDeploymentGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	LambdaDeploymentGroup(software.constructs.Construct scope, String id, LambdaDeploymentGroupProps props)
protected	LambdaDeploymentGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LambdaDeploymentGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addAlarm(IAlarm alarm) Associates an additional alarm with this Deployment Group.
void	addPostHook(IFunction postHook) Associate a function to run after deployment completes.
void	addPreHook(IFunction preHook) Associate a function to run before deployment begins.
static ILambdaDeploymentGroup	fromLambdaDeploymentGroupAttributes(software.constructs.Construct scope, String id, LambdaDeploymentGroupAttributes attrs) Import an Lambda Deployment Group defined either outside the CDK app, or in a different AWS region.
ILambdaApplication	getApplication() The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.
ILambdaDeploymentConfig	getDeploymentConfig() The Deployment Configuration this Group uses.
String	getDeploymentGroupArn() The ARN of this Deployment Group.
String	getDeploymentGroupName() The physical name of the CodeDeploy Deployment Group.
IRole	getRole()
Grant	grantPutLifecycleEventHookExecutionStatus(IGrantable grantee) Grant a principal permission to codedeploy:PutLifecycleEventHookExecutionStatus on this deployment group resource.
protected List<String>	validate() Validate the current construct.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

LambdaDeploymentGroup

protected LambdaDeploymentGroup(software.amazon.jsii.JsiiObjectRef objRef)

LambdaDeploymentGroup

protected LambdaDeploymentGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LambdaDeploymentGroup

@Stability(value=Stable)
public LambdaDeploymentGroup(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      LambdaDeploymentGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromLambdaDeploymentGroupAttributes

@Stability(value=Stable)
 @NotNull
public static ILambdaDeploymentGroup fromLambdaDeploymentGroupAttributes(@NotNull
                                                                                                            software.constructs.Construct scope,
                                                                                                            @NotNull
                                                                                                            String id,
                                                                                                            @NotNull
                                                                                                            LambdaDeploymentGroupAttributes attrs)

Import an Lambda Deployment Group defined either outside the CDK app, or in a different AWS region.

Parameters:

scope - the parent Construct for this new Construct. This parameter is required.

id - the logical ID of this new Construct. This parameter is required.

attrs - the properties of the referenced Deployment Group. This parameter is required.

Returns:

a Construct representing a reference to an existing Deployment Group

addAlarm

@Stability(value=Stable)
public void addAlarm(@NotNull
                                              IAlarm alarm)

Associates an additional alarm with this Deployment Group.

Parameters:

alarm - the alarm to associate with this Deployment Group. This parameter is required.

addPostHook

@Stability(value=Stable)
public void addPostHook(@NotNull
                                                 IFunction postHook)

Associate a function to run after deployment completes.

Parameters:

postHook - function to run after deployment completes. This parameter is required.

addPreHook

@Stability(value=Stable)
public void addPreHook(@NotNull
                                                IFunction preHook)

Associate a function to run before deployment begins.

Parameters:

preHook - function to run before deployment beings. This parameter is required.

grantPutLifecycleEventHookExecutionStatus

@Stability(value=Stable)
 @NotNull
public Grant grantPutLifecycleEventHookExecutionStatus(@NotNull
                                                                                          IGrantable grantee)

Grant a principal permission to codedeploy:PutLifecycleEventHookExecutionStatus on this deployment group resource.

Parameters:

grantee - to grant permission to. This parameter is required.

validate

@Stability(value=Stable)
 @NotNull
protected List<String> validate()

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

validate in class Construct

getApplication

@Stability(value=Stable)
 @NotNull
public ILambdaApplication getApplication()

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

Specified by:

getApplication in interface ILambdaDeploymentGroup

getDeploymentConfig

@Stability(value=Stable)
 @NotNull
public ILambdaDeploymentConfig getDeploymentConfig()

The Deployment Configuration this Group uses.

Specified by:

getDeploymentConfig in interface ILambdaDeploymentGroup

getDeploymentGroupArn

@Stability(value=Stable)
 @NotNull
public String getDeploymentGroupArn()

The ARN of this Deployment Group.

Specified by:

getDeploymentGroupArn in interface ILambdaDeploymentGroup

getDeploymentGroupName

@Stability(value=Stable)
 @NotNull
public String getDeploymentGroupName()

The physical name of the CodeDeploy Deployment Group.

Specified by:

getDeploymentGroupName in interface ILambdaDeploymentGroup

getRole

@Stability(value=Stable)
 @NotNull
public IRole getRole()