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, IPipelineRef, IConstruct, IDependable, IEnvironmentAware, ITaggableSyntax (vb)
Public Class CfnPipeline Inherits CfnResource Implements IInspectable, IPipelineRef, IConstruct, IDependable, IEnvironmentAware, ITaggableRemarks
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
Commands = new [] { "commands" },
Configuration = configuration,
EnvironmentVariables = new [] { new EnvironmentVariableProperty {
Name = "name",
Value = "value",
// the properties below are optional
Type = "type"
} },
InputArtifacts = new [] { new InputArtifactProperty {
Name = "name"
} },
Namespace = "namespace",
OutputArtifacts = new [] { new OutputArtifactProperty {
Name = "name",
// the properties below are optional
Files = new [] { "files" }
} },
OutputVariables = new [] { "outputVariables" },
Region = "region",
RoleArn = "roleArn",
RunOrder = 123,
TimeoutInMinutes = 123
} },
Name = "name",
// the properties below are optional
BeforeEntry = new BeforeEntryConditionsProperty {
Conditions = new [] { new ConditionProperty {
Result = "result",
Rules = new [] { new RuleDeclarationProperty {
Commands = new [] { "commands" },
Configuration = configuration,
InputArtifacts = new [] { new InputArtifactProperty {
Name = "name"
} },
Name = "name",
Region = "region",
RoleArn = "roleArn",
RuleTypeId = new RuleTypeIdProperty {
Category = "category",
Owner = "owner",
Provider = "provider",
Version = "version"
}
} }
} }
},
Blockers = new [] { new BlockerDeclarationProperty {
Name = "name",
Type = "type"
} },
OnFailure = new FailureConditionsProperty {
Conditions = new [] { new ConditionProperty {
Result = "result",
Rules = new [] { new RuleDeclarationProperty {
Commands = new [] { "commands" },
Configuration = configuration,
InputArtifacts = new [] { new InputArtifactProperty {
Name = "name"
} },
Name = "name",
Region = "region",
RoleArn = "roleArn",
RuleTypeId = new RuleTypeIdProperty {
Category = "category",
Owner = "owner",
Provider = "provider",
Version = "version"
}
} }
} },
Result = "result",
RetryConfiguration = new RetryConfigurationProperty {
RetryMode = "retryMode"
}
},
OnSuccess = new SuccessConditionsProperty {
Conditions = new [] { new ConditionProperty {
Result = "result",
Rules = new [] { new RuleDeclarationProperty {
Commands = new [] { "commands" },
Configuration = configuration,
InputArtifacts = new [] { new InputArtifactProperty {
Name = "name"
} },
Name = "name",
Region = "region",
RoleArn = "roleArn",
RuleTypeId = new RuleTypeIdProperty {
Category = "category",
Owner = "owner",
Provider = "provider",
Version = "version"
}
} }
} }
}
} },
// 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(Construct, string, ICfnPipelineProps) | Create a new |
Properties
| ArtifactStore | The S3 bucket where artifacts for the pipeline are stored. |
| ArtifactStores | A mapping of |
| AttrVersion | The version of the pipeline. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | The |
| DisableInboundStageTransitions | Represents the input of a |
| ExecutionMode | The method that the pipeline will use to handle multiple executions. |
| Name | The name of the pipeline. |
| PipelineRef | A reference to a Pipeline resource. |
| 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
| ArnForPipeline(IPipelineRef) | The |
| FromPipelineName(Construct, string, string) | Creates a new IPipelineRef from a pipelineName. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnPipeline(object) | Checks whether the given object is a CfnPipeline. |
| RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnPipeline(Construct, string, ICfnPipelineProps)
Create a new AWS::CodePipeline::Pipeline.
public CfnPipeline(Construct scope, string id, ICfnPipelineProps props)Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnPipelineProps
Resource properties.
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
Properties
ArtifactStore
The S3 bucket where artifacts for the pipeline are stored.
public virtual object? ArtifactStore { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnPipeline.IArtifactStoreProperty
ArtifactStores
A mapping of artifactStore objects and their corresponding AWS Regions.
public virtual object? ArtifactStores { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnPipeline.IArtifactStoreMapProperty)[]
AttrVersion
The version of the pipeline.
public virtual string AttrVersion { get; }Property Value
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
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
CfnProperties
The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Overrides
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
DisableInboundStageTransitions
Represents the input of a DisableStageTransition action.
public virtual object? DisableInboundStageTransitions { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnPipeline.IStageTransitionProperty)[]
ExecutionMode
The method that the pipeline will use to handle multiple executions.
public virtual string? ExecutionMode { get; set; }Property Value
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
Name
The name of the pipeline.
public virtual string? Name { get; set; }Property Value
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
PipelineRef
A reference to a Pipeline resource.
public virtual IPipelineReference PipelineRef { get; }Property Value
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
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
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
RestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it.
public virtual object? RestartExecutionOnUpdate { get; set; }Property Value
Remarks
Type union: either bool or IResolvable
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
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
Stages
Represents information about a stage and its definition.
public virtual object Stages { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnPipeline.IStageDeclarationProperty)[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }Property Value
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
TagsRaw
Specifies the tags applied to the pipeline.
public virtual ICfnTag[]? TagsRaw { get; set; }Property Value
ICfnTag[]
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
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
Remarks
Type union: either IResolvable or (either IResolvable or CfnPipeline.IPipelineTriggerDeclarationProperty)[]
Variables
A list that defines the pipeline variables for a pipeline resource.
public virtual object? Variables { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnPipeline.IVariableDeclarationProperty)[]
Methods
ArnForPipeline(IPipelineRef)
The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.
public static string ArnForPipeline(IPipelineRef resource)Parameters
- resource IPipelineRef
Returns
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
Commands = new [] { "commands" },
Configuration = configuration,
EnvironmentVariables = new [] { new EnvironmentVariableProperty {
Name = "name",
Value = "value",
// the properties below are optional
Type = "type"
} },
InputArtifacts = new [] { new InputArtifactProperty {
Name = "name"
} },
Namespace = "namespace",
OutputArtifacts = new [] { new OutputArtifactProperty {
Name = "name",
// the properties below are optional
Files = new [] { "files" }
} },
OutputVariables = new [] { "outputVariables" },
Region = "region",
RoleArn = "roleArn",
RunOrder = 123,
TimeoutInMinutes = 123
} },
Name = "name",
// the properties below are optional
BeforeEntry = new BeforeEntryConditionsProperty {
Conditions = new [] { new ConditionProperty {
Result = "result",
Rules = new [] { new RuleDeclarationProperty {
Commands = new [] { "commands" },
Configuration = configuration,
InputArtifacts = new [] { new InputArtifactProperty {
Name = "name"
} },
Name = "name",
Region = "region",
RoleArn = "roleArn",
RuleTypeId = new RuleTypeIdProperty {
Category = "category",
Owner = "owner",
Provider = "provider",
Version = "version"
}
} }
} }
},
Blockers = new [] { new BlockerDeclarationProperty {
Name = "name",
Type = "type"
} },
OnFailure = new FailureConditionsProperty {
Conditions = new [] { new ConditionProperty {
Result = "result",
Rules = new [] { new RuleDeclarationProperty {
Commands = new [] { "commands" },
Configuration = configuration,
InputArtifacts = new [] { new InputArtifactProperty {
Name = "name"
} },
Name = "name",
Region = "region",
RoleArn = "roleArn",
RuleTypeId = new RuleTypeIdProperty {
Category = "category",
Owner = "owner",
Provider = "provider",
Version = "version"
}
} }
} },
Result = "result",
RetryConfiguration = new RetryConfigurationProperty {
RetryMode = "retryMode"
}
},
OnSuccess = new SuccessConditionsProperty {
Conditions = new [] { new ConditionProperty {
Result = "result",
Rules = new [] { new RuleDeclarationProperty {
Commands = new [] { "commands" },
Configuration = configuration,
InputArtifacts = new [] { new InputArtifactProperty {
Name = "name"
} },
Name = "name",
Region = "region",
RoleArn = "roleArn",
RuleTypeId = new RuleTypeIdProperty {
Category = "category",
Owner = "owner",
Provider = "provider",
Version = "version"
}
} }
} }
}
} },
// 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"
} }
});FromPipelineName(Construct, string, string)
Creates a new IPipelineRef from a pipelineName.
public static IPipelineRef FromPipelineName(Construct scope, string id, string pipelineName)Parameters
Returns
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
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.
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
IsCfnPipeline(object)
Checks whether the given object is a CfnPipeline.
public static bool IsCfnPipeline(object x)Parameters
- x object
Returns
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
RenderProperties(IDictionary<string, object>)
The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props IDictionary<string, object>
Returns
Overrides
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