Package 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.97.0 (build 729de35)", date="2024-04-24T21:00:27.161Z") @Stability(Stable) public interface LambdaDeploymentGroupProps extends software.amazon.jsii.JsiiSerializable
Construction properties for LambdaDeploymentGroup.

Example: 

 LambdaApplication myApplication;
 Function func;
 Version version = func.getCurrentVersion();
 Alias version1Alias = Alias.Builder.create(this, "alias")
         .aliasName("prod")
         .version(version)
         .build();
 LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment")
         .application(myApplication) // optional property: one will be created for you if not provided
         .alias(version1Alias)
         .deploymentConfig(LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE)
         .build();

  • Method Details

    • getAlias

      @Stability(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(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 #addAlarm method.

      Default: []

      See Also:

    • getApplication

      @Stability(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(Stable) @Nullable default AutoRollbackConfig getAutoRollback()
      The auto-rollback configuration for this Deployment Group.

      Default: - default AutoRollbackConfig.

    • getDeploymentConfig

      @Stability(Stable) @Nullable default ILambdaDeploymentConfig getDeploymentConfig()
      The Deployment Configuration this Deployment Group uses.

      Default: LambdaDeploymentConfig.CANARY_10PERCENT_5MINUTES

    • getDeploymentGroupName

      @Stability(Stable) @Nullable default String getDeploymentGroupName()
      The physical, human-readable name of the CodeDeploy Deployment Group.

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

    • getIgnoreAlarmConfiguration

      @Stability(Stable) @Nullable default Boolean getIgnoreAlarmConfiguration()
      Whether to skip the step of checking CloudWatch alarms during the deployment process.

      Default: - false

    • getIgnorePollAlarmsFailure

      @Stability(Stable) @Nullable default Boolean getIgnorePollAlarmsFailure()
      Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

      Default: false

    • getPostHook

      @Stability(Stable) @Nullable default IFunction getPostHook()
      The Lambda function to run after traffic routing starts.

      Default: - None.

    • getPreHook

      @Stability(Stable) @Nullable default IFunction getPreHook()
      The Lambda function to run before traffic routing starts.

      Default: - None.

    • getRole

      @Stability(Stable) @Nullable default IRole getRole()
      The service Role of this Deployment Group.

      Default: - A new Role will be created.

    • builder

      @Stability(Stable) static LambdaDeploymentGroupProps.Builder builder()
      Returns:
      a LambdaDeploymentGroupProps.Builder of LambdaDeploymentGroupProps