Package 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:
IConstruct, IDependable, IResource, ILambdaDeploymentGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.382Z") @Stability(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();

  • Constructor Details

    • LambdaDeploymentGroup

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

    • LambdaDeploymentGroup

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

    • LambdaDeploymentGroup

      @Stability(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 Details

    • fromLambdaDeploymentGroupAttributes

      @Stability(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(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(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(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(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(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
      Returns:
      An array of validation error messages, or an empty array if the construct is valid.

    • getApplication

      @Stability(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(Stable) @NotNull public ILambdaDeploymentConfig getDeploymentConfig()
      The Deployment Configuration this Group uses.
      Specified by:
      getDeploymentConfig in interface ILambdaDeploymentGroup

    • getDeploymentGroupArn

      @Stability(Stable) @NotNull public String getDeploymentGroupArn()
      The ARN of this Deployment Group.
      Specified by:
      getDeploymentGroupArn in interface ILambdaDeploymentGroup

    • getDeploymentGroupName

      @Stability(Stable) @NotNull public String getDeploymentGroupName()
      The physical name of the CodeDeploy Deployment Group.
      Specified by:
      getDeploymentGroupName in interface ILambdaDeploymentGroup

    • getRole

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