CfnDeploymentGroup

class aws_cdk.aws_codedeploy.CfnDeploymentGroup(scope, id, *, alarm_configuration=None, application_name, auto_rollback_configuration=None, auto_scaling_groups=None, blue_green_deployment_configuration=None, deployment=None, deployment_config_name=None, deployment_group_name=None, deployment_style=None, ec2_tag_filters=None, ec2_tag_set=None, ecs_services=None, load_balancer_info=None, on_premises_instance_tag_filters=None, on_premises_tag_set=None, service_role_arn, trigger_configurations=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::CodeDeploy::DeploymentGroup.

CloudformationResource

AWS::CodeDeploy::DeploymentGroup

Link

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

Example:

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

cfn_deployment_group = codedeploy.CfnDeploymentGroup(self, "MyCfnDeploymentGroup",
    application_name="applicationName",
    service_role_arn="serviceRoleArn",

    # the properties below are optional
    alarm_configuration=codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty(
        alarms=[codedeploy.CfnDeploymentGroup.AlarmProperty(
            name="name"
        )],
        enabled=False,
        ignore_poll_alarm_failure=False
    ),
    auto_rollback_configuration=codedeploy.CfnDeploymentGroup.AutoRollbackConfigurationProperty(
        enabled=False,
        events=["events"]
    ),
    auto_scaling_groups=["autoScalingGroups"],
    blue_green_deployment_configuration=codedeploy.CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty(
        deployment_ready_option=codedeploy.CfnDeploymentGroup.DeploymentReadyOptionProperty(
            action_on_timeout="actionOnTimeout",
            wait_time_in_minutes=123
        ),
        green_fleet_provisioning_option=codedeploy.CfnDeploymentGroup.GreenFleetProvisioningOptionProperty(
            action="action"
        ),
        terminate_blue_instances_on_deployment_success=codedeploy.CfnDeploymentGroup.BlueInstanceTerminationOptionProperty(
            action="action",
            termination_wait_time_in_minutes=123
        )
    ),
    deployment=codedeploy.CfnDeploymentGroup.DeploymentProperty(
        revision=codedeploy.CfnDeploymentGroup.RevisionLocationProperty(
            git_hub_location=codedeploy.CfnDeploymentGroup.GitHubLocationProperty(
                commit_id="commitId",
                repository="repository"
            ),
            revision_type="revisionType",
            s3_location=codedeploy.CfnDeploymentGroup.S3LocationProperty(
                bucket="bucket",
                key="key",

                # the properties below are optional
                bundle_type="bundleType",
                e_tag="eTag",
                version="version"
            )
        ),

        # the properties below are optional
        description="description",
        ignore_application_stop_failures=False
    ),
    deployment_config_name="deploymentConfigName",
    deployment_group_name="deploymentGroupName",
    deployment_style=codedeploy.CfnDeploymentGroup.DeploymentStyleProperty(
        deployment_option="deploymentOption",
        deployment_type="deploymentType"
    ),
    ec2_tag_filters=[codedeploy.CfnDeploymentGroup.EC2TagFilterProperty(
        key="key",
        type="type",
        value="value"
    )],
    ec2_tag_set=codedeploy.CfnDeploymentGroup.EC2TagSetProperty(
        ec2_tag_set_list=[codedeploy.CfnDeploymentGroup.EC2TagSetListObjectProperty(
            ec2_tag_group=[codedeploy.CfnDeploymentGroup.EC2TagFilterProperty(
                key="key",
                type="type",
                value="value"
            )]
        )]
    ),
    ecs_services=[codedeploy.CfnDeploymentGroup.ECSServiceProperty(
        cluster_name="clusterName",
        service_name="serviceName"
    )],
    load_balancer_info=codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty(
        elb_info_list=[codedeploy.CfnDeploymentGroup.ELBInfoProperty(
            name="name"
        )],
        target_group_info_list=[codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty(
            name="name"
        )]
    ),
    on_premises_instance_tag_filters=[codedeploy.CfnDeploymentGroup.TagFilterProperty(
        key="key",
        type="type",
        value="value"
    )],
    on_premises_tag_set=codedeploy.CfnDeploymentGroup.OnPremisesTagSetProperty(
        on_premises_tag_set_list=[codedeploy.CfnDeploymentGroup.OnPremisesTagSetListObjectProperty(
            on_premises_tag_group=[codedeploy.CfnDeploymentGroup.TagFilterProperty(
                key="key",
                type="type",
                value="value"
            )]
        )]
    ),
    trigger_configurations=[codedeploy.CfnDeploymentGroup.TriggerConfigProperty(
        trigger_events=["triggerEvents"],
        trigger_name="triggerName",
        trigger_target_arn="triggerTargetArn"
    )]
)

Create a new AWS::CodeDeploy::DeploymentGroup.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CodeDeploy::DeploymentGroup'
alarm_configuration

AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration.

Link

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

Return type

Union[AlarmConfigurationProperty, IResolvable, None]

application_name

AWS::CodeDeploy::DeploymentGroup.ApplicationName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-applicationname

Return type

str

auto_rollback_configuration

AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration.

Link

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

Return type

Union[IResolvable, AutoRollbackConfigurationProperty, None]

auto_scaling_groups

AWS::CodeDeploy::DeploymentGroup.AutoScalingGroups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autoscalinggroups

Return type

Optional[List[str]]

blue_green_deployment_configuration

AWS::CodeDeploy::DeploymentGroup.BlueGreenDeploymentConfiguration.

Link

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

Return type

Union[IResolvable, BlueGreenDeploymentConfigurationProperty, None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

deployment

AWS::CodeDeploy::DeploymentGroup.Deployment.

Link

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

Return type

Union[IResolvable, DeploymentProperty, None]

deployment_config_name

AWS::CodeDeploy::DeploymentGroup.DeploymentConfigName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentconfigname

Return type

Optional[str]

deployment_group_name

AWS::CodeDeploy::DeploymentGroup.DeploymentGroupName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentgroupname

Return type

Optional[str]

deployment_style

AWS::CodeDeploy::DeploymentGroup.DeploymentStyle.

Link

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

Return type

Union[IResolvable, DeploymentStyleProperty, None]

ec2_tag_filters

AWS::CodeDeploy::DeploymentGroup.Ec2TagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ec2tagfilters

Return type

Union[IResolvable, List[Union[IResolvable, EC2TagFilterProperty]], None]

ec2_tag_set

AWS::CodeDeploy::DeploymentGroup.Ec2TagSet.

Link

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

Return type

Union[IResolvable, EC2TagSetProperty, None]

ecs_services

AWS::CodeDeploy::DeploymentGroup.ECSServices.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ecsservices

Return type

Union[IResolvable, List[Union[IResolvable, ECSServiceProperty]], None]

load_balancer_info

AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo.

Link

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

Return type

Union[IResolvable, LoadBalancerInfoProperty, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

on_premises_instance_tag_filters

AWS::CodeDeploy::DeploymentGroup.OnPremisesInstanceTagFilters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-onpremisesinstancetagfilters

Return type

Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]

on_premises_tag_set

AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet.

Link

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

Return type

Union[IResolvable, OnPremisesTagSetProperty, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

service_role_arn

AWS::CodeDeploy::DeploymentGroup.ServiceRoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-servicerolearn

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

trigger_configurations

AWS::CodeDeploy::DeploymentGroup.TriggerConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, TriggerConfigProperty]], None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AlarmConfigurationProperty

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

Bases: object

Parameters
  • alarms (Union[IResolvable, Sequence[Union[IResolvable, AlarmProperty]], None]) – CfnDeploymentGroup.AlarmConfigurationProperty.Alarms.

  • enabled (Union[bool, IResolvable, None]) – CfnDeploymentGroup.AlarmConfigurationProperty.Enabled.

  • ignore_poll_alarm_failure (Union[bool, IResolvable, None]) – CfnDeploymentGroup.AlarmConfigurationProperty.IgnorePollAlarmFailure.

Link

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

Example:

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

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

Attributes

alarms

CfnDeploymentGroup.AlarmConfigurationProperty.Alarms.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, AlarmProperty]], None]

enabled

CfnDeploymentGroup.AlarmConfigurationProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable, None]

ignore_poll_alarm_failure

CfnDeploymentGroup.AlarmConfigurationProperty.IgnorePollAlarmFailure.

Link

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

Return type

Union[bool, IResolvable, None]

AlarmProperty

class CfnDeploymentGroup.AlarmProperty(*, name=None)

Bases: object

Parameters

name (Optional[str]) – CfnDeploymentGroup.AlarmProperty.Name.

Link

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

Example:

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

alarm_property = codedeploy.CfnDeploymentGroup.AlarmProperty(
    name="name"
)

Attributes

name

CfnDeploymentGroup.AlarmProperty.Name.

Link

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

Return type

Optional[str]

AutoRollbackConfigurationProperty

class CfnDeploymentGroup.AutoRollbackConfigurationProperty(*, enabled=None, events=None)

Bases: object

Parameters
  • enabled (Union[bool, IResolvable, None]) – CfnDeploymentGroup.AutoRollbackConfigurationProperty.Enabled.

  • events (Optional[Sequence[str]]) – CfnDeploymentGroup.AutoRollbackConfigurationProperty.Events.

Link

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

Example:

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

auto_rollback_configuration_property = codedeploy.CfnDeploymentGroup.AutoRollbackConfigurationProperty(
    enabled=False,
    events=["events"]
)

Attributes

enabled

CfnDeploymentGroup.AutoRollbackConfigurationProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable, None]

events

CfnDeploymentGroup.AutoRollbackConfigurationProperty.Events.

Link

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

Return type

Optional[List[str]]

BlueGreenDeploymentConfigurationProperty

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

Bases: object

Parameters
Link

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

Example:

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

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

Attributes

deployment_ready_option

CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty.DeploymentReadyOption.

Link

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

Return type

Union[IResolvable, DeploymentReadyOptionProperty, None]

green_fleet_provisioning_option

CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty.GreenFleetProvisioningOption.

Link

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

Return type

Union[IResolvable, GreenFleetProvisioningOptionProperty, None]

terminate_blue_instances_on_deployment_success

CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty.TerminateBlueInstancesOnDeploymentSuccess.

Link

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

Return type

Union[IResolvable, BlueInstanceTerminationOptionProperty, None]

BlueInstanceTerminationOptionProperty

class CfnDeploymentGroup.BlueInstanceTerminationOptionProperty(*, action=None, termination_wait_time_in_minutes=None)

Bases: object

Parameters
  • action (Optional[str]) – CfnDeploymentGroup.BlueInstanceTerminationOptionProperty.Action.

  • termination_wait_time_in_minutes (Union[int, float, None]) – CfnDeploymentGroup.BlueInstanceTerminationOptionProperty.TerminationWaitTimeInMinutes.

Link

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

Example:

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

blue_instance_termination_option_property = codedeploy.CfnDeploymentGroup.BlueInstanceTerminationOptionProperty(
    action="action",
    termination_wait_time_in_minutes=123
)

Attributes

action

CfnDeploymentGroup.BlueInstanceTerminationOptionProperty.Action.

Link

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

Return type

Optional[str]

termination_wait_time_in_minutes

CfnDeploymentGroup.BlueInstanceTerminationOptionProperty.TerminationWaitTimeInMinutes.

Link

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

Return type

Union[int, float, None]

DeploymentProperty

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

Bases: object

Parameters
  • description (Optional[str]) – CfnDeploymentGroup.DeploymentProperty.Description.

  • ignore_application_stop_failures (Union[bool, IResolvable, None]) – CfnDeploymentGroup.DeploymentProperty.IgnoreApplicationStopFailures.

  • revision (Union[IResolvable, RevisionLocationProperty]) – CfnDeploymentGroup.DeploymentProperty.Revision.

Link

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

Example:

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

deployment_property = codedeploy.CfnDeploymentGroup.DeploymentProperty(
    revision=codedeploy.CfnDeploymentGroup.RevisionLocationProperty(
        git_hub_location=codedeploy.CfnDeploymentGroup.GitHubLocationProperty(
            commit_id="commitId",
            repository="repository"
        ),
        revision_type="revisionType",
        s3_location=codedeploy.CfnDeploymentGroup.S3LocationProperty(
            bucket="bucket",
            key="key",

            # the properties below are optional
            bundle_type="bundleType",
            e_tag="eTag",
            version="version"
        )
    ),

    # the properties below are optional
    description="description",
    ignore_application_stop_failures=False
)

Attributes

description

CfnDeploymentGroup.DeploymentProperty.Description.

Link

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

Return type

Optional[str]

ignore_application_stop_failures

CfnDeploymentGroup.DeploymentProperty.IgnoreApplicationStopFailures.

Link

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

Return type

Union[bool, IResolvable, None]

revision

CfnDeploymentGroup.DeploymentProperty.Revision.

Link

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

Return type

Union[IResolvable, RevisionLocationProperty]

DeploymentReadyOptionProperty

class CfnDeploymentGroup.DeploymentReadyOptionProperty(*, action_on_timeout=None, wait_time_in_minutes=None)

Bases: object

Parameters
  • action_on_timeout (Optional[str]) – CfnDeploymentGroup.DeploymentReadyOptionProperty.ActionOnTimeout.

  • wait_time_in_minutes (Union[int, float, None]) – CfnDeploymentGroup.DeploymentReadyOptionProperty.WaitTimeInMinutes.

Link

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

Example:

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

deployment_ready_option_property = codedeploy.CfnDeploymentGroup.DeploymentReadyOptionProperty(
    action_on_timeout="actionOnTimeout",
    wait_time_in_minutes=123
)

Attributes

action_on_timeout

CfnDeploymentGroup.DeploymentReadyOptionProperty.ActionOnTimeout.

Link

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

Return type

Optional[str]

wait_time_in_minutes

CfnDeploymentGroup.DeploymentReadyOptionProperty.WaitTimeInMinutes.

Link

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

Return type

Union[int, float, None]

DeploymentStyleProperty

class CfnDeploymentGroup.DeploymentStyleProperty(*, deployment_option=None, deployment_type=None)

Bases: object

Parameters
  • deployment_option (Optional[str]) – CfnDeploymentGroup.DeploymentStyleProperty.DeploymentOption.

  • deployment_type (Optional[str]) – CfnDeploymentGroup.DeploymentStyleProperty.DeploymentType.

Link

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

Example:

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

deployment_style_property = codedeploy.CfnDeploymentGroup.DeploymentStyleProperty(
    deployment_option="deploymentOption",
    deployment_type="deploymentType"
)

Attributes

deployment_option

CfnDeploymentGroup.DeploymentStyleProperty.DeploymentOption.

Link

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

Return type

Optional[str]

deployment_type

CfnDeploymentGroup.DeploymentStyleProperty.DeploymentType.

Link

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

Return type

Optional[str]

EC2TagFilterProperty

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

Bases: object

Parameters
  • key (Optional[str]) – CfnDeploymentGroup.EC2TagFilterProperty.Key.

  • type (Optional[str]) – CfnDeploymentGroup.EC2TagFilterProperty.Type.

  • value (Optional[str]) – CfnDeploymentGroup.EC2TagFilterProperty.Value.

Link

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

Example:

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

e_c2_tag_filter_property = codedeploy.CfnDeploymentGroup.EC2TagFilterProperty(
    key="key",
    type="type",
    value="value"
)

Attributes

key

CfnDeploymentGroup.EC2TagFilterProperty.Key.

Link

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

Return type

Optional[str]

type

CfnDeploymentGroup.EC2TagFilterProperty.Type.

Link

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

Return type

Optional[str]

value

CfnDeploymentGroup.EC2TagFilterProperty.Value.

Link

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

Return type

Optional[str]

EC2TagSetListObjectProperty

class CfnDeploymentGroup.EC2TagSetListObjectProperty(*, ec2_tag_group=None)

Bases: object

Parameters

ec2_tag_group (Union[IResolvable, Sequence[Union[IResolvable, EC2TagFilterProperty]], None]) – CfnDeploymentGroup.EC2TagSetListObjectProperty.Ec2TagGroup.

Link

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

Example:

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

e_c2_tag_set_list_object_property = codedeploy.CfnDeploymentGroup.EC2TagSetListObjectProperty(
    ec2_tag_group=[codedeploy.CfnDeploymentGroup.EC2TagFilterProperty(
        key="key",
        type="type",
        value="value"
    )]
)

Attributes

ec2_tag_group

CfnDeploymentGroup.EC2TagSetListObjectProperty.Ec2TagGroup.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, EC2TagFilterProperty]], None]

EC2TagSetProperty

class CfnDeploymentGroup.EC2TagSetProperty(*, ec2_tag_set_list=None)

Bases: object

Parameters

ec2_tag_set_list (Union[IResolvable, Sequence[Union[IResolvable, EC2TagSetListObjectProperty]], None]) – CfnDeploymentGroup.EC2TagSetProperty.Ec2TagSetList.

Link

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

Example:

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

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

Attributes

ec2_tag_set_list

CfnDeploymentGroup.EC2TagSetProperty.Ec2TagSetList.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, EC2TagSetListObjectProperty]], None]

ECSServiceProperty

class CfnDeploymentGroup.ECSServiceProperty(*, cluster_name, service_name)

Bases: object

Parameters
  • cluster_name (str) – CfnDeploymentGroup.ECSServiceProperty.ClusterName.

  • service_name (str) – CfnDeploymentGroup.ECSServiceProperty.ServiceName.

Link

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

Example:

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

e_cSService_property = codedeploy.CfnDeploymentGroup.ECSServiceProperty(
    cluster_name="clusterName",
    service_name="serviceName"
)

Attributes

cluster_name

CfnDeploymentGroup.ECSServiceProperty.ClusterName.

Link

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

Return type

str

service_name

CfnDeploymentGroup.ECSServiceProperty.ServiceName.

Link

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

Return type

str

ELBInfoProperty

class CfnDeploymentGroup.ELBInfoProperty(*, name=None)

Bases: object

Parameters

name (Optional[str]) – CfnDeploymentGroup.ELBInfoProperty.Name.

Link

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

Example:

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

e_lBInfo_property = codedeploy.CfnDeploymentGroup.ELBInfoProperty(
    name="name"
)

Attributes

name

CfnDeploymentGroup.ELBInfoProperty.Name.

Link

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

Return type

Optional[str]

GitHubLocationProperty

class CfnDeploymentGroup.GitHubLocationProperty(*, commit_id, repository)

Bases: object

Parameters
  • commit_id (str) – CfnDeploymentGroup.GitHubLocationProperty.CommitId.

  • repository (str) – CfnDeploymentGroup.GitHubLocationProperty.Repository.

Link

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

Example:

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

git_hub_location_property = codedeploy.CfnDeploymentGroup.GitHubLocationProperty(
    commit_id="commitId",
    repository="repository"
)

Attributes

commit_id

CfnDeploymentGroup.GitHubLocationProperty.CommitId.

Link

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

Return type

str

repository

CfnDeploymentGroup.GitHubLocationProperty.Repository.

Link

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

Return type

str

GreenFleetProvisioningOptionProperty

class CfnDeploymentGroup.GreenFleetProvisioningOptionProperty(*, action=None)

Bases: object

Parameters

action (Optional[str]) – CfnDeploymentGroup.GreenFleetProvisioningOptionProperty.Action.

Link

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

Example:

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

green_fleet_provisioning_option_property = codedeploy.CfnDeploymentGroup.GreenFleetProvisioningOptionProperty(
    action="action"
)

Attributes

action

CfnDeploymentGroup.GreenFleetProvisioningOptionProperty.Action.

Link

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

Return type

Optional[str]

LoadBalancerInfoProperty

class CfnDeploymentGroup.LoadBalancerInfoProperty(*, elb_info_list=None, target_group_info_list=None)

Bases: object

Parameters
Link

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

Example:

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

load_balancer_info_property = codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty(
    elb_info_list=[codedeploy.CfnDeploymentGroup.ELBInfoProperty(
        name="name"
    )],
    target_group_info_list=[codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty(
        name="name"
    )]
)

Attributes

elb_info_list

CfnDeploymentGroup.LoadBalancerInfoProperty.ElbInfoList.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ELBInfoProperty]], None]

target_group_info_list

CfnDeploymentGroup.LoadBalancerInfoProperty.TargetGroupInfoList.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, TargetGroupInfoProperty]], None]

OnPremisesTagSetListObjectProperty

class CfnDeploymentGroup.OnPremisesTagSetListObjectProperty(*, on_premises_tag_group=None)

Bases: object

Parameters

on_premises_tag_group (Union[IResolvable, Sequence[Union[IResolvable, TagFilterProperty]], None]) – CfnDeploymentGroup.OnPremisesTagSetListObjectProperty.OnPremisesTagGroup.

Link

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

Example:

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

on_premises_tag_set_list_object_property = codedeploy.CfnDeploymentGroup.OnPremisesTagSetListObjectProperty(
    on_premises_tag_group=[codedeploy.CfnDeploymentGroup.TagFilterProperty(
        key="key",
        type="type",
        value="value"
    )]
)

Attributes

on_premises_tag_group

CfnDeploymentGroup.OnPremisesTagSetListObjectProperty.OnPremisesTagGroup.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, TagFilterProperty]], None]

OnPremisesTagSetProperty

class CfnDeploymentGroup.OnPremisesTagSetProperty(*, on_premises_tag_set_list=None)

Bases: object

Parameters

on_premises_tag_set_list (Union[IResolvable, Sequence[Union[IResolvable, OnPremisesTagSetListObjectProperty]], None]) – CfnDeploymentGroup.OnPremisesTagSetProperty.OnPremisesTagSetList.

Link

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

Example:

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

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

Attributes

on_premises_tag_set_list

CfnDeploymentGroup.OnPremisesTagSetProperty.OnPremisesTagSetList.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, OnPremisesTagSetListObjectProperty]], None]

RevisionLocationProperty

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

Bases: object

Parameters
  • git_hub_location (Union[IResolvable, GitHubLocationProperty, None]) – CfnDeploymentGroup.RevisionLocationProperty.GitHubLocation.

  • revision_type (Optional[str]) – CfnDeploymentGroup.RevisionLocationProperty.RevisionType.

  • s3_location (Union[IResolvable, S3LocationProperty, None]) – CfnDeploymentGroup.RevisionLocationProperty.S3Location.

Link

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

Example:

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

revision_location_property = codedeploy.CfnDeploymentGroup.RevisionLocationProperty(
    git_hub_location=codedeploy.CfnDeploymentGroup.GitHubLocationProperty(
        commit_id="commitId",
        repository="repository"
    ),
    revision_type="revisionType",
    s3_location=codedeploy.CfnDeploymentGroup.S3LocationProperty(
        bucket="bucket",
        key="key",

        # the properties below are optional
        bundle_type="bundleType",
        e_tag="eTag",
        version="version"
    )
)

Attributes

git_hub_location

CfnDeploymentGroup.RevisionLocationProperty.GitHubLocation.

Link

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

Return type

Union[IResolvable, GitHubLocationProperty, None]

revision_type

CfnDeploymentGroup.RevisionLocationProperty.RevisionType.

Link

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

Return type

Optional[str]

s3_location

CfnDeploymentGroup.RevisionLocationProperty.S3Location.

Link

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

Return type

Union[IResolvable, S3LocationProperty, None]

S3LocationProperty

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

Bases: object

Parameters
  • bucket (str) – CfnDeploymentGroup.S3LocationProperty.Bucket.

  • bundle_type (Optional[str]) – CfnDeploymentGroup.S3LocationProperty.BundleType.

  • e_tag (Optional[str]) – CfnDeploymentGroup.S3LocationProperty.ETag.

  • key (str) – CfnDeploymentGroup.S3LocationProperty.Key.

  • version (Optional[str]) – CfnDeploymentGroup.S3LocationProperty.Version.

Link

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

Example:

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

s3_location_property = codedeploy.CfnDeploymentGroup.S3LocationProperty(
    bucket="bucket",
    key="key",

    # the properties below are optional
    bundle_type="bundleType",
    e_tag="eTag",
    version="version"
)

Attributes

bucket

CfnDeploymentGroup.S3LocationProperty.Bucket.

Link

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

Return type

str

bundle_type

CfnDeploymentGroup.S3LocationProperty.BundleType.

Link

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

Return type

Optional[str]

e_tag

CfnDeploymentGroup.S3LocationProperty.ETag.

Link

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

Return type

Optional[str]

key

CfnDeploymentGroup.S3LocationProperty.Key.

Link

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

Return type

str

version

CfnDeploymentGroup.S3LocationProperty.Version.

Link

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

Return type

Optional[str]

TagFilterProperty

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

Bases: object

Parameters
  • key (Optional[str]) – CfnDeploymentGroup.TagFilterProperty.Key.

  • type (Optional[str]) – CfnDeploymentGroup.TagFilterProperty.Type.

  • value (Optional[str]) – CfnDeploymentGroup.TagFilterProperty.Value.

Link

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

Example:

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

tag_filter_property = codedeploy.CfnDeploymentGroup.TagFilterProperty(
    key="key",
    type="type",
    value="value"
)

Attributes

key

CfnDeploymentGroup.TagFilterProperty.Key.

Link

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

Return type

Optional[str]

type

CfnDeploymentGroup.TagFilterProperty.Type.

Link

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

Return type

Optional[str]

value

CfnDeploymentGroup.TagFilterProperty.Value.

Link

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

Return type

Optional[str]

TargetGroupInfoProperty

class CfnDeploymentGroup.TargetGroupInfoProperty(*, name=None)

Bases: object

Parameters

name (Optional[str]) – CfnDeploymentGroup.TargetGroupInfoProperty.Name.

Link

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

Example:

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

target_group_info_property = codedeploy.CfnDeploymentGroup.TargetGroupInfoProperty(
    name="name"
)

Attributes

name

CfnDeploymentGroup.TargetGroupInfoProperty.Name.

Link

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

Return type

Optional[str]

TriggerConfigProperty

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

Bases: object

Parameters
  • trigger_events (Optional[Sequence[str]]) – CfnDeploymentGroup.TriggerConfigProperty.TriggerEvents.

  • trigger_name (Optional[str]) – CfnDeploymentGroup.TriggerConfigProperty.TriggerName.

  • trigger_target_arn (Optional[str]) – CfnDeploymentGroup.TriggerConfigProperty.TriggerTargetArn.

Link

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

Example:

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

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

Attributes

trigger_events

CfnDeploymentGroup.TriggerConfigProperty.TriggerEvents.

Link

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

Return type

Optional[List[str]]

trigger_name

CfnDeploymentGroup.TriggerConfigProperty.TriggerName.

Link

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

Return type

Optional[str]

trigger_target_arn

CfnDeploymentGroup.TriggerConfigProperty.TriggerTargetArn.

Link

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

Return type

Optional[str]