Interface ICfnPipelineProps
Properties for defining a CfnPipeline
.
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnPipelineProps
Syntax (vb)
Public Interface ICfnPipelineProps
Remarks
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;
var 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,
TimeoutInMinutes = 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"
} },
ExecutionMode = "executionMode",
Name = "name",
PipelineType = "pipelineType",
RestartExecutionOnUpdate = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Triggers = new [] { new PipelineTriggerDeclarationProperty {
ProviderType = "providerType",
// the properties below are optional
GitConfiguration = new GitConfigurationProperty {
SourceActionName = "sourceActionName",
// the properties below are optional
PullRequest = new [] { new GitPullRequestFilterProperty {
Branches = new GitBranchFilterCriteriaProperty {
Excludes = new [] { "excludes" },
Includes = new [] { "includes" }
},
Events = new [] { "events" },
FilePaths = new GitFilePathFilterCriteriaProperty {
Excludes = new [] { "excludes" },
Includes = new [] { "includes" }
}
} },
Push = new [] { new GitPushFilterProperty {
Branches = new GitBranchFilterCriteriaProperty {
Excludes = new [] { "excludes" },
Includes = new [] { "includes" }
},
FilePaths = new GitFilePathFilterCriteriaProperty {
Excludes = new [] { "excludes" },
Includes = new [] { "includes" }
},
Tags = new GitTagFilterCriteriaProperty {
Excludes = new [] { "excludes" },
Includes = new [] { "includes" }
}
} }
}
} },
Variables = new [] { new VariableDeclarationProperty {
Name = "name",
// the properties below are optional
DefaultValue = "defaultValue",
Description = "description"
} }
};
Synopsis
Properties
ArtifactStore | The S3 bucket where artifacts for the pipeline are stored. |
ArtifactStores | A mapping of |
DisableInboundStageTransitions | Represents the input of a |
ExecutionMode | The method that the pipeline will use to handle multiple executions. |
Name | The name of the pipeline. |
PipelineType | 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. |
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 |
Stages | Represents information about a stage and its definition. |
Tags | 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. |
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
.
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
.
DisableInboundStageTransitions
Represents the input of a DisableStageTransition
action.
virtual object DisableInboundStageTransitions { get; }
Property Value
System.Object
Remarks
ExecutionMode
The method that the pipeline will use to handle multiple executions.
virtual string ExecutionMode { get; }
Property Value
System.String
Remarks
The default mode is SUPERSEDED.
Name
The name of the pipeline.
virtual string Name { get; }
Property Value
System.String
Remarks
PipelineType
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.
virtual string PipelineType { get; }
Property Value
System.String
Remarks
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? .
RestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it.
virtual object RestartExecutionOnUpdate { get; }
Property Value
System.Object
Remarks
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
Stages
Represents information about a stage and its definition.
object Stages { get; }
Property Value
System.Object
Remarks
Tags
Specifies the tags applied to the pipeline.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Triggers
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
virtual object Triggers { get; }
Property Value
System.Object
Remarks
When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
Variables
A list that defines the pipeline variables for a pipeline resource.
virtual object Variables { get; }
Property Value
System.Object
Remarks
Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@-_]+
.