CfnCodeDeployBlueGreenHookProps¶

class aws_cdk.core.CfnCodeDeployBlueGreenHookProps(*, applications, service_role, additional_options=None, lifecycle_event_hooks=None, traffic_routing_config=None)¶

Bases: object

Construction properties of {@link CfnCodeDeployBlueGreenHook}.

Parameters

applications (Sequence[Union[CfnCodeDeployBlueGreenApplication, Dict[str, Any]]]) – Properties of the Amazon ECS applications being deployed.
service_role (str) – The IAM Role for CloudFormation to use to perform blue-green deployments.
additional_options (Union[CfnCodeDeployBlueGreenAdditionalOptions, Dict[str, Any], None]) – Additional options for the blue/green deployment. Default: - no additional options
lifecycle_event_hooks (Union[CfnCodeDeployBlueGreenLifecycleEventHooks, Dict[str, Any], None]) – 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
traffic_routing_config (Union[CfnTrafficRoutingConfig, Dict[str, Any], None]) – Traffic routing configuration settings. Default: - time-based canary traffic shifting, with a 15% step percentage and a five minute bake time

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.core as cdk

cfn_code_deploy_blue_green_hook_props = cdk.CfnCodeDeployBlueGreenHookProps(
    applications=[cdk.CfnCodeDeployBlueGreenApplication(
        ecs_attributes=cdk.CfnCodeDeployBlueGreenEcsAttributes(
            task_definitions=["taskDefinitions"],
            task_sets=["taskSets"],
            traffic_routing=cdk.CfnTrafficRouting(
                prod_traffic_route=cdk.CfnTrafficRoute(
                    logical_id="logicalId",
                    type="type"
                ),
                target_groups=["targetGroups"],
                test_traffic_route=cdk.CfnTrafficRoute(
                    logical_id="logicalId",
                    type="type"
                )
            )
        ),
        target=cdk.CfnCodeDeployBlueGreenApplicationTarget(
            logical_id="logicalId",
            type="type"
        )
    )],
    service_role="serviceRole",

    # the properties below are optional
    additional_options=cdk.CfnCodeDeployBlueGreenAdditionalOptions(
        termination_wait_time_in_minutes=123
    ),
    lifecycle_event_hooks=cdk.CfnCodeDeployBlueGreenLifecycleEventHooks(
        after_allow_test_traffic="afterAllowTestTraffic",
        after_allow_traffic="afterAllowTraffic",
        after_install="afterInstall",
        before_allow_traffic="beforeAllowTraffic",
        before_install="beforeInstall"
    ),
    traffic_routing_config=cdk.CfnTrafficRoutingConfig(
        type=cdk.CfnTrafficRoutingType.ALL_AT_ONCE,

        # the properties below are optional
        time_based_canary=cdk.CfnTrafficRoutingTimeBasedCanary(
            bake_time_mins=123,
            step_percentage=123
        ),
        time_based_linear=cdk.CfnTrafficRoutingTimeBasedLinear(
            bake_time_mins=123,
            step_percentage=123
        )
    )
)

Attributes

additional_options¶

Additional options for the blue/green deployment.

Default

no additional options

Return type

Optional[CfnCodeDeployBlueGreenAdditionalOptions]

applications¶

Properties of the Amazon ECS applications being deployed.

Return type: List[CfnCodeDeployBlueGreenApplication]

lifecycle_event_hooks¶

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

Return type

Optional[CfnCodeDeployBlueGreenLifecycleEventHooks]

service_role¶

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

Return type: str

traffic_routing_config¶

Traffic routing configuration settings.

Default

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

Return type

Optional[CfnTrafficRoutingConfig]