software.amazon.awscdk.core

Class CfnCodeDeployBlueGreenHook

java.lang.Object

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:

IConstruct, IDependable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:31.295Z")
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 interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CfnCodeDeployBlueGreenAdditionalOptions	getAdditionalOptions() Additional options for the blue/green deployment.
java.util.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.
java.lang.String	getServiceRole() The IAM Role for CloudFormation to use to perform blue-green deployments.
CfnTrafficRoutingConfig	getTrafficRoutingConfig() Traffic routing configuration settings.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties()
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> _props)
void	setAdditionalOptions(CfnCodeDeployBlueGreenAdditionalOptions value) Additional options for the blue/green deployment.
void	setApplications(java.util.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(java.lang.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 java.lang.Object

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

Constructor Detail

CfnCodeDeployBlueGreenHook

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

CfnCodeDeployBlueGreenHook

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

CfnCodeDeployBlueGreenHook

public CfnCodeDeployBlueGreenHook(software.constructs.Construct scope,
                                  java.lang.String id,
                                  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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> _props)

Overrides:

renderProperties in class CfnHook

Parameters:

_props -

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties()

Overrides:

renderProperties in class CfnHook

getApplications

public java.util.List<CfnCodeDeployBlueGreenApplication> getApplications()

Properties of the Amazon ECS applications being deployed.

setApplications

public void setApplications(java.util.List<CfnCodeDeployBlueGreenApplication> value)

Properties of the Amazon ECS applications being deployed.

getServiceRole

public java.lang.String getServiceRole()

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

setServiceRole

public void setServiceRole(java.lang.String value)

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

getAdditionalOptions

public CfnCodeDeployBlueGreenAdditionalOptions getAdditionalOptions()

Additional options for the blue/green deployment.

Default: - no additional options

setAdditionalOptions

public void setAdditionalOptions(CfnCodeDeployBlueGreenAdditionalOptions value)

Additional options for the blue/green deployment.

Default: - no additional options

getLifecycleEventHooks

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

public void setLifecycleEventHooks(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

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

public void setTrafficRoutingConfig(CfnTrafficRoutingConfig value)

Traffic routing configuration settings.

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