Package software.amazon.awscdk

Interface CfnCodeDeployBlueGreenHookProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCodeDeployBlueGreenHookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:20.112Z")
@Stability(Stable)
public interface CfnCodeDeployBlueGreenHookProps
extends software.amazon.jsii.JsiiSerializable

Construction properties of CfnCodeDeployBlueGreenHook.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnCodeDeployBlueGreenHookProps cfnCodeDeployBlueGreenHookProps = CfnCodeDeployBlueGreenHookProps.builder()
         .applications(List.of(CfnCodeDeployBlueGreenApplication.builder()
                 .ecsAttributes(CfnCodeDeployBlueGreenEcsAttributes.builder()
                         .taskDefinitions(List.of("taskDefinitions"))
                         .taskSets(List.of("taskSets"))
                         .trafficRouting(CfnTrafficRouting.builder()
                                 .prodTrafficRoute(CfnTrafficRoute.builder()
                                         .logicalId("logicalId")
                                         .type("type")
                                         .build())
                                 .targetGroups(List.of("targetGroups"))
                                 .testTrafficRoute(CfnTrafficRoute.builder()
                                         .logicalId("logicalId")
                                         .type("type")
                                         .build())
                                 .build())
                         .build())
                 .target(CfnCodeDeployBlueGreenApplicationTarget.builder()
                         .logicalId("logicalId")
                         .type("type")
                         .build())
                 .build()))
         .serviceRole("serviceRole")
         // the properties below are optional
         .additionalOptions(CfnCodeDeployBlueGreenAdditionalOptions.builder()
                 .terminationWaitTimeInMinutes(123)
                 .build())
         .lifecycleEventHooks(CfnCodeDeployBlueGreenLifecycleEventHooks.builder()
                 .afterAllowTestTraffic("afterAllowTestTraffic")
                 .afterAllowTraffic("afterAllowTraffic")
                 .afterInstall("afterInstall")
                 .beforeAllowTraffic("beforeAllowTraffic")
                 .beforeInstall("beforeInstall")
                 .build())
         .trafficRoutingConfig(CfnTrafficRoutingConfig.builder()
                 .type(CfnTrafficRoutingType.ALL_AT_ONCE)
                 // the properties below are optional
                 .timeBasedCanary(CfnTrafficRoutingTimeBasedCanary.builder()
                         .bakeTimeMins(123)
                         .stepPercentage(123)
                         .build())
                 .timeBasedLinear(CfnTrafficRoutingTimeBasedLinear.builder()
                         .bakeTimeMins(123)
                         .stepPercentage(123)
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCodeDeployBlueGreenHookProps.Builder	builder()
default CfnCodeDeployBlueGreenAdditionalOptions	getAdditionalOptions()	Additional options for the blue/green deployment.
List<CfnCodeDeployBlueGreenApplication>	getApplications()	Properties of the Amazon ECS applications being deployed.
default CfnCodeDeployBlueGreenLifecycleEventHooks	getLifecycleEventHooks()	Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment.
String	getServiceRole()	The IAM Role for CloudFormation to use to perform blue-green deployments.
default CfnTrafficRoutingConfig	getTrafficRoutingConfig()	Traffic routing configuration settings.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplications

@Stability(Stable)
@NotNull
List<CfnCodeDeployBlueGreenApplication> getApplications()

Properties of the Amazon ECS applications being deployed.

getServiceRole

@Stability(Stable)
@NotNull
String getServiceRole()

The IAM Role for CloudFormation to use to perform blue-green deployments.

getAdditionalOptions

@Stability(Stable)
@Nullable
default CfnCodeDeployBlueGreenAdditionalOptions getAdditionalOptions()

Additional options for the blue/green deployment.

Default: - no additional options

getLifecycleEventHooks

@Stability(Stable)
@Nullable
default 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

getTrafficRoutingConfig

@Stability(Stable)
@Nullable
default CfnTrafficRoutingConfig getTrafficRoutingConfig()

Traffic routing configuration settings.

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

builder

@Stability(Stable)
static CfnCodeDeployBlueGreenHookProps.Builder builder()

Returns:

a CfnCodeDeployBlueGreenHookProps.Builder of CfnCodeDeployBlueGreenHookProps