Class CfnPipeline
The AWS::CodePipeline::Pipeline
resource creates a CodePipeline pipeline that describes how software changes go through a release process.
Inherited Members
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPipeline : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnPipeline
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see What Is CodePipeline? in the CodePipeline User Guide .
For an example in YAML and JSON that contains the parameters in this reference, see Examples .
CloudformationResource: AWS::CodePipeline::Pipeline
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 cfnPipeline = new CfnPipeline(this, "MyCfnPipeline", 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
Constructors
CfnPipeline(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPipeline(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnPipeline(Construct, String, ICfnPipelineProps) |
Properties
ArtifactStore | The S3 bucket where artifacts for the pipeline are stored. |
ArtifactStores | A mapping of |
AttrId | |
AttrVersion | The version of the pipeline. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPipeline(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPipeline(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPipeline(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPipeline(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnPipeline(Construct, String, ICfnPipelineProps)
public CfnPipeline(Construct scope, string id, ICfnPipelineProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnPipelineProps
Resource properties.
Properties
ArtifactStore
The S3 bucket where artifacts for the pipeline are stored.
public virtual object ArtifactStore { get; set; }
Property Value
System.Object
ArtifactStores
A mapping of artifactStore
objects and their corresponding AWS Regions.
public virtual object ArtifactStores { get; set; }
Property Value
System.Object
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrVersion
The version of the pipeline.
public virtual string AttrVersion { get; }
Property Value
System.String
Remarks
A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.
CloudformationAttribute: Version
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DisableInboundStageTransitions
Represents the input of a DisableStageTransition
action.
public virtual object DisableInboundStageTransitions { get; set; }
Property Value
System.Object
ExecutionMode
The method that the pipeline will use to handle multiple executions.
public virtual string ExecutionMode { get; set; }
Property Value
System.String
Name
The name of the pipeline.
public virtual string Name { get; set; }
Property Value
System.String
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.
public virtual string PipelineType { get; set; }
Property Value
System.String
RestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it.
public virtual object RestartExecutionOnUpdate { get; set; }
Property Value
System.Object
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 virtual string RoleArn { get; set; }
Property Value
System.String
Stages
Represents information about a stage and its definition.
public virtual object Stages { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Specifies the tags applied to the pipeline.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Triggers
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
public virtual object Triggers { get; set; }
Property Value
System.Object
Variables
A list that defines the pipeline variables for a pipeline resource.
public virtual object Variables { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>