Interface ICfnPipelineProps

Properties for defining a CfnPipeline.

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.AWS.CodePipeline.dll

Syntax (csharp)

public interface ICfnPipelineProps

Syntax (vb)

Public Interface ICfnPipelineProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;

var configuration;

CfnPipelineProps cfnPipelineProps = new CfnPipelineProps {
    RoleArn = "roleArn",
    Stages = new [] { new StageDeclarationProperty {
        Actions = new [] { new ActionDeclarationProperty {
            ActionTypeId = new ActionTypeIdProperty {
                Category = "category",
                Owner = "owner",
                Provider = "provider",
                Version = "version"
            },
            Name = "name",

            // the properties below are optional
            Configuration = configuration,
            InputArtifacts = new [] { new InputArtifactProperty {
                Name = "name"
            } },
            Namespace = "namespace",
            OutputArtifacts = new [] { new OutputArtifactProperty {
                Name = "name"
            } },
            Region = "region",
            RoleArn = "roleArn",
            RunOrder = 123
        } },
        Name = "name",

        // the properties below are optional
        Blockers = new [] { new BlockerDeclarationProperty {
            Name = "name",
            Type = "type"
        } }
    } },

    // the properties below are optional
    ArtifactStore = new ArtifactStoreProperty {
        Location = "location",
        Type = "type",

        // the properties below are optional
        EncryptionKey = new EncryptionKeyProperty {
            Id = "id",
            Type = "type"
        }
    },
    ArtifactStores = new [] { new ArtifactStoreMapProperty {
        ArtifactStore = new ArtifactStoreProperty {
            Location = "location",
            Type = "type",

            // the properties below are optional
            EncryptionKey = new EncryptionKeyProperty {
                Id = "id",
                Type = "type"
            }
        },
        Region = "region"
    } },
    DisableInboundStageTransitions = new [] { new StageTransitionProperty {
        Reason = "reason",
        StageName = "stageName"
    } },
    Name = "name",
    RestartExecutionOnUpdate = false,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

ArtifactStore	The S3 bucket where artifacts for the pipeline are stored.
ArtifactStores	A mapping of `artifactStore` objects and their corresponding AWS Regions.
DisableInboundStageTransitions	Represents the input of a `DisableStageTransition` action.
Name	The name of the pipeline.
RestartExecutionOnUpdate	Indicates whether to rerun the CodePipeline pipeline after you update it.
RoleArn	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	Represents information about a stage and its definition.
Tags	Specifies the tags applied to the pipeline.

Properties

ArtifactStore

The S3 bucket where artifacts for the pipeline are stored.

virtual object ArtifactStore { get; }

Property Value

System.Object

Remarks

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

ArtifactStores

A mapping of artifactStore objects and their corresponding AWS Regions.

virtual object ArtifactStores { get; }

Property Value

System.Object

Remarks

There must be an artifact store for the pipeline Region and for each cross-region action in 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 .

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

DisableInboundStageTransitions

Represents the input of a DisableStageTransition action.

virtual object DisableInboundStageTransitions { get; }

Property Value

System.Object

Remarks

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

Name

The name of the pipeline.

virtual string Name { get; }

Property Value

System.String

Remarks

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

RestartExecutionOnUpdate

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

virtual object RestartExecutionOnUpdate { get; }

Property Value

System.Object

Remarks

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

RoleArn

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 .

string RoleArn { get; }

Property Value

System.String

Remarks

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

Stages

Represents information about a stage and its definition.

object Stages { get; }

Property Value

System.Object

Remarks

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