CfnDeploymentGroupPropsMixin

class aws_cdk.mixins_preview.aws_codedeploy.mixins.CfnDeploymentGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::CodeDeploy::DeploymentGroup resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options.

For more information, see CreateDeploymentGroup in the CodeDeploy API Reference . .. epigraph:

Amazon ECS blue/green deployments through CodeDeploy do not use the ``AWS::CodeDeploy::DeploymentGroup`` resource. To perform Amazon ECS blue/green deployments, use the ``AWS::CodeDeploy::BlueGreen`` hook. See `Perform Amazon ECS blue/green deployments through CodeDeploy using CloudFormation <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html>`_ for more information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html
CloudformationResource:: AWS::CodeDeploy::DeploymentGroup
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

cfn_deployment_group_props_mixin = codedeploy_mixins.CfnDeploymentGroupPropsMixin(codedeploy_mixins.CfnDeploymentGroupMixinProps(
    alarm_configuration=codedeploy_mixins.CfnDeploymentGroupPropsMixin.AlarmConfigurationProperty(
        alarms=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.AlarmProperty(
            name="name"
        )],
        enabled=False,
        ignore_poll_alarm_failure=False
    ),
    application_name="applicationName",
    auto_rollback_configuration=codedeploy_mixins.CfnDeploymentGroupPropsMixin.AutoRollbackConfigurationProperty(
        enabled=False,
        events=["events"]
    ),
    auto_scaling_groups=["autoScalingGroups"],
    blue_green_deployment_configuration=codedeploy_mixins.CfnDeploymentGroupPropsMixin.BlueGreenDeploymentConfigurationProperty(
        deployment_ready_option=codedeploy_mixins.CfnDeploymentGroupPropsMixin.DeploymentReadyOptionProperty(
            action_on_timeout="actionOnTimeout",
            wait_time_in_minutes=123
        ),
        green_fleet_provisioning_option=codedeploy_mixins.CfnDeploymentGroupPropsMixin.GreenFleetProvisioningOptionProperty(
            action="action"
        ),
        terminate_blue_instances_on_deployment_success=codedeploy_mixins.CfnDeploymentGroupPropsMixin.BlueInstanceTerminationOptionProperty(
            action="action",
            termination_wait_time_in_minutes=123
        )
    ),
    deployment=codedeploy_mixins.CfnDeploymentGroupPropsMixin.DeploymentProperty(
        description="description",
        ignore_application_stop_failures=False,
        revision=codedeploy_mixins.CfnDeploymentGroupPropsMixin.RevisionLocationProperty(
            git_hub_location=codedeploy_mixins.CfnDeploymentGroupPropsMixin.GitHubLocationProperty(
                commit_id="commitId",
                repository="repository"
            ),
            revision_type="revisionType",
            s3_location=codedeploy_mixins.CfnDeploymentGroupPropsMixin.S3LocationProperty(
                bucket="bucket",
                bundle_type="bundleType",
                e_tag="eTag",
                key="key",
                version="version"
            )
        )
    ),
    deployment_config_name="deploymentConfigName",
    deployment_group_name="deploymentGroupName",
    deployment_style=codedeploy_mixins.CfnDeploymentGroupPropsMixin.DeploymentStyleProperty(
        deployment_option="deploymentOption",
        deployment_type="deploymentType"
    ),
    ec2_tag_filters=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagFilterProperty(
        key="key",
        type="type",
        value="value"
    )],
    ec2_tag_set=codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagSetProperty(
        ec2_tag_set_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagSetListObjectProperty(
            ec2_tag_group=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagFilterProperty(
                key="key",
                type="type",
                value="value"
            )]
        )]
    ),
    ecs_services=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.ECSServiceProperty(
        cluster_name="clusterName",
        service_name="serviceName"
    )],
    load_balancer_info=codedeploy_mixins.CfnDeploymentGroupPropsMixin.LoadBalancerInfoProperty(
        elb_info_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.ELBInfoProperty(
            name="name"
        )],
        target_group_info_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupInfoProperty(
            name="name"
        )],
        target_group_pair_info_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupPairInfoProperty(
            prod_traffic_route=codedeploy_mixins.CfnDeploymentGroupPropsMixin.TrafficRouteProperty(
                listener_arns=["listenerArns"]
            ),
            target_groups=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupInfoProperty(
                name="name"
            )],
            test_traffic_route=codedeploy_mixins.CfnDeploymentGroupPropsMixin.TrafficRouteProperty(
                listener_arns=["listenerArns"]
            )
        )]
    ),
    on_premises_instance_tag_filters=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TagFilterProperty(
        key="key",
        type="type",
        value="value"
    )],
    on_premises_tag_set=codedeploy_mixins.CfnDeploymentGroupPropsMixin.OnPremisesTagSetProperty(
        on_premises_tag_set_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.OnPremisesTagSetListObjectProperty(
            on_premises_tag_group=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TagFilterProperty(
                key="key",
                type="type",
                value="value"
            )]
        )]
    ),
    outdated_instances_strategy="outdatedInstancesStrategy",
    service_role_arn="serviceRoleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    termination_hook_enabled=False,
    trigger_configurations=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TriggerConfigProperty(
        trigger_events=["triggerEvents"],
        trigger_name="triggerName",
        trigger_target_arn="triggerTargetArn"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CodeDeploy::DeploymentGroup.

Parameters:

props (Union[CfnDeploymentGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['alarmConfiguration', 'applicationName', 'autoRollbackConfiguration', 'autoScalingGroups', 'blueGreenDeploymentConfiguration', 'deployment', 'deploymentConfigName', 'deploymentGroupName', 'deploymentStyle', 'ec2TagFilters', 'ec2TagSet', 'ecsServices', 'loadBalancerInfo', 'onPremisesInstanceTagFilters', 'onPremisesTagSet', 'outdatedInstancesStrategy', 'serviceRoleArn', 'tags', 'terminationHookEnabled', 'triggerConfigurations']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AlarmConfigurationProperty

class CfnDeploymentGroupPropsMixin.AlarmConfigurationProperty(*, alarms=None, enabled=None, ignore_poll_alarm_failure=None)

Bases: object

The AlarmConfiguration property type configures CloudWatch alarms for an AWS CodeDeploy deployment group.

AlarmConfiguration is a property of the DeploymentGroup resource.

Parameters:

alarms (Union[IResolvable, Sequence[Union[IResolvable, AlarmProperty, Dict[str, Any]]], None]) – A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
enabled (Union[bool, IResolvable, None]) – Indicates whether the alarm configuration is enabled.
ignore_poll_alarm_failure (Union[bool, IResolvable, None]) – Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch . The default value is false . - true : The deployment proceeds even if alarm status information can’t be retrieved from CloudWatch . - false : The deployment stops if alarm status information can’t be retrieved from CloudWatch .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

alarm_configuration_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.AlarmConfigurationProperty(
    alarms=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.AlarmProperty(
        name="name"
    )],
    enabled=False,
    ignore_poll_alarm_failure=False
)

Attributes

alarms

A list of alarms configured for the deployment or deployment group.

A maximum of 10 alarms can be added.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-alarms

enabled

Indicates whether the alarm configuration is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-enabled

ignore_poll_alarm_failure

Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch .

The default value is false .

true : The deployment proceeds even if alarm status information can’t be retrieved from CloudWatch .
false : The deployment stops if alarm status information can’t be retrieved from CloudWatch .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-ignorepollalarmfailure

AlarmProperty

class CfnDeploymentGroupPropsMixin.AlarmProperty(*, name=None)

Bases: object

The Alarm property type specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group.

The Alarm property of the CodeDeploy DeploymentGroup AlarmConfiguration property contains a list of Alarm property types.

Parameters:: name (Optional[str]) – The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

alarm_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.AlarmProperty(
    name="name"
)

Attributes

name

The name of the alarm.

Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html#cfn-codedeploy-deploymentgroup-alarm-name

AutoRollbackConfigurationProperty

class CfnDeploymentGroupPropsMixin.AutoRollbackConfigurationProperty(*, enabled=None, events=None)

Bases: object

The AutoRollbackConfiguration property type configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully.

For more information, see Automatic Rollbacks in the AWS CodeDeploy User Guide .

AutoRollbackConfiguration is a property of the DeploymentGroup resource.

Parameters:

enabled (Union[bool, IResolvable, None]) – Indicates whether a defined automatic rollback configuration is currently enabled.
events (Optional[Sequence[str]]) – The event type or types that trigger a rollback. Valid values are DEPLOYMENT_FAILURE , DEPLOYMENT_STOP_ON_ALARM , or DEPLOYMENT_STOP_ON_REQUEST .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

auto_rollback_configuration_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.AutoRollbackConfigurationProperty(
    enabled=False,
    events=["events"]
)

Attributes

enabled

Indicates whether a defined automatic rollback configuration is currently enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-enabled

events

The event type or types that trigger a rollback.

Valid values are DEPLOYMENT_FAILURE , DEPLOYMENT_STOP_ON_ALARM , or DEPLOYMENT_STOP_ON_REQUEST .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-events

BlueGreenDeploymentConfigurationProperty

class CfnDeploymentGroupPropsMixin.BlueGreenDeploymentConfigurationProperty(*, deployment_ready_option=None, green_fleet_provisioning_option=None, terminate_blue_instances_on_deployment_success=None)

Bases: object

Information about blue/green deployment options for a deployment group.

Parameters:

deployment_ready_option (Union[IResolvable, DeploymentReadyOptionProperty, Dict[str, Any], None]) – Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
green_fleet_provisioning_option (Union[IResolvable, GreenFleetProvisioningOptionProperty, Dict[str, Any], None]) – Information about how instances are provisioned for a replacement environment in a blue/green deployment.
terminate_blue_instances_on_deployment_success (Union[IResolvable, BlueInstanceTerminationOptionProperty, Dict[str, Any], None]) – Information about whether to terminate instances in the original fleet during a blue/green deployment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

blue_green_deployment_configuration_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.BlueGreenDeploymentConfigurationProperty(
    deployment_ready_option=codedeploy_mixins.CfnDeploymentGroupPropsMixin.DeploymentReadyOptionProperty(
        action_on_timeout="actionOnTimeout",
        wait_time_in_minutes=123
    ),
    green_fleet_provisioning_option=codedeploy_mixins.CfnDeploymentGroupPropsMixin.GreenFleetProvisioningOptionProperty(
        action="action"
    ),
    terminate_blue_instances_on_deployment_success=codedeploy_mixins.CfnDeploymentGroupPropsMixin.BlueInstanceTerminationOptionProperty(
        action="action",
        termination_wait_time_in_minutes=123
    )
)

Attributes

deployment_ready_option

Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-deploymentreadyoption

green_fleet_provisioning_option

Information about how instances are provisioned for a replacement environment in a blue/green deployment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-greenfleetprovisioningoption

terminate_blue_instances_on_deployment_success

Information about whether to terminate instances in the original fleet during a blue/green deployment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html#cfn-codedeploy-deploymentgroup-bluegreendeploymentconfiguration-terminateblueinstancesondeploymentsuccess

BlueInstanceTerminationOptionProperty

class CfnDeploymentGroupPropsMixin.BlueInstanceTerminationOptionProperty(*, action=None, termination_wait_time_in_minutes=None)

Bases: object

Information about whether instances in the original environment are terminated when a blue/green deployment is successful.

BlueInstanceTerminationOption does not apply to Lambda deployments.

Parameters:

action (Optional[str]) – The action to take on instances in the original environment after a successful blue/green deployment. - TERMINATE : Instances are terminated after a specified wait time. - KEEP_ALIVE : Instances are left running after they are deregistered from the load balancer and removed from the deployment group.
termination_wait_time_in_minutes (Union[int, float, None]) – For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment. For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. The maximum setting is 2880 minutes (2 days).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-blueinstanceterminationoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

blue_instance_termination_option_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.BlueInstanceTerminationOptionProperty(
    action="action",
    termination_wait_time_in_minutes=123
)

Attributes

action

The action to take on instances in the original environment after a successful blue/green deployment.

TERMINATE : Instances are terminated after a specified wait time.
KEEP_ALIVE : Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-blueinstanceterminationoption.html#cfn-codedeploy-deploymentgroup-blueinstanceterminationoption-action

termination_wait_time_in_minutes

For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set.

The maximum setting is 2880 minutes (2 days).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-blueinstanceterminationoption.html#cfn-codedeploy-deploymentgroup-blueinstanceterminationoption-terminationwaittimeinminutes

DeploymentProperty

class CfnDeploymentGroupPropsMixin.DeploymentProperty(*, description=None, ignore_application_stop_failures=None, revision=None)

Bases: object

Deployment is a property of the DeploymentGroup resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group. If you specify an application revision, your target revision is deployed as soon as the provisioning process is complete.

Parameters:

description (Optional[str]) – A comment about the deployment.
ignore_application_stop_failures (Union[bool, IResolvable, None]) – If true, then if an ApplicationStop , BeforeBlockTraffic , or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic . If AfterBlockTraffic fails, the deployment continues with ApplicationStop . If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted. During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail. If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic failures should be ignored.
revision (Union[IResolvable, RevisionLocationProperty, Dict[str, Any], None]) – Information about the location of stored application artifacts and the service from which to retrieve them.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

deployment_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.DeploymentProperty(
    description="description",
    ignore_application_stop_failures=False,
    revision=codedeploy_mixins.CfnDeploymentGroupPropsMixin.RevisionLocationProperty(
        git_hub_location=codedeploy_mixins.CfnDeploymentGroupPropsMixin.GitHubLocationProperty(
            commit_id="commitId",
            repository="repository"
        ),
        revision_type="revisionType",
        s3_location=codedeploy_mixins.CfnDeploymentGroupPropsMixin.S3LocationProperty(
            bucket="bucket",
            bundle_type="bundleType",
            e_tag="eTag",
            key="key",
            version="version"
        )
    )
)

Attributes

description

A comment about the deployment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-codedeploy-deploymentgroup-deployment-description

ignore_application_stop_failures

If true, then if an ApplicationStop , BeforeBlockTraffic , or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event.

For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic . If AfterBlockTraffic fails, the deployment continues with ApplicationStop .

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic failures should be ignored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-codedeploy-deploymentgroup-deployment-ignoreapplicationstopfailures

revision

Information about the location of stored application artifacts and the service from which to retrieve them.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-codedeploy-deploymentgroup-deployment-revision

DeploymentReadyOptionProperty

class CfnDeploymentGroupPropsMixin.DeploymentReadyOptionProperty(*, action_on_timeout=None, wait_time_in_minutes=None)

Bases: object

Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.

Parameters:

action_on_timeout (Optional[str]) – Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment. - CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment. - STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
wait_time_in_minutes (Union[int, float, None]) – The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentreadyoption.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

deployment_ready_option_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.DeploymentReadyOptionProperty(
    action_on_timeout="actionOnTimeout",
    wait_time_in_minutes=123
)

Attributes

action_on_timeout

Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentreadyoption.html#cfn-codedeploy-deploymentgroup-deploymentreadyoption-actionontimeout

wait_time_in_minutes

The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually.

Applies only to the STOP_DEPLOYMENT option for actionOnTimeout .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentreadyoption.html#cfn-codedeploy-deploymentgroup-deploymentreadyoption-waittimeinminutes

DeploymentStyleProperty

class CfnDeploymentGroupPropsMixin.DeploymentStyleProperty(*, deployment_option=None, deployment_type=None)

Bases: object

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

Parameters:

deployment_option (Optional[str]) – Indicates whether to route deployment traffic behind a load balancer. .. epigraph:: An Amazon EC2 Application Load Balancer or Network Load Balancer is required for an Amazon ECS deployment.
deployment_type (Optional[str]) – Indicates whether to run an in-place or blue/green deployment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

deployment_style_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.DeploymentStyleProperty(
    deployment_option="deploymentOption",
    deployment_type="deploymentType"
)

Attributes

deployment_option

Indicates whether to route deployment traffic behind a load balancer.

An Amazon EC2 Application Load Balancer or Network Load Balancer is required for an Amazon ECS deployment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymentoption

deployment_type

Indicates whether to run an in-place or blue/green deployment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymenttype

EC2TagFilterProperty

class CfnDeploymentGroupPropsMixin.EC2TagFilterProperty(*, key=None, type=None, value=None)

Bases: object

Information about an Amazon EC2 tag filter.

For more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide .

Parameters:

key (Optional[str]) – The tag filter key.
type (Optional[str]) – The tag filter type:. - KEY_ONLY : Key only. - VALUE_ONLY : Value only. - KEY_AND_VALUE : Key and value.
value (Optional[str]) – The tag filter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

e_c2_tag_filter_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagFilterProperty(
    key="key",
    type="type",
    value="value"
)

Attributes

key

The tag filter key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-key

type

.

KEY_ONLY : Key only.
VALUE_ONLY : Value only.
KEY_AND_VALUE : Key and value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-type
Type:: The tag filter type

value

The tag filter value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilter.html#cfn-codedeploy-deploymentgroup-ec2tagfilter-value

EC2TagSetListObjectProperty

class CfnDeploymentGroupPropsMixin.EC2TagSetListObjectProperty(*, ec2_tag_group=None)

Bases: object

The EC2TagSet property type specifies information about groups of tags applied to Amazon EC2 instances.

The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same template as EC2TagFilters.

For more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide .

EC2TagSet is a property of the DeploymentGroup resource type.

Parameters:: ec2_tag_group (Union[IResolvable, Sequence[Union[IResolvable, EC2TagFilterProperty, Dict[str, Any]]], None]) – A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagsetlistobject.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

e_c2_tag_set_list_object_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagSetListObjectProperty(
    ec2_tag_group=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagFilterProperty(
        key="key",
        type="type",
        value="value"
    )]
)

Attributes

ec2_tag_group

A list that contains other lists of Amazon EC2 instance tag groups.

For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagsetlistobject.html#cfn-codedeploy-deploymentgroup-ec2tagsetlistobject-ec2taggroup

EC2TagSetProperty

class CfnDeploymentGroupPropsMixin.EC2TagSetProperty(*, ec2_tag_set_list=None)

Bases: object

The EC2TagSet property type specifies information about groups of tags applied to Amazon EC2 instances.

The deployment group includes only Amazon EC2 instances identified by all the tag groups. EC2TagSet cannot be used in the same template as EC2TagFilter .

For information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy .

Parameters:: ec2_tag_set_list (Union[IResolvable, Sequence[Union[IResolvable, EC2TagSetListObjectProperty, Dict[str, Any]]], None]) – The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group. CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagset.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

e_c2_tag_set_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagSetProperty(
    ec2_tag_set_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagSetListObjectProperty(
        ec2_tag_group=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.EC2TagFilterProperty(
            key="key",
            type="type",
            value="value"
        )]
    )]
)

Attributes

ec2_tag_set_list

The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group.

CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group.

Duplicates are not allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagset.html#cfn-codedeploy-deploymentgroup-ec2tagset-ec2tagsetlist

ECSServiceProperty

class CfnDeploymentGroupPropsMixin.ECSServiceProperty(*, cluster_name=None, service_name=None)

Bases: object

Contains the service and cluster names used to identify an Amazon ECS deployment’s target.

Parameters:

cluster_name (Optional[str]) – The name of the cluster that the Amazon ECS service is associated with.
service_name (Optional[str]) – The name of the target Amazon ECS service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ecsservice.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

e_cSService_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.ECSServiceProperty(
    cluster_name="clusterName",
    service_name="serviceName"
)

Attributes

cluster_name

The name of the cluster that the Amazon ECS service is associated with.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ecsservice.html#cfn-codedeploy-deploymentgroup-ecsservice-clustername

service_name

The name of the target Amazon ECS service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ecsservice.html#cfn-codedeploy-deploymentgroup-ecsservice-servicename

ELBInfoProperty

class CfnDeploymentGroupPropsMixin.ELBInfoProperty(*, name=None)

Bases: object

The ELBInfo property type specifies information about the ELB load balancer used for an CodeDeploy deployment group.

If you specify the ELBInfo property, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL for AWS CodeDeploy to route your traffic using the specified load balancers.

ELBInfo is a property of the AWS CodeDeploy DeploymentGroup LoadBalancerInfo property type.

Parameters:: name (Optional[str]) – For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete. .. epigraph:: CloudFormation supports blue/green deployments on AWS Lambda compute platforms only.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

e_lBInfo_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.ELBInfoProperty(
    name="name"
)

Attributes

name

For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment.

For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete. .. epigraph:

CloudFormation supports blue/green deployments on AWS Lambda compute platforms only.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html#cfn-codedeploy-deploymentgroup-elbinfo-name

GitHubLocationProperty

class CfnDeploymentGroupPropsMixin.GitHubLocationProperty(*, commit_id=None, repository=None)

Bases: object

GitHubLocation is a property of the CodeDeploy DeploymentGroup Revision property that specifies the location of an application revision that is stored in GitHub.

Parameters:

commit_id (Optional[str]) – The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
repository (Optional[str]) – The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. Specify the value as account/repository .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-githublocation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

git_hub_location_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.GitHubLocationProperty(
    commit_id="commitId",
    repository="repository"
)

Attributes

commit_id

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-githublocation.html#cfn-codedeploy-deploymentgroup-githublocation-commitid

repository

The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.

Specify the value as account/repository .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-githublocation.html#cfn-codedeploy-deploymentgroup-githublocation-repository

GreenFleetProvisioningOptionProperty

class CfnDeploymentGroupPropsMixin.GreenFleetProvisioningOptionProperty(*, action=None)

Bases: object

Information about the instances that belong to the replacement environment in a blue/green deployment.

Parameters:: action (Optional[str]) – The method used to add instances to a replacement environment. - DISCOVER_EXISTING : Use instances that already exist or will be created manually. - COPY_AUTO_SCALING_GROUP : Use settings from a specified Amazon EC2 Auto Scaling group to define and create instances in a new Amazon EC2 Auto Scaling group.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-greenfleetprovisioningoption.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

green_fleet_provisioning_option_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.GreenFleetProvisioningOptionProperty(
    action="action"
)

Attributes

action

The method used to add instances to a replacement environment.

DISCOVER_EXISTING : Use instances that already exist or will be created manually.
COPY_AUTO_SCALING_GROUP : Use settings from a specified Amazon EC2 Auto Scaling group to define and create instances in a new Amazon EC2 Auto Scaling group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-greenfleetprovisioningoption.html#cfn-codedeploy-deploymentgroup-greenfleetprovisioningoption-action

LoadBalancerInfoProperty

class CfnDeploymentGroupPropsMixin.LoadBalancerInfoProperty(*, elb_info_list=None, target_group_info_list=None, target_group_pair_info_list=None)

Bases: object

The LoadBalancerInfo property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group.

For more information, see Integrating CodeDeploy with ELB in the AWS CodeDeploy User Guide .

For CloudFormation to use the properties specified in LoadBalancerInfo , the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL . If DeploymentStyle.DeploymentOption is not set to WITH_TRAFFIC_CONTROL , CloudFormation ignores any settings specified in LoadBalancerInfo . .. epigraph:

CloudFormation supports blue/green deployments on the AWS Lambda compute platform only.

LoadBalancerInfo is a property of the DeploymentGroup resource.

Parameters:

elb_info_list (Union[IResolvable, Sequence[Union[IResolvable, ELBInfoProperty, Dict[str, Any]]], None]) – An array that contains information about the load balancers to use for load balancing in a deployment. If you’re using Classic Load Balancers, specify those load balancers in this array. .. epigraph:: You can add up to 10 load balancers to the array. > If you’re using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
target_group_info_list (Union[IResolvable, Sequence[Union[IResolvable, TargetGroupInfoProperty, Dict[str, Any]]], None]) – An array that contains information about the target groups to use for load balancing in a deployment. If you’re using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array. .. epigraph:: You can add up to 10 target groups to the array. > If you’re using Classic Load Balancers, use the elbInfoList array instead of this one.
target_group_pair_info_list (Union[IResolvable, Sequence[Union[IResolvable, TargetGroupPairInfoProperty, Dict[str, Any]]], None]) – The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

load_balancer_info_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.LoadBalancerInfoProperty(
    elb_info_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.ELBInfoProperty(
        name="name"
    )],
    target_group_info_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupInfoProperty(
        name="name"
    )],
    target_group_pair_info_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupPairInfoProperty(
        prod_traffic_route=codedeploy_mixins.CfnDeploymentGroupPropsMixin.TrafficRouteProperty(
            listener_arns=["listenerArns"]
        ),
        target_groups=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupInfoProperty(
            name="name"
        )],
        test_traffic_route=codedeploy_mixins.CfnDeploymentGroupPropsMixin.TrafficRouteProperty(
            listener_arns=["listenerArns"]
        )
    )]
)

Attributes

elb_info_list

An array that contains information about the load balancers to use for load balancing in a deployment.

If you’re using Classic Load Balancers, specify those load balancers in this array. .. epigraph:

You can add up to 10 load balancers to the array. > If you're using Application Load Balancers or Network Load Balancers, use the ``targetGroupInfoList`` array instead of this one.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-elbinfolist

target_group_info_list

An array that contains information about the target groups to use for load balancing in a deployment.

If you’re using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array. .. epigraph:

You can add up to 10 target groups to the array. > If you're using Classic Load Balancers, use the ``elbInfoList`` array instead of this one.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgroupinfolist

target_group_pair_info_list

The target group pair information.

This is an array of TargeGroupPairInfo objects with a maximum size of one.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgrouppairinfolist

OnPremisesTagSetListObjectProperty

class CfnDeploymentGroupPropsMixin.OnPremisesTagSetListObjectProperty(*, on_premises_tag_group=None)

Bases: object

The OnPremisesTagSetListObject property type specifies lists of on-premises instance tag groups.

In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.

OnPremisesTagSetListObject is a property of the CodeDeploy DeploymentGroup OnPremisesTagSet property type.

Parameters:: on_premises_tag_group (Union[IResolvable, Sequence[Union[IResolvable, TagFilterProperty, Dict[str, Any]]], None]) – Information about groups of on-premises instance tags.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagsetlistobject.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

on_premises_tag_set_list_object_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.OnPremisesTagSetListObjectProperty(
    on_premises_tag_group=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TagFilterProperty(
        key="key",
        type="type",
        value="value"
    )]
)

Attributes

on_premises_tag_group

Information about groups of on-premises instance tags.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagsetlistobject.html#cfn-codedeploy-deploymentgroup-onpremisestagsetlistobject-onpremisestaggroup

OnPremisesTagSetProperty

class CfnDeploymentGroupPropsMixin.OnPremisesTagSetProperty(*, on_premises_tag_set_list=None)

Bases: object

The OnPremisesTagSet property type specifies a list containing other lists of on-premises instance tag groups.

In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.

For more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide .

OnPremisesTagSet is a property of the DeploymentGroup resource.

Parameters:: on_premises_tag_set_list (Union[IResolvable, Sequence[Union[IResolvable, OnPremisesTagSetListObjectProperty, Dict[str, Any]]], None]) – A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list. Duplicates are not allowed.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

on_premises_tag_set_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.OnPremisesTagSetProperty(
    on_premises_tag_set_list=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.OnPremisesTagSetListObjectProperty(
        on_premises_tag_group=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TagFilterProperty(
            key="key",
            type="type",
            value="value"
        )]
    )]
)

Attributes

on_premises_tag_set_list

A list that contains other lists of on-premises instance tag groups.

For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.

Duplicates are not allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html#cfn-codedeploy-deploymentgroup-onpremisestagset-onpremisestagsetlist

RevisionLocationProperty

class CfnDeploymentGroupPropsMixin.RevisionLocationProperty(*, git_hub_location=None, revision_type=None, s3_location=None)

Bases: object

RevisionLocation is a property that defines the location of the CodeDeploy application revision to deploy.

Parameters:

git_hub_location (Union[IResolvable, GitHubLocationProperty, Dict[str, Any], None]) – Information about the location of application artifacts stored in GitHub.
revision_type (Optional[str]) – The type of application revision:. - S3: An application revision stored in Amazon S3. - GitHub: An application revision stored in GitHub (EC2/On-premises deployments only). - String: A YAML-formatted or JSON-formatted string ( AWS Lambda deployments only). - AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.
s3_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – Information about the location of a revision stored in Amazon S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-revisionlocation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

revision_location_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.RevisionLocationProperty(
    git_hub_location=codedeploy_mixins.CfnDeploymentGroupPropsMixin.GitHubLocationProperty(
        commit_id="commitId",
        repository="repository"
    ),
    revision_type="revisionType",
    s3_location=codedeploy_mixins.CfnDeploymentGroupPropsMixin.S3LocationProperty(
        bucket="bucket",
        bundle_type="bundleType",
        e_tag="eTag",
        key="key",
        version="version"
    )
)

Attributes

git_hub_location

Information about the location of application artifacts stored in GitHub.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-revisionlocation.html#cfn-codedeploy-deploymentgroup-revisionlocation-githublocation

revision_type

.

S3: An application revision stored in Amazon S3.
GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
String: A YAML-formatted or JSON-formatted string ( AWS Lambda deployments only).
AppSpecContent: An AppSpecContent object that contains the contents of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML stored as a RawString.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-revisionlocation.html#cfn-codedeploy-deploymentgroup-revisionlocation-revisiontype
Type:: The type of application revision

s3_location

Information about the location of a revision stored in Amazon S3.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-revisionlocation.html#cfn-codedeploy-deploymentgroup-revisionlocation-s3location

S3LocationProperty

class CfnDeploymentGroupPropsMixin.S3LocationProperty(*, bucket=None, bundle_type=None, e_tag=None, key=None, version=None)

Bases: object

S3Location is a property of the CodeDeploy DeploymentGroup Revision property that specifies the location of an application revision that is stored in Amazon Simple Storage Service ( Amazon S3 ).

Parameters:

bucket (Optional[str]) – The name of the Amazon S3 bucket where the application revision is stored.
bundle_type (Optional[str]) – The file type of the application revision. Must be one of the following:. - JSON - tar: A tar archive file. - tgz: A compressed tar archive file. - YAML - zip: A zip archive file.
e_tag (Optional[str]) – The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision. If the ETag is not specified as an input parameter, ETag validation of the object is skipped.
key (Optional[str]) – The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
version (Optional[str]) – A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision. If the version is not specified, the system uses the most recent version by default.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-s3location.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

s3_location_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.S3LocationProperty(
    bucket="bucket",
    bundle_type="bundleType",
    e_tag="eTag",
    key="key",
    version="version"
)

Attributes

bucket

The name of the Amazon S3 bucket where the application revision is stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-s3location.html#cfn-codedeploy-deploymentgroup-s3location-bucket

bundle_type

.

JSON
tar: A tar archive file.
tgz: A compressed tar archive file.
YAML
zip: A zip archive file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-s3location.html#cfn-codedeploy-deploymentgroup-s3location-bundletype
Type:: The file type of the application revision. Must be one of the following

e_tag

The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the ETag is not specified as an input parameter, ETag validation of the object is skipped.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-s3location.html#cfn-codedeploy-deploymentgroup-s3location-etag

key

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-s3location.html#cfn-codedeploy-deploymentgroup-s3location-key

version

A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the version is not specified, the system uses the most recent version by default.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-s3location.html#cfn-codedeploy-deploymentgroup-s3location-version

TagFilterProperty

class CfnDeploymentGroupPropsMixin.TagFilterProperty(*, key=None, type=None, value=None)

Bases: object

TagFilter is a property type of the AWS::CodeDeploy::DeploymentGroup resource that specifies which on-premises instances to associate with the deployment group. To register on-premise instances with AWS CodeDeploy , see Configure Existing On-Premises Instances by Using AWS CodeDeploy in the AWS CodeDeploy User Guide .

For more information about using tags and tag groups to help manage your Amazon EC2 instances and on-premises instances, see Tagging Instances for Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide .

Parameters:

key (Optional[str]) – The on-premises instance tag filter key.
type (Optional[str]) – The on-premises instance tag filter type:. - KEY_ONLY: Key only. - VALUE_ONLY: Value only. - KEY_AND_VALUE: Key and value.
value (Optional[str]) – The on-premises instance tag filter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

tag_filter_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.TagFilterProperty(
    key="key",
    type="type",
    value="value"
)

Attributes

key

The on-premises instance tag filter key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-key

type

.

KEY_ONLY: Key only.
VALUE_ONLY: Value only.
KEY_AND_VALUE: Key and value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-type
Type:: The on-premises instance tag filter type

value

The on-premises instance tag filter value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html#cfn-codedeploy-deploymentgroup-tagfilter-value

TargetGroupInfoProperty

class CfnDeploymentGroupPropsMixin.TargetGroupInfoProperty(*, name=None)

Bases: object

The TargetGroupInfo property type specifies information about a target group in ELB to use in a deployment.

Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see TargetGroupInfo in the AWS CodeDeploy API Reference

If you specify the TargetGroupInfo property, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL for CodeDeploy to route your traffic using the specified target groups.

TargetGroupInfo is a property of the LoadBalancerInfo property type.

Parameters:: name (Optional[str]) – For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes. No duplicates allowed. .. epigraph:: CloudFormation supports blue/green deployments on AWS Lambda compute platforms only. This value cannot exceed 32 characters, so you should use the Name property of the target group, or the TargetGroupName attribute with the Fn::GetAtt intrinsic function, as shown in the following example. Don’t use the group’s Amazon Resource Name (ARN) or TargetGroupFullName attribute.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

target_group_info_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupInfoProperty(
    name="name"
)

Attributes

name

For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment registered with.

For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes. No duplicates allowed. .. epigraph:

CloudFormation supports blue/green deployments on AWS Lambda compute platforms only.

This value cannot exceed 32 characters, so you should use the Name property of the target group, or the TargetGroupName attribute with the Fn::GetAtt intrinsic function, as shown in the following example. Don’t use the group’s Amazon Resource Name (ARN) or TargetGroupFullName attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html#cfn-codedeploy-deploymentgroup-targetgroupinfo-name

TargetGroupPairInfoProperty

class CfnDeploymentGroupPropsMixin.TargetGroupPairInfoProperty(*, prod_traffic_route=None, target_groups=None, test_traffic_route=None)

Bases: object

Information about two target groups and how traffic is routed during an Amazon ECS deployment.

An optional test traffic route can be specified.

Parameters:

prod_traffic_route (Union[IResolvable, TrafficRouteProperty, Dict[str, Any], None]) – The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
target_groups (Union[IResolvable, Sequence[Union[IResolvable, TargetGroupInfoProperty, Dict[str, Any]]], None]) – One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.
test_traffic_route (Union[IResolvable, TrafficRouteProperty, Dict[str, Any], None]) – An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

target_group_pair_info_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupPairInfoProperty(
    prod_traffic_route=codedeploy_mixins.CfnDeploymentGroupPropsMixin.TrafficRouteProperty(
        listener_arns=["listenerArns"]
    ),
    target_groups=[codedeploy_mixins.CfnDeploymentGroupPropsMixin.TargetGroupInfoProperty(
        name="name"
    )],
    test_traffic_route=codedeploy_mixins.CfnDeploymentGroupPropsMixin.TrafficRouteProperty(
        listener_arns=["listenerArns"]
    )
)

Attributes

prod_traffic_route

The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-prodtrafficroute

target_groups

One pair of target groups.

One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-targetgroups

test_traffic_route

An optional path used by a load balancer to route test traffic after an Amazon ECS deployment.

Validation can occur while test traffic is served during a deployment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html#cfn-codedeploy-deploymentgroup-targetgrouppairinfo-testtrafficroute

TrafficRouteProperty

class CfnDeploymentGroupPropsMixin.TrafficRouteProperty(*, listener_arns=None)

Bases: object

Information about a listener.

The listener contains the path used to route traffic that is received from the load balancer to a target group.

Parameters:: listener_arns (Optional[Sequence[str]]) – The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

traffic_route_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.TrafficRouteProperty(
    listener_arns=["listenerArns"]
)

Attributes

listener_arns

The Amazon Resource Name (ARN) of one listener.

The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html#cfn-codedeploy-deploymentgroup-trafficroute-listenerarns

TriggerConfigProperty

class CfnDeploymentGroupPropsMixin.TriggerConfigProperty(*, trigger_events=None, trigger_name=None, trigger_target_arn=None)

Bases: object

Information about notification triggers for the deployment group.

Parameters:

trigger_events (Optional[Sequence[str]]) – The event type or types that trigger notifications.
trigger_name (Optional[str]) – The name of the notification trigger.
trigger_target_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codedeploy import mixins as codedeploy_mixins

trigger_config_property = codedeploy_mixins.CfnDeploymentGroupPropsMixin.TriggerConfigProperty(
    trigger_events=["triggerEvents"],
    trigger_name="triggerName",
    trigger_target_arn="triggerTargetArn"
)

Attributes

trigger_events

The event type or types that trigger notifications.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggerevents

trigger_name

The name of the notification trigger.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggername

trigger_target_arn

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggertargetarn