CfnPipelineProps

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

Bases: object

Properties for defining a CfnPipeline.

Parameters
  • 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]]]) – Represents information about a stage and its definition.

  • artifact_store (Union[IResolvable, ArtifactStoreProperty, 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]], 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]], None]) – Represents the input of a DisableStageTransition action.

  • name (Optional[str]) – The name of the pipeline.

  • restart_execution_on_update (Union[bool, IResolvable, None]) – Indicates whether to rerun the CodePipeline pipeline after you update it.

  • tags (Optional[Sequence[CfnTag]]) – Specifies the tags applied to the pipeline.

Link

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

ExampleMetadata

fixture=_generated

Example:

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

# configuration: Any

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"
    )]
)

Attributes

artifact_store

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 .

Link

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

Return type

Union[IResolvable, ArtifactStoreProperty, None]

artifact_stores

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`` .
Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ArtifactStoreMapProperty]], None]

disable_inbound_stage_transitions

Represents the input of a DisableStageTransition action.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, StageTransitionProperty]], None]

name

The name of the pipeline.

Link

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

Return type

Optional[str]

restart_execution_on_update

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

Link

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

Return type

Union[bool, IResolvable, None]

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 .

Link

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

Return type

str

stages

Represents information about a stage and its definition.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, StageDeclarationProperty]]]

tags

Specifies the tags applied to the pipeline.

Link

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

Return type

Optional[List[CfnTag]]