Package software.amazon.awscdk

Class CfnCodeDeployBlueGreenHook

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnHook
software.amazon.awscdk.CfnCodeDeployBlueGreenHook
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:30.823Z") @Stability(Stable) public class CfnCodeDeployBlueGreenHook extends CfnHook
A CloudFormation Hook for CodeDeploy blue-green ECS deployments.

Example: 

 CfnInclude cfnTemplate;
 // mutating the hook
 Role myRole;
 CfnHook hook = cfnTemplate.getHook("MyOutput");
 CfnCodeDeployBlueGreenHook codeDeployHook = (CfnCodeDeployBlueGreenHook)hook;
 codeDeployHook.getServiceRole() = myRole.getRoleArn();

See Also:

  • Constructor Details

    • CfnCodeDeployBlueGreenHook

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

    • CfnCodeDeployBlueGreenHook

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

    • CfnCodeDeployBlueGreenHook

      @Stability(Stable) public CfnCodeDeployBlueGreenHook(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCodeDeployBlueGreenHookProps props)
      Creates a new CodeDeploy blue-green ECS Hook.

      Parameters:
      scope - the scope to create the hook in (usually the containing Stack object). This parameter is required.
      id - the identifier of the construct - will be used to generate the logical ID of the Hook. This parameter is required.
      props - the properties of the Hook. This parameter is required.

  • Method Details

    • renderProperties

      @Stability(Stable) @Nullable protected Map<String,Object> renderProperties(@Nullable Map<String,Object> _props)
      Overrides:
      renderProperties in class CfnHook
      Parameters:
      _props -

    • renderProperties

      @Stability(Stable) @Nullable protected Map<String,Object> renderProperties()
      Overrides:
      renderProperties in class CfnHook

    • getApplications

      @Stability(Stable) @NotNull public List<CfnCodeDeployBlueGreenApplication> getApplications()
      Properties of the Amazon ECS applications being deployed.

    • setApplications

      @Stability(Stable) public void setApplications(@NotNull List<CfnCodeDeployBlueGreenApplication> value)
      Properties of the Amazon ECS applications being deployed.

    • getServiceRole

      @Stability(Stable) @NotNull public String getServiceRole()
      The IAM Role for CloudFormation to use to perform blue-green deployments.

    • setServiceRole

      @Stability(Stable) public void setServiceRole(@NotNull String value)
      The IAM Role for CloudFormation to use to perform blue-green deployments.

    • getAdditionalOptions

      @Stability(Stable) @Nullable public CfnCodeDeployBlueGreenAdditionalOptions getAdditionalOptions()
      Additional options for the blue/green deployment.

      Default: - no additional options

    • setAdditionalOptions

      @Stability(Stable) public void setAdditionalOptions(@Nullable CfnCodeDeployBlueGreenAdditionalOptions value)
      Additional options for the blue/green deployment.

      Default: - no additional options

    • getLifecycleEventHooks

      @Stability(Stable) @Nullable public CfnCodeDeployBlueGreenLifecycleEventHooks getLifecycleEventHooks()
      Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment.

      You can use the same function or a different one for deployment lifecycle events. Following completion of the validation tests, the Lambda CfnCodeDeployBlueGreenLifecycleEventHooks.afterAllowTraffic function calls back CodeDeploy and delivers a result of 'Succeeded' or 'Failed'.

      Default: - no lifecycle event hooks

    • setLifecycleEventHooks

      @Stability(Stable) public void setLifecycleEventHooks(@Nullable CfnCodeDeployBlueGreenLifecycleEventHooks value)
      Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment.

      You can use the same function or a different one for deployment lifecycle events. Following completion of the validation tests, the Lambda CfnCodeDeployBlueGreenLifecycleEventHooks.afterAllowTraffic function calls back CodeDeploy and delivers a result of 'Succeeded' or 'Failed'.

      Default: - no lifecycle event hooks

    • getTrafficRoutingConfig

      @Stability(Stable) @Nullable public CfnTrafficRoutingConfig getTrafficRoutingConfig()
      Traffic routing configuration settings.

      Default: - time-based canary traffic shifting, with a 15% step percentage and a five minute bake time

    • setTrafficRoutingConfig

      @Stability(Stable) public void setTrafficRoutingConfig(@Nullable CfnTrafficRoutingConfig value)
      Traffic routing configuration settings.

      Default: - time-based canary traffic shifting, with a 15% step percentage and a five minute bake time