Package software.amazon.awscdk
Class CfnCodeDeployBlueGreenHook.Builder
java.lang.Object
software.amazon.awscdk.CfnCodeDeployBlueGreenHook.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCodeDeployBlueGreenHook>
- Enclosing class:
CfnCodeDeployBlueGreenHook
@Stability(Stable)
public static final class CfnCodeDeployBlueGreenHook.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCodeDeployBlueGreenHook>
A fluent builder for
CfnCodeDeployBlueGreenHook
.-
Method Summary
Modifier and TypeMethodDescriptionadditionalOptions
(CfnCodeDeployBlueGreenAdditionalOptions additionalOptions) Additional options for the blue/green deployment.applications
(List<? extends CfnCodeDeployBlueGreenApplication> applications) Properties of the Amazon ECS applications being deployed.build()
lifecycleEventHooks
(CfnCodeDeployBlueGreenLifecycleEventHooks lifecycleEventHooks) Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment.serviceRole
(String serviceRole) The IAM Role for CloudFormation to use to perform blue-green deployments.trafficRoutingConfig
(CfnTrafficRoutingConfig trafficRoutingConfig) Traffic routing configuration settings.
-
Method Details
-
create
@Stability(Stable) public static CfnCodeDeployBlueGreenHook.Builder create(software.constructs.Construct scope, String id) - 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.- Returns:
- a new instance of
CfnCodeDeployBlueGreenHook.Builder
.
-
applications
@Stability(Stable) public CfnCodeDeployBlueGreenHook.Builder applications(List<? extends CfnCodeDeployBlueGreenApplication> applications) Properties of the Amazon ECS applications being deployed.- Parameters:
applications
- Properties of the Amazon ECS applications being deployed. This parameter is required.- Returns:
this
-
serviceRole
The IAM Role for CloudFormation to use to perform blue-green deployments.- Parameters:
serviceRole
- The IAM Role for CloudFormation to use to perform blue-green deployments. This parameter is required.- Returns:
this
-
additionalOptions
@Stability(Stable) public CfnCodeDeployBlueGreenHook.Builder additionalOptions(CfnCodeDeployBlueGreenAdditionalOptions additionalOptions) Additional options for the blue/green deployment.Default: - no additional options
- Parameters:
additionalOptions
- Additional options for the blue/green deployment. This parameter is required.- Returns:
this
-
lifecycleEventHooks
@Stability(Stable) public CfnCodeDeployBlueGreenHook.Builder lifecycleEventHooks(CfnCodeDeployBlueGreenLifecycleEventHooks lifecycleEventHooks) 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
- Parameters:
lifecycleEventHooks
- Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment. This parameter is required.- Returns:
this
-
trafficRoutingConfig
@Stability(Stable) public CfnCodeDeployBlueGreenHook.Builder trafficRoutingConfig(CfnTrafficRoutingConfig trafficRoutingConfig) Traffic routing configuration settings.Default: - time-based canary traffic shifting, with a 15% step percentage and a five minute bake time
- Parameters:
trafficRoutingConfig
- Traffic routing configuration settings. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCodeDeployBlueGreenHook>
- Returns:
- a newly built instance of
CfnCodeDeployBlueGreenHook
.
-