CfnPipeline

class aws_cdk.aws_codepipeline.CfnPipeline(scope, id, *, role_arn, stages, artifact_store=None, artifact_stores=None, disable_inbound_stage_transitions=None, execution_mode=None, name=None, pipeline_type=None, restart_execution_on_update=None, tags=None, triggers=None, variables=None)

Bases: CfnResource

The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.

For more information, see What Is CodePipeline? in the CodePipeline User Guide .

For an example in YAML and JSON that contains the parameters in this reference, see Examples .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html
CloudformationResource:: AWS::CodePipeline::Pipeline
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 import aws_codepipeline as codepipeline

# configuration: Any

cfn_pipeline = codepipeline.CfnPipeline(self, "MyCfnPipeline",
    role_arn="roleArn",
    stages=[codepipeline.CfnPipeline.StageDeclarationProperty(
        actions=[codepipeline.CfnPipeline.ActionDeclarationProperty(
            action_type_id=codepipeline.CfnPipeline.ActionTypeIdProperty(
                category="category",
                owner="owner",
                provider="provider",
                version="version"
            ),
            name="name",

            # the properties below are optional
            commands=["commands"],
            configuration=configuration,
            input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                name="name"
            )],
            namespace="namespace",
            output_artifacts=[codepipeline.CfnPipeline.OutputArtifactProperty(
                name="name",

                # the properties below are optional
                files=["files"]
            )],
            output_variables=["outputVariables"],
            region="region",
            role_arn="roleArn",
            run_order=123,
            timeout_in_minutes=123
        )],
        name="name",

        # the properties below are optional
        before_entry=codepipeline.CfnPipeline.BeforeEntryConditionsProperty(
            conditions=[codepipeline.CfnPipeline.ConditionProperty(
                result="result",
                rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                    configuration=configuration,
                    input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                        name="name"
                    )],
                    name="name",
                    region="region",
                    role_arn="roleArn",
                    rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                        category="category",
                        owner="owner",
                        provider="provider",
                        version="version"
                    )
                )]
            )]
        ),
        blockers=[codepipeline.CfnPipeline.BlockerDeclarationProperty(
            name="name",
            type="type"
        )],
        on_failure=codepipeline.CfnPipeline.FailureConditionsProperty(
            conditions=[codepipeline.CfnPipeline.ConditionProperty(
                result="result",
                rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                    configuration=configuration,
                    input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                        name="name"
                    )],
                    name="name",
                    region="region",
                    role_arn="roleArn",
                    rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                        category="category",
                        owner="owner",
                        provider="provider",
                        version="version"
                    )
                )]
            )],
            result="result",
            retry_configuration=codepipeline.CfnPipeline.RetryConfigurationProperty(
                retry_mode="retryMode"
            )
        ),
        on_success=codepipeline.CfnPipeline.SuccessConditionsProperty(
            conditions=[codepipeline.CfnPipeline.ConditionProperty(
                result="result",
                rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                    configuration=configuration,
                    input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                        name="name"
                    )],
                    name="name",
                    region="region",
                    role_arn="roleArn",
                    rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                        category="category",
                        owner="owner",
                        provider="provider",
                        version="version"
                    )
                )]
            )]
        )
    )],

    # the properties below are optional
    artifact_store=codepipeline.CfnPipeline.ArtifactStoreProperty(
        location="location",
        type="type",

        # the properties below are optional
        encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty(
            id="id",
            type="type"
        )
    ),
    artifact_stores=[codepipeline.CfnPipeline.ArtifactStoreMapProperty(
        artifact_store=codepipeline.CfnPipeline.ArtifactStoreProperty(
            location="location",
            type="type",

            # the properties below are optional
            encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty(
                id="id",
                type="type"
            )
        ),
        region="region"
    )],
    disable_inbound_stage_transitions=[codepipeline.CfnPipeline.StageTransitionProperty(
        reason="reason",
        stage_name="stageName"
    )],
    execution_mode="executionMode",
    name="name",
    pipeline_type="pipelineType",
    restart_execution_on_update=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    triggers=[codepipeline.CfnPipeline.PipelineTriggerDeclarationProperty(
        provider_type="providerType",

        # the properties below are optional
        git_configuration=codepipeline.CfnPipeline.GitConfigurationProperty(
            source_action_name="sourceActionName",

            # the properties below are optional
            pull_request=[codepipeline.CfnPipeline.GitPullRequestFilterProperty(
                branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                ),
                events=["events"],
                file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                )
            )],
            push=[codepipeline.CfnPipeline.GitPushFilterProperty(
                branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                ),
                file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                ),
                tags=codepipeline.CfnPipeline.GitTagFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                )
            )]
        )
    )],
    variables=[codepipeline.CfnPipeline.VariableDeclarationProperty(
        name="name",

        # the properties below are optional
        default_value="defaultValue",
        description="description"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
role_arn (str) – The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .
stages (Union[IResolvable, Sequence[Union[IResolvable, StageDeclarationProperty, Dict[str, Any]]]]) – Represents information about a stage and its definition.
artifact_store (Union[IResolvable, ArtifactStoreProperty, Dict[str, Any], None]) – The S3 bucket where artifacts for the pipeline are stored. .. epigraph:: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .
artifact_stores (Union[IResolvable, Sequence[Union[IResolvable, ArtifactStoreMapProperty, Dict[str, Any]]], None]) – A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. .. epigraph:: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .
disable_inbound_stage_transitions (Union[IResolvable, Sequence[Union[IResolvable, StageTransitionProperty, Dict[str, Any]]], None]) – Represents the input of a DisableStageTransition action.
execution_mode (Optional[str]) – The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED. Default: - “SUPERSEDED”
name (Optional[str]) – The name of the pipeline.
pipeline_type (Optional[str]) – CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications. - V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters. - V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration. .. epigraph:: Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs. For information about pricing for CodePipeline, see Pricing . For information about which type of pipeline to choose, see What type of pipeline is right for me? .
restart_execution_on_update (Union[bool, IResolvable, None]) – Indicates whether to rerun the CodePipeline pipeline after you update it.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies the tags applied to the pipeline.
triggers (Union[IResolvable, Sequence[Union[IResolvable, PipelineTriggerDeclarationProperty, Dict[str, Any]]], None]) – The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline. .. epigraph:: When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
variables (Union[IResolvable, Sequence[Union[IResolvable, VariableDeclarationProperty, Dict[str, Any]]], None]) – A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+ .

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

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.

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"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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::CodePipeline::Pipeline'

artifact_store: The S3 bucket where artifacts for the pipeline are stored.

artifact_stores: A mapping of artifactStore objects and their corresponding AWS Regions.

attr_version

The version of the pipeline.

A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.

CloudformationAttribute:: Version

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

cfn_resource_type: AWS resource type.

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.

disable_inbound_stage_transitions: Represents the input of a DisableStageTransition action.

execution_mode: The method that the pipeline will use to handle multiple executions.

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).

Returns:

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

name: The name of the pipeline.

node: The tree node.

pipeline_type: CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

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 }).

restart_execution_on_update: Indicates whether to rerun the CodePipeline pipeline after you update it.

role_arn: The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn .

stack

The stack in which this element is defined.

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

stages: Represents information about a stage and its definition.

tags: Tag Manager which manages the tags for this resource.

tags_raw: Specifies the tags applied to the pipeline.

triggers: The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

variables: A list that defines the pipeline variables for a pipeline resource.

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

ActionDeclarationProperty

class CfnPipeline.ActionDeclarationProperty(*, action_type_id, name, commands=None, configuration=None, input_artifacts=None, namespace=None, output_artifacts=None, output_variables=None, region=None, role_arn=None, run_order=None, timeout_in_minutes=None)

Bases: object

Represents information about an action declaration.

Parameters:

action_type_id (Union[IResolvable, ActionTypeIdProperty, Dict[str, Any]]) – Specifies the action type and the provider of the action.
name (str) – The action declaration’s name.
commands (Optional[Sequence[str]]) – The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild. .. epigraph:: Using compute time for this action will incur separate charges in AWS CodeBuild .
configuration (Any) – The action’s configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline . For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide . The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows: JSON: "Configuration" : { Key : Value },
input_artifacts (Union[IResolvable, Sequence[Union[IResolvable, InputArtifactProperty, Dict[str, Any]]], None]) – The name or ID of the artifact consumed by the action, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide . .. epigraph:: For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the CodeBuild action reference page in the AWS CodePipeline User Guide .
namespace (Optional[str]) – The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
output_artifacts (Union[IResolvable, Sequence[Union[IResolvable, OutputArtifactProperty, Dict[str, Any]]], None]) –
The name or ID of the result of the action declaration, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .
output_variables (Optional[Sequence[str]]) – The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
region (Optional[str]) – The action declaration’s AWS Region, such as us-east-1.
role_arn (Optional[str]) – The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
run_order (Union[int, float, None]) – The order in which actions are run.
timeout_in_minutes (Union[int, float, None]) – A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for AWS CodePipeline . This attribute is available only to the manual approval ActionType.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.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 import aws_codepipeline as codepipeline

# configuration: Any

action_declaration_property = codepipeline.CfnPipeline.ActionDeclarationProperty(
    action_type_id=codepipeline.CfnPipeline.ActionTypeIdProperty(
        category="category",
        owner="owner",
        provider="provider",
        version="version"
    ),
    name="name",

    # the properties below are optional
    commands=["commands"],
    configuration=configuration,
    input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
        name="name"
    )],
    namespace="namespace",
    output_artifacts=[codepipeline.CfnPipeline.OutputArtifactProperty(
        name="name",

        # the properties below are optional
        files=["files"]
    )],
    output_variables=["outputVariables"],
    region="region",
    role_arn="roleArn",
    run_order=123,
    timeout_in_minutes=123
)

Attributes

action_type_id

Specifies the action type and the provider of the action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-actiontypeid

commands

The shell commands to run with your compute action in CodePipeline.

All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild. .. epigraph:

Using compute time for this action will incur separate charges in AWS CodeBuild .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-commands

configuration

The action’s configuration.

These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline . For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide .

The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

JSON:

"Configuration" : { Key : Value },

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-configuration

input_artifacts

The name or ID of the artifact consumed by the action, such as a test or build artifact.

While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide . .. epigraph:

For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the `CodeBuild action reference page <https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html>`_ in the *AWS CodePipeline User Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-inputartifacts

name

The action declaration’s name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-name

namespace

The variable namespace associated with the action.

All variables produced as output by this action fall under this namespace.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-namespace

output_artifacts

The name or ID of the result of the action declaration, such as a test or build artifact.

While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-outputartifacts

output_variables

The list of variables that are to be exported from the compute action.

This is specifically CodeBuild environment variables as used for that action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-outputvariables

region

The action declaration’s AWS Region, such as us-east-1.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-region

role_arn

The ARN of the IAM service role that performs the declared action.

This is assumed through the roleArn for the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-rolearn

run_order

The order in which actions are run.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-runorder

timeout_in_minutes

//docs.aws.amazon.com/codepipeline/latest/userguide/limits.html>`_ . This attribute is available only to the manual approval ActionType.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html#cfn-codepipeline-pipeline-actiondeclaration-timeoutinminutes
Type:: A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in `Quotas for AWS CodePipeline <https

ActionTypeIdProperty

class CfnPipeline.ActionTypeIdProperty(*, category, owner, provider, version)

Bases: object

Represents information about an action type.

Parameters:

category (str) – A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. - Source - Build - Test - Deploy - Invoke - Approval
owner (str) – The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS , ThirdParty , and Custom . For more information, see Valid Action Types and Providers in CodePipeline .
provider (str) –
The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy . For more information, see Valid Action Types and Providers in CodePipeline .
version (str) – A string that describes the action version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.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 import aws_codepipeline as codepipeline

action_type_id_property = codepipeline.CfnPipeline.ActionTypeIdProperty(
    category="category",
    owner="owner",
    provider="provider",
    version="version"
)

Attributes

category

A category defines what kind of action can be taken in the stage, and constrains the provider type for the action.

Valid categories are limited to one of the values below.

Source
Build
Test
Deploy
Invoke
Approval

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html#cfn-codepipeline-pipeline-actiontypeid-category

owner

The creator of the action being called.

There are three valid values for the Owner field in the action category section within your pipeline structure: AWS , ThirdParty , and Custom . For more information, see Valid Action Types and Providers in CodePipeline .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html#cfn-codepipeline-pipeline-actiontypeid-owner

provider

The provider of the service being called by the action.

Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy . For more information, see Valid Action Types and Providers in CodePipeline .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html#cfn-codepipeline-pipeline-actiontypeid-provider

version

A string that describes the action version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html#cfn-codepipeline-pipeline-actiontypeid-version

ArtifactStoreMapProperty

class CfnPipeline.ArtifactStoreMapProperty(*, artifact_store, region)

Bases: object

A mapping of artifactStore objects and their corresponding AWS Regions.

There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. .. epigraph:

You must include either ``artifactStore`` or ``artifactStores`` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use ``artifactStores`` .

Parameters:

artifact_store (Union[IResolvable, ArtifactStoreProperty, Dict[str, Any]]) – Represents information about the S3 bucket where artifacts are stored for the pipeline. .. epigraph:: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .
region (str) – The action declaration’s AWS Region, such as us-east-1.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.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 import aws_codepipeline as codepipeline

artifact_store_map_property = codepipeline.CfnPipeline.ArtifactStoreMapProperty(
    artifact_store=codepipeline.CfnPipeline.ArtifactStoreProperty(
        location="location",
        type="type",

        # the properties below are optional
        encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty(
            id="id",
            type="type"
        )
    ),
    region="region"
)

Attributes

artifact_store

Represents information about the S3 bucket where artifacts are stored for the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-artifactstore

region

The action declaration’s AWS Region, such as us-east-1.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-region

ArtifactStoreProperty

class CfnPipeline.ArtifactStoreProperty(*, location, type, encryption_key=None)

Bases: object

The S3 bucket where artifacts for the pipeline are stored.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

Parameters:

location (str) – The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
type (str) – The type of the artifact store, such as S3.
encryption_key (Union[IResolvable, EncryptionKeyProperty, Dict[str, Any], None]) – The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key. If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: AWS::CodePipeline::Pipeline .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.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 import aws_codepipeline as codepipeline

artifact_store_property = codepipeline.CfnPipeline.ArtifactStoreProperty(
    location="location",
    type="type",

    # the properties below are optional
    encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty(
        id="id",
        type="type"
    )
)

Attributes

encryption_key

The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.

If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: AWS::CodePipeline::Pipeline .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey

location

The S3 bucket used for storing the artifacts for a pipeline.

You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location

type

The type of the artifact store, such as S3.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-type

BeforeEntryConditionsProperty

class CfnPipeline.BeforeEntryConditionsProperty(*, conditions=None)

Bases: object

The conditions for making checks for entry to a stage.

Parameters:: conditions (Union[IResolvable, Sequence[Union[IResolvable, ConditionProperty, Dict[str, Any]]], None]) – The conditions that are configured as entry conditions.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-beforeentryconditions.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 import aws_codepipeline as codepipeline

# configuration: Any

before_entry_conditions_property = codepipeline.CfnPipeline.BeforeEntryConditionsProperty(
    conditions=[codepipeline.CfnPipeline.ConditionProperty(
        result="result",
        rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
            configuration=configuration,
            input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                name="name"
            )],
            name="name",
            region="region",
            role_arn="roleArn",
            rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                category="category",
                owner="owner",
                provider="provider",
                version="version"
            )
        )]
    )]
)

Attributes

conditions

The conditions that are configured as entry conditions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-beforeentryconditions.html#cfn-codepipeline-pipeline-beforeentryconditions-conditions

BlockerDeclarationProperty

class CfnPipeline.BlockerDeclarationProperty(*, name, type)

Bases: object

Reserved for future use.

Parameters:

name (str) – Reserved for future use.
type (str) – Reserved for future use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-blockerdeclaration.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 import aws_codepipeline as codepipeline

blocker_declaration_property = codepipeline.CfnPipeline.BlockerDeclarationProperty(
    name="name",
    type="type"
)

Attributes

name

Reserved for future use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-blockerdeclaration.html#cfn-codepipeline-pipeline-blockerdeclaration-name

type

Reserved for future use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-blockerdeclaration.html#cfn-codepipeline-pipeline-blockerdeclaration-type

ConditionProperty

class CfnPipeline.ConditionProperty(*, result=None, rules=None)

Bases: object

The condition for the stage.

A condition is made up of the rules and the result for the condition.

Parameters:

result (Optional[str]) – The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
rules (Union[IResolvable, Sequence[Union[IResolvable, RuleDeclarationProperty, Dict[str, Any]]], None]) – The rules that make up the condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-condition.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 import aws_codepipeline as codepipeline

# configuration: Any

condition_property = codepipeline.CfnPipeline.ConditionProperty(
    result="result",
    rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
        configuration=configuration,
        input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
            name="name"
        )],
        name="name",
        region="region",
        role_arn="roleArn",
        rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
            category="category",
            owner="owner",
            provider="provider",
            version="version"
        )
    )]
)

Attributes

result

The action to be done when the condition is met.

For example, rolling back an execution for a failure condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-condition.html#cfn-codepipeline-pipeline-condition-result

rules

The rules that make up the condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-condition.html#cfn-codepipeline-pipeline-condition-rules

EncryptionKeyProperty

class CfnPipeline.EncryptionKeyProperty(*, id, type)

Bases: object

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.

EncryptionKey is a property of the ArtifactStore property type.

Parameters:

id (str) – The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN. .. epigraph:: Aliases are recognized only in the account that created the AWS KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).
type (str) – The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to ‘KMS’.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-encryptionkey.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 import aws_codepipeline as codepipeline

encryption_key_property = codepipeline.CfnPipeline.EncryptionKeyProperty(
    id="id",
    type="type"
)

Attributes

id

The ID used to identify the key.

For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN. .. epigraph:

Aliases are recognized only in the account that created the AWS KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-encryptionkey.html#cfn-codepipeline-pipeline-encryptionkey-id

type

The type of encryption key, such as an AWS KMS key.

When creating or updating a pipeline, the value must be set to ‘KMS’.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-encryptionkey.html#cfn-codepipeline-pipeline-encryptionkey-type

FailureConditionsProperty

class CfnPipeline.FailureConditionsProperty(*, conditions=None, result=None, retry_configuration=None)

Bases: object

The configuration that specifies the result, such as rollback, to occur upon stage failure.

Parameters:

conditions (Union[IResolvable, Sequence[Union[IResolvable, ConditionProperty, Dict[str, Any]]], None]) – The conditions that are configured as failure conditions.
result (Optional[str]) – The specified result for when the failure conditions are met, such as rolling back the stage.
retry_configuration (Union[IResolvable, RetryConfigurationProperty, Dict[str, Any], None]) – The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-failureconditions.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 import aws_codepipeline as codepipeline

# configuration: Any

failure_conditions_property = codepipeline.CfnPipeline.FailureConditionsProperty(
    conditions=[codepipeline.CfnPipeline.ConditionProperty(
        result="result",
        rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
            configuration=configuration,
            input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                name="name"
            )],
            name="name",
            region="region",
            role_arn="roleArn",
            rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                category="category",
                owner="owner",
                provider="provider",
                version="version"
            )
        )]
    )],
    result="result",
    retry_configuration=codepipeline.CfnPipeline.RetryConfigurationProperty(
        retry_mode="retryMode"
    )
)

Attributes

conditions

The conditions that are configured as failure conditions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-failureconditions.html#cfn-codepipeline-pipeline-failureconditions-conditions

result

The specified result for when the failure conditions are met, such as rolling back the stage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-failureconditions.html#cfn-codepipeline-pipeline-failureconditions-result

retry_configuration

The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-failureconditions.html#cfn-codepipeline-pipeline-failureconditions-retryconfiguration

GitBranchFilterCriteriaProperty

class CfnPipeline.GitBranchFilterCriteriaProperty(*, excludes=None, includes=None)

Bases: object

The Git repository branches specified as filter criteria to start the pipeline.

Parameters:

excludes (Optional[Sequence[str]]) – The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
includes (Optional[Sequence[str]]) – The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.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 import aws_codepipeline as codepipeline

git_branch_filter_criteria_property = codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
    excludes=["excludes"],
    includes=["includes"]
)

Attributes

excludes

The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html#cfn-codepipeline-pipeline-gitbranchfiltercriteria-excludes

includes

The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html#cfn-codepipeline-pipeline-gitbranchfiltercriteria-includes

GitConfigurationProperty

class CfnPipeline.GitConfigurationProperty(*, source_action_name, pull_request=None, push=None)

Bases: object

A type of trigger configuration for Git-based source actions.

You can specify the Git configuration trigger type for all third-party Git-based source actions that are supported by the CodeStarSourceConnection action type.

Parameters:

source_action_name (str) – The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only. .. epigraph:: You can only specify one trigger configuration per source action.
pull_request (Union[IResolvable, Sequence[Union[IResolvable, GitPullRequestFilterProperty, Dict[str, Any]]], None]) – The field where the repository event that will start the pipeline is specified as pull requests.
push (Union[IResolvable, Sequence[Union[IResolvable, GitPushFilterProperty, Dict[str, Any]]], None]) – The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.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 import aws_codepipeline as codepipeline

git_configuration_property = codepipeline.CfnPipeline.GitConfigurationProperty(
    source_action_name="sourceActionName",

    # the properties below are optional
    pull_request=[codepipeline.CfnPipeline.GitPullRequestFilterProperty(
        branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
            excludes=["excludes"],
            includes=["includes"]
        ),
        events=["events"],
        file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
            excludes=["excludes"],
            includes=["includes"]
        )
    )],
    push=[codepipeline.CfnPipeline.GitPushFilterProperty(
        branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
            excludes=["excludes"],
            includes=["includes"]
        ),
        file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
            excludes=["excludes"],
            includes=["includes"]
        ),
        tags=codepipeline.CfnPipeline.GitTagFilterCriteriaProperty(
            excludes=["excludes"],
            includes=["includes"]
        )
    )]
)

Attributes

pull_request

The field where the repository event that will start the pipeline is specified as pull requests.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-pullrequest

push

The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-push

source_action_name

The name of the pipeline source action where the trigger configuration, such as Git tags, is specified.

The trigger configuration will start the pipeline upon the specified change only. .. epigraph:

You can only specify one trigger configuration per source action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitconfiguration.html#cfn-codepipeline-pipeline-gitconfiguration-sourceactionname

GitFilePathFilterCriteriaProperty

class CfnPipeline.GitFilePathFilterCriteriaProperty(*, excludes=None, includes=None)

Bases: object

The Git repository file paths specified as filter criteria to start the pipeline.

Parameters:

excludes (Optional[Sequence[str]]) – The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
includes (Optional[Sequence[str]]) – The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.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 import aws_codepipeline as codepipeline

git_file_path_filter_criteria_property = codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
    excludes=["excludes"],
    includes=["includes"]
)

Attributes

excludes

The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html#cfn-codepipeline-pipeline-gitfilepathfiltercriteria-excludes

includes

The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html#cfn-codepipeline-pipeline-gitfilepathfiltercriteria-includes

GitPullRequestFilterProperty

class CfnPipeline.GitPullRequestFilterProperty(*, branches=None, events=None, file_paths=None)

Bases: object

The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.

Parameters:

branches (Union[IResolvable, GitBranchFilterCriteriaProperty, Dict[str, Any], None]) – The field that specifies to filter on branches for the pull request trigger configuration.
events (Optional[Sequence[str]]) – The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
file_paths (Union[IResolvable, GitFilePathFilterCriteriaProperty, Dict[str, Any], None]) – The field that specifies to filter on file paths for the pull request trigger configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpullrequestfilter.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 import aws_codepipeline as codepipeline

git_pull_request_filter_property = codepipeline.CfnPipeline.GitPullRequestFilterProperty(
    branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
        excludes=["excludes"],
        includes=["includes"]
    ),
    events=["events"],
    file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
        excludes=["excludes"],
        includes=["includes"]
    )
)

Attributes

branches

The field that specifies to filter on branches for the pull request trigger configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpullrequestfilter.html#cfn-codepipeline-pipeline-gitpullrequestfilter-branches

events

The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpullrequestfilter.html#cfn-codepipeline-pipeline-gitpullrequestfilter-events

file_paths

The field that specifies to filter on file paths for the pull request trigger configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpullrequestfilter.html#cfn-codepipeline-pipeline-gitpullrequestfilter-filepaths

GitPushFilterProperty

class CfnPipeline.GitPushFilterProperty(*, branches=None, file_paths=None, tags=None)

Bases: object

The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.

Parameters:

branches (Union[IResolvable, GitBranchFilterCriteriaProperty, Dict[str, Any], None]) – The field that specifies to filter on branches for the push trigger configuration.
file_paths (Union[IResolvable, GitFilePathFilterCriteriaProperty, Dict[str, Any], None]) – The field that specifies to filter on file paths for the push trigger configuration.
tags (Union[GitTagFilterCriteriaProperty, Dict[str, Any], None]) – The field that contains the details for the Git tags trigger configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.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 import aws_codepipeline as codepipeline

git_push_filter_property = codepipeline.CfnPipeline.GitPushFilterProperty(
    branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
        excludes=["excludes"],
        includes=["includes"]
    ),
    file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
        excludes=["excludes"],
        includes=["includes"]
    ),
    tags=codepipeline.CfnPipeline.GitTagFilterCriteriaProperty(
        excludes=["excludes"],
        includes=["includes"]
    )
)

Attributes

branches

The field that specifies to filter on branches for the push trigger configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html#cfn-codepipeline-pipeline-gitpushfilter-branches

file_paths

The field that specifies to filter on file paths for the push trigger configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html#cfn-codepipeline-pipeline-gitpushfilter-filepaths

tags

The field that contains the details for the Git tags trigger configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html#cfn-codepipeline-pipeline-gitpushfilter-tags

GitTagFilterCriteriaProperty

class CfnPipeline.GitTagFilterCriteriaProperty(*, excludes=None, includes=None)

Bases: object

The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.

Parameters:

excludes (Optional[Sequence[str]]) – The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.
includes (Optional[Sequence[str]]) – The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gittagfiltercriteria.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 import aws_codepipeline as codepipeline

git_tag_filter_criteria_property = codepipeline.CfnPipeline.GitTagFilterCriteriaProperty(
    excludes=["excludes"],
    includes=["includes"]
)

Attributes

excludes

The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gittagfiltercriteria.html#cfn-codepipeline-pipeline-gittagfiltercriteria-excludes

includes

The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gittagfiltercriteria.html#cfn-codepipeline-pipeline-gittagfiltercriteria-includes

InputArtifactProperty

class CfnPipeline.InputArtifactProperty(*, name)

Bases: object

Represents information about an artifact to be worked on, such as a test or build artifact.

Parameters:: name (str) – The name of the artifact to be worked on (for example, “My App”). Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-inputartifact.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 import aws_codepipeline as codepipeline

input_artifact_property = codepipeline.CfnPipeline.InputArtifactProperty(
    name="name"
)

Attributes

name

The name of the artifact to be worked on (for example, “My App”).

Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip

The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-inputartifact.html#cfn-codepipeline-pipeline-inputartifact-name

OutputArtifactProperty

class CfnPipeline.OutputArtifactProperty(*, name, files=None)

Bases: object

Represents information about the output of an action.

Parameters:

name (str) – The name of the output of an artifact, such as “My App”. The output artifact name must exactly match the input artifact declared for a downstream action. However, the downstream action’s input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Output artifact names must be unique within a pipeline.
files (Optional[Sequence[str]]) – The files that you want to associate with the output artifact that will be exported from the compute action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-outputartifact.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 import aws_codepipeline as codepipeline

output_artifact_property = codepipeline.CfnPipeline.OutputArtifactProperty(
    name="name",

    # the properties below are optional
    files=["files"]
)

Attributes

files

The files that you want to associate with the output artifact that will be exported from the compute action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-outputartifact.html#cfn-codepipeline-pipeline-outputartifact-files

name

The name of the output of an artifact, such as “My App”.

The output artifact name must exactly match the input artifact declared for a downstream action. However, the downstream action’s input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

Output artifact names must be unique within a pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-outputartifact.html#cfn-codepipeline-pipeline-outputartifact-name

PipelineTriggerDeclarationProperty

class CfnPipeline.PipelineTriggerDeclarationProperty(*, provider_type, git_configuration=None)

Bases: object

Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.

This is only supported for the CodeStarSourceConnection action type. > When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

Parameters:

provider_type (str) – The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.
git_configuration (Union[IResolvable, GitConfigurationProperty, Dict[str, Any], None]) – Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-pipelinetriggerdeclaration.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 import aws_codepipeline as codepipeline

pipeline_trigger_declaration_property = codepipeline.CfnPipeline.PipelineTriggerDeclarationProperty(
    provider_type="providerType",

    # the properties below are optional
    git_configuration=codepipeline.CfnPipeline.GitConfigurationProperty(
        source_action_name="sourceActionName",

        # the properties below are optional
        pull_request=[codepipeline.CfnPipeline.GitPullRequestFilterProperty(
            branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
                excludes=["excludes"],
                includes=["includes"]
            ),
            events=["events"],
            file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
                excludes=["excludes"],
                includes=["includes"]
            )
        )],
        push=[codepipeline.CfnPipeline.GitPushFilterProperty(
            branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
                excludes=["excludes"],
                includes=["includes"]
            ),
            file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
                excludes=["excludes"],
                includes=["includes"]
            ),
            tags=codepipeline.CfnPipeline.GitTagFilterCriteriaProperty(
                excludes=["excludes"],
                includes=["includes"]
            )
        )]
    )
)

Attributes

git_configuration

Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-pipelinetriggerdeclaration.html#cfn-codepipeline-pipeline-pipelinetriggerdeclaration-gitconfiguration

provider_type

The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-pipelinetriggerdeclaration.html#cfn-codepipeline-pipeline-pipelinetriggerdeclaration-providertype

RetryConfigurationProperty

class CfnPipeline.RetryConfigurationProperty(*, retry_mode=None)

Bases: object

The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

Parameters:: retry_mode (Optional[str]) – The method that you want to configure for automatic stage retry on stage failure. You can specify to retry only failed action in the stage or all actions in the stage.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-retryconfiguration.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 import aws_codepipeline as codepipeline

retry_configuration_property = codepipeline.CfnPipeline.RetryConfigurationProperty(
    retry_mode="retryMode"
)

Attributes

retry_mode

The method that you want to configure for automatic stage retry on stage failure.

You can specify to retry only failed action in the stage or all actions in the stage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-retryconfiguration.html#cfn-codepipeline-pipeline-retryconfiguration-retrymode

RuleDeclarationProperty

class CfnPipeline.RuleDeclarationProperty(*, configuration=None, input_artifacts=None, name=None, region=None, role_arn=None, rule_type_id=None)

Bases: object

Represents information about the rule to be created for an associated condition.

An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.

Parameters:

configuration (Any) – The action configuration fields for the rule.
input_artifacts (Union[IResolvable, Sequence[Union[IResolvable, InputArtifactProperty, Dict[str, Any]]], None]) – The input artifacts fields for the rule, such as specifying an input file for the rule.
name (Optional[str]) – The name of the rule that is created for the condition, such as CheckAllResults.
region (Optional[str]) – The Region for the condition associated with the rule.
role_arn (Optional[str]) – The pipeline role ARN associated with the rule.
rule_type_id (Union[IResolvable, RuleTypeIdProperty, Dict[str, Any], None]) – The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.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 import aws_codepipeline as codepipeline

# configuration: Any

rule_declaration_property = codepipeline.CfnPipeline.RuleDeclarationProperty(
    configuration=configuration,
    input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
        name="name"
    )],
    name="name",
    region="region",
    role_arn="roleArn",
    rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
        category="category",
        owner="owner",
        provider="provider",
        version="version"
    )
)

Attributes

configuration

The action configuration fields for the rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-configuration

input_artifacts

The input artifacts fields for the rule, such as specifying an input file for the rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-inputartifacts

name

The name of the rule that is created for the condition, such as CheckAllResults.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-name

region

The Region for the condition associated with the rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-region

role_arn

The pipeline role ARN associated with the rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-rolearn

rule_type_id

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruledeclaration.html#cfn-codepipeline-pipeline-ruledeclaration-ruletypeid

RuleTypeIdProperty

class CfnPipeline.RuleTypeIdProperty(*, category=None, owner=None, provider=None, version=None)

Bases: object

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Parameters:

category (Optional[str]) – A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is Rule .
owner (Optional[str]) – The creator of the rule being called. The valid value for the Owner field in the rule category is AWS .
provider (Optional[str]) – The rule provider, such as the DeploymentWindow rule.
version (Optional[str]) – A string that describes the rule version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.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 import aws_codepipeline as codepipeline

rule_type_id_property = codepipeline.CfnPipeline.RuleTypeIdProperty(
    category="category",
    owner="owner",
    provider="provider",
    version="version"
)

Attributes

category

A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule.

The valid category is Rule .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-category

owner

The creator of the rule being called.

The valid value for the Owner field in the rule category is AWS .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-owner

provider

The rule provider, such as the DeploymentWindow rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-provider

version

A string that describes the rule version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-version

StageDeclarationProperty

class CfnPipeline.StageDeclarationProperty(*, actions, name, before_entry=None, blockers=None, on_failure=None, on_success=None)

Bases: object

Represents information about a stage and its definition.

Parameters:

actions (Union[IResolvable, Sequence[Union[IResolvable, ActionDeclarationProperty, Dict[str, Any]]]]) – The actions included in a stage.
name (str) – The name of the stage.
before_entry (Union[IResolvable, BeforeEntryConditionsProperty, Dict[str, Any], None]) – The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.
blockers (Union[IResolvable, Sequence[Union[IResolvable, BlockerDeclarationProperty, Dict[str, Any]]], None]) – Reserved for future use.
on_failure (Union[IResolvable, FailureConditionsProperty, Dict[str, Any], None]) – The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.
on_success (Union[IResolvable, SuccessConditionsProperty, Dict[str, Any], None]) – The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.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 import aws_codepipeline as codepipeline

# configuration: Any

stage_declaration_property = codepipeline.CfnPipeline.StageDeclarationProperty(
    actions=[codepipeline.CfnPipeline.ActionDeclarationProperty(
        action_type_id=codepipeline.CfnPipeline.ActionTypeIdProperty(
            category="category",
            owner="owner",
            provider="provider",
            version="version"
        ),
        name="name",

        # the properties below are optional
        commands=["commands"],
        configuration=configuration,
        input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
            name="name"
        )],
        namespace="namespace",
        output_artifacts=[codepipeline.CfnPipeline.OutputArtifactProperty(
            name="name",

            # the properties below are optional
            files=["files"]
        )],
        output_variables=["outputVariables"],
        region="region",
        role_arn="roleArn",
        run_order=123,
        timeout_in_minutes=123
    )],
    name="name",

    # the properties below are optional
    before_entry=codepipeline.CfnPipeline.BeforeEntryConditionsProperty(
        conditions=[codepipeline.CfnPipeline.ConditionProperty(
            result="result",
            rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                configuration=configuration,
                input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                    name="name"
                )],
                name="name",
                region="region",
                role_arn="roleArn",
                rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                    category="category",
                    owner="owner",
                    provider="provider",
                    version="version"
                )
            )]
        )]
    ),
    blockers=[codepipeline.CfnPipeline.BlockerDeclarationProperty(
        name="name",
        type="type"
    )],
    on_failure=codepipeline.CfnPipeline.FailureConditionsProperty(
        conditions=[codepipeline.CfnPipeline.ConditionProperty(
            result="result",
            rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                configuration=configuration,
                input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                    name="name"
                )],
                name="name",
                region="region",
                role_arn="roleArn",
                rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                    category="category",
                    owner="owner",
                    provider="provider",
                    version="version"
                )
            )]
        )],
        result="result",
        retry_configuration=codepipeline.CfnPipeline.RetryConfigurationProperty(
            retry_mode="retryMode"
        )
    ),
    on_success=codepipeline.CfnPipeline.SuccessConditionsProperty(
        conditions=[codepipeline.CfnPipeline.ConditionProperty(
            result="result",
            rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                configuration=configuration,
                input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                    name="name"
                )],
                name="name",
                region="region",
                role_arn="roleArn",
                rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                    category="category",
                    owner="owner",
                    provider="provider",
                    version="version"
                )
            )]
        )]
    )
)

Attributes

actions

The actions included in a stage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-actions

before_entry

The method to use when a stage allows entry.

For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-beforeentry

blockers

Reserved for future use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-blockers

name

The name of the stage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-name

on_failure

The method to use when a stage has not completed successfully.

For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-onfailure

on_success

The method to use when a stage has succeeded.

For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-onsuccess

StageTransitionProperty

class CfnPipeline.StageTransitionProperty(*, reason, stage_name)

Bases: object

The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

Parameters:

reason (str) – The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
stage_name (str) – The name of the stage where you want to disable the inbound or outbound transition of artifacts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.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 import aws_codepipeline as codepipeline

stage_transition_property = codepipeline.CfnPipeline.StageTransitionProperty(
    reason="reason",
    stage_name="stageName"
)

Attributes

reason

The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests.

This message is displayed in the pipeline console UI.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.html#cfn-codepipeline-pipeline-stagetransition-reason

stage_name

The name of the stage where you want to disable the inbound or outbound transition of artifacts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.html#cfn-codepipeline-pipeline-stagetransition-stagename

SuccessConditionsProperty

class CfnPipeline.SuccessConditionsProperty(*, conditions=None)

Bases: object

The conditions for making checks that, if met, succeed a stage.

Parameters:: conditions (Union[IResolvable, Sequence[Union[IResolvable, ConditionProperty, Dict[str, Any]]], None]) – The conditions that are success conditions.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-successconditions.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 import aws_codepipeline as codepipeline

# configuration: Any

success_conditions_property = codepipeline.CfnPipeline.SuccessConditionsProperty(
    conditions=[codepipeline.CfnPipeline.ConditionProperty(
        result="result",
        rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
            configuration=configuration,
            input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                name="name"
            )],
            name="name",
            region="region",
            role_arn="roleArn",
            rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                category="category",
                owner="owner",
                provider="provider",
                version="version"
            )
        )]
    )]
)

Attributes

conditions

The conditions that are success conditions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-successconditions.html#cfn-codepipeline-pipeline-successconditions-conditions

VariableDeclarationProperty

class CfnPipeline.VariableDeclarationProperty(*, name, default_value=None, description=None)

Bases: object

A variable declared at the pipeline level.

Parameters:

name (str) – The name of a pipeline-level variable.
default_value (Optional[str]) – The value of a pipeline-level variable.
description (Optional[str]) – The description of a pipeline-level variable. It’s used to add additional context about the variable, and not being used at time when pipeline executes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.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 import aws_codepipeline as codepipeline

variable_declaration_property = codepipeline.CfnPipeline.VariableDeclarationProperty(
    name="name",

    # the properties below are optional
    default_value="defaultValue",
    description="description"
)

Attributes

default_value

The value of a pipeline-level variable.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-defaultvalue

description

The description of a pipeline-level variable.

It’s used to add additional context about the variable, and not being used at time when pipeline executes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-description

name

The name of a pipeline-level variable.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-name