Class CfnPipelineProps
Properties for defining a CfnPipeline
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.AWS.CodePipeline.dll
Syntax (csharp)
public class CfnPipelineProps : Object, ICfnPipelineProps
Syntax (vb)
Public Class CfnPipelineProps
Inherits Object
Implements 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
} },
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
Constructors
CfnPipelineProps() |
Properties
ArtifactStore | The S3 bucket where artifacts for the pipeline are stored. |
ArtifactStores | A mapping of |
DisableInboundStageTransitions | Represents the input of a |
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 |
Stages | Represents information about a stage and its definition. |
Tags | Specifies the tags applied to the pipeline. |
Constructors
CfnPipelineProps()
public CfnPipelineProps()
Properties
ArtifactStore
The S3 bucket where artifacts for the pipeline are stored.
public object ArtifactStore { get; set; }
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.
public object ArtifactStores { get; set; }
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.
public object DisableInboundStageTransitions { get; set; }
Property Value
System.Object
Remarks
Name
The name of the pipeline.
public string Name { get; set; }
Property Value
System.String
Remarks
RestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it.
public object RestartExecutionOnUpdate { get; set; }
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
.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
Stages
Represents information about a stage and its definition.
public object Stages { get; set; }
Property Value
System.Object
Remarks
Tags
Specifies the tags applied to the pipeline.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]