CfnPipelineProps¶

class aws_cdk.aws_codepipeline.CfnPipelineProps(*, artifact_store=None, artifact_stores=None, disable_inbound_stage_transitions=None, name=None, restart_execution_on_update=None, role_arn, stages, tags=None)¶

Bases: object

Properties for defining a AWS::CodePipeline::Pipeline.

Parameters

artifact_store (Union[IResolvable, ArtifactStoreProperty, None]) – AWS::CodePipeline::Pipeline.ArtifactStore.
artifact_stores (Union[IResolvable, Sequence[Union[IResolvable, ArtifactStoreMapProperty]], None]) – AWS::CodePipeline::Pipeline.ArtifactStores.
disable_inbound_stage_transitions (Union[IResolvable, Sequence[Union[IResolvable, StageTransitionProperty]], None]) – AWS::CodePipeline::Pipeline.DisableInboundStageTransitions.
name (Optional[str]) – AWS::CodePipeline::Pipeline.Name.
restart_execution_on_update (Union[bool, IResolvable, None]) – AWS::CodePipeline::Pipeline.RestartExecutionOnUpdate.
role_arn (str) – AWS::CodePipeline::Pipeline.RoleArn.
stages (Union[IResolvable, Sequence[Union[IResolvable, StageDeclarationProperty]]]) – AWS::CodePipeline::Pipeline.Stages.
tags (Optional[Sequence[CfnTag]]) – AWS::CodePipeline::Pipeline.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html

Example:

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

# configuration is of type object

cfn_pipeline_props = codepipeline.CfnPipelineProps(
    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
            configuration=configuration,
            input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                name="name"
            )],
            namespace="namespace",
            output_artifacts=[codepipeline.CfnPipeline.OutputArtifactProperty(
                name="name"
            )],
            region="region",
            role_arn="roleArn",
            run_order=123
        )],
        name="name",

        # the properties below are optional
        blockers=[codepipeline.CfnPipeline.BlockerDeclarationProperty(
            name="name",
            type="type"
        )]
    )],

    # 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"
    )],
    name="name",
    restart_execution_on_update=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)