Class CfnCodeDeployBlueGreenHook

A CloudFormation Hook for CodeDeploy blue-green ECS deployments.

Inheritance

System.Object

CfnElement

CfnHook

CfnCodeDeployBlueGreenHook

Inherited Members

CfnHook.Type

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCodeDeployBlueGreenHook : CfnHook

Syntax (vb)

Public Class CfnCodeDeployBlueGreenHook
    Inherits CfnHook

Remarks

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

ExampleMetadata: infused

Examples

CfnInclude cfnTemplate;

// mutating the hook
Role myRole;

var hook = cfnTemplate.GetHook("MyOutput");
var codeDeployHook = (CfnCodeDeployBlueGreenHook)hook;
codeDeployHook.ServiceRole = myRole.RoleArn;

Synopsis

Constructors

CfnCodeDeployBlueGreenHook(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnCodeDeployBlueGreenHook(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnCodeDeployBlueGreenHook(Construct, String, ICfnCodeDeployBlueGreenHookProps)	Creates a new CodeDeploy blue-green ECS Hook.

Properties

AdditionalOptions	Additional options for the blue/green deployment.
Applications	Properties of the Amazon ECS applications being deployed.
LifecycleEventHooks	Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment.
ServiceRole	The IAM Role for CloudFormation to use to perform blue-green deployments.
TrafficRoutingConfig	Traffic routing configuration settings.

Methods

RenderProperties(IDictionary<String, Object>)

Constructors

CfnCodeDeployBlueGreenHook(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnCodeDeployBlueGreenHook(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnCodeDeployBlueGreenHook(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnCodeDeployBlueGreenHook(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnCodeDeployBlueGreenHook(Construct, String, ICfnCodeDeployBlueGreenHookProps)

Creates a new CodeDeploy blue-green ECS Hook.

public CfnCodeDeployBlueGreenHook(Construct scope, string id, ICfnCodeDeployBlueGreenHookProps props)

Parameters

scope Constructs.Construct: the scope to create the hook in (usually the containing Stack object).
id System.String: the identifier of the construct - will be used to generate the logical ID of the Hook.
props ICfnCodeDeployBlueGreenHookProps: the properties of the Hook.

Properties

AdditionalOptions

Additional options for the blue/green deployment.

public virtual ICfnCodeDeployBlueGreenAdditionalOptions AdditionalOptions { get; set; }

Property Value

ICfnCodeDeployBlueGreenAdditionalOptions

Remarks

Default: - no additional options

Applications

Properties of the Amazon ECS applications being deployed.

public virtual ICfnCodeDeployBlueGreenApplication[] Applications { get; set; }

Property Value

ICfnCodeDeployBlueGreenApplication[]

LifecycleEventHooks

Use lifecycle event hooks to specify a Lambda function that CodeDeploy can call to validate a deployment.

public virtual ICfnCodeDeployBlueGreenLifecycleEventHooks LifecycleEventHooks { get; set; }

Property Value

ICfnCodeDeployBlueGreenLifecycleEventHooks

Remarks

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

ServiceRole

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

public virtual string ServiceRole { get; set; }

Property Value

System.String

TrafficRoutingConfig

Traffic routing configuration settings.

public virtual ICfnTrafficRoutingConfig TrafficRoutingConfig { get; set; }

Property Value

ICfnTrafficRoutingConfig

Remarks

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

Methods

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props = null)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnHook.RenderProperties(IDictionary<String, Object>)