software.amazon.awscdk.core

Class CfnCodeDeployBlueGreenHook

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnHook

software.amazon.awscdk.core.CfnCodeDeployBlueGreenHook

All Implemented Interfaces:

IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:31.799Z")
 @Stability(value=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:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html#blue-green-template-reference

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCodeDeployBlueGreenHook.Builder A fluent builder for CfnCodeDeployBlueGreenHook.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCodeDeployBlueGreenHook(software.constructs.Construct scope, String id, CfnCodeDeployBlueGreenHookProps props) Creates a new CodeDeploy blue-green ECS Hook.
protected	CfnCodeDeployBlueGreenHook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCodeDeployBlueGreenHook(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
CfnCodeDeployBlueGreenAdditionalOptions	getAdditionalOptions() Additional options for the blue/green deployment.
List<CfnCodeDeployBlueGreenApplication>	getApplications() Properties of the Amazon ECS applications being deployed.
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.
CfnTrafficRoutingConfig	getTrafficRoutingConfig() Traffic routing configuration settings.
protected Map<String,Object>	renderProperties()
protected Map<String,Object>	renderProperties(Map<String,Object> _props)
void	setAdditionalOptions(CfnCodeDeployBlueGreenAdditionalOptions value) Additional options for the blue/green deployment.
void	setApplications(List<CfnCodeDeployBlueGreenApplication> value) Properties of the Amazon ECS applications being deployed.
void	setLifecycleEventHooks(CfnCodeDeployBlueGreenLifecycleEventHooks value) Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment.
void	setServiceRole(String value) The IAM Role for CloudFormation to use to perform blue-green deployments.
void	setTrafficRoutingConfig(CfnTrafficRoutingConfig value) Traffic routing configuration settings.

Methods inherited from class software.amazon.awscdk.core.CfnHook

getType

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CfnCodeDeployBlueGreenHook

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

CfnCodeDeployBlueGreenHook

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

CfnCodeDeployBlueGreenHook

@Stability(value=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 Detail

renderProperties

@Stability(value=Stable)
 @Nullable
protected Map<String,Object> renderProperties(@Nullable
                                                                                  Map<String,Object> _props)

Overrides:

renderProperties in class CfnHook

Parameters:

_props -

renderProperties

@Stability(value=Stable)
 @Nullable
protected Map<String,Object> renderProperties()

Overrides:

renderProperties in class CfnHook

getApplications

@Stability(value=Stable)
 @NotNull
public List<CfnCodeDeployBlueGreenApplication> getApplications()

Properties of the Amazon ECS applications being deployed.

setApplications

@Stability(value=Stable)
public void setApplications(@NotNull
                                                     List<CfnCodeDeployBlueGreenApplication> value)

Properties of the Amazon ECS applications being deployed.

getServiceRole

@Stability(value=Stable)
 @NotNull
public String getServiceRole()

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

setServiceRole

@Stability(value=Stable)
public void setServiceRole(@NotNull
                                                    String value)

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

getAdditionalOptions

@Stability(value=Stable)
 @Nullable
public CfnCodeDeployBlueGreenAdditionalOptions getAdditionalOptions()

Additional options for the blue/green deployment.

Default: - no additional options

setAdditionalOptions

@Stability(value=Stable)
public void setAdditionalOptions(@Nullable
                                                          CfnCodeDeployBlueGreenAdditionalOptions value)

Additional options for the blue/green deployment.

Default: - no additional options

getLifecycleEventHooks

@Stability(value=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 {@link CfnCodeDeployBlueGreenLifecycleEventHooks.afterAllowTraffic} function calls back CodeDeploy and delivers a result of 'Succeeded' or 'Failed'.

Default: - no lifecycle event hooks

setLifecycleEventHooks

@Stability(value=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 {@link CfnCodeDeployBlueGreenLifecycleEventHooks.afterAllowTraffic} function calls back CodeDeploy and delivers a result of 'Succeeded' or 'Failed'.

Default: - no lifecycle event hooks

getTrafficRoutingConfig

@Stability(value=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(value=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