Class CfnPipeline
- All Implemented Interfaces:
IEnvironmentAware,IInspectable,ITaggable,IPipelineRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.
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 .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codepipeline.*;
Object configuration;
CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
.roleArn("roleArn")
.stages(List.of(StageDeclarationProperty.builder()
.actions(List.of(ActionDeclarationProperty.builder()
.actionTypeId(ActionTypeIdProperty.builder()
.category("category")
.owner("owner")
.provider("provider")
.version("version")
.build())
.name("name")
// the properties below are optional
.commands(List.of("commands"))
.configuration(configuration)
.environmentVariables(List.of(EnvironmentVariableProperty.builder()
.name("name")
.value("value")
// the properties below are optional
.type("type")
.build()))
.inputArtifacts(List.of(InputArtifactProperty.builder()
.name("name")
.build()))
.namespace("namespace")
.outputArtifacts(List.of(OutputArtifactProperty.builder()
.name("name")
// the properties below are optional
.files(List.of("files"))
.build()))
.outputVariables(List.of("outputVariables"))
.region("region")
.roleArn("roleArn")
.runOrder(123)
.timeoutInMinutes(123)
.build()))
.name("name")
// the properties below are optional
.beforeEntry(BeforeEntryConditionsProperty.builder()
.conditions(List.of(ConditionProperty.builder()
.result("result")
.rules(List.of(RuleDeclarationProperty.builder()
.commands(List.of("commands"))
.configuration(configuration)
.inputArtifacts(List.of(InputArtifactProperty.builder()
.name("name")
.build()))
.name("name")
.region("region")
.roleArn("roleArn")
.ruleTypeId(RuleTypeIdProperty.builder()
.category("category")
.owner("owner")
.provider("provider")
.version("version")
.build())
.build()))
.build()))
.build())
.blockers(List.of(BlockerDeclarationProperty.builder()
.name("name")
.type("type")
.build()))
.onFailure(FailureConditionsProperty.builder()
.conditions(List.of(ConditionProperty.builder()
.result("result")
.rules(List.of(RuleDeclarationProperty.builder()
.commands(List.of("commands"))
.configuration(configuration)
.inputArtifacts(List.of(InputArtifactProperty.builder()
.name("name")
.build()))
.name("name")
.region("region")
.roleArn("roleArn")
.ruleTypeId(RuleTypeIdProperty.builder()
.category("category")
.owner("owner")
.provider("provider")
.version("version")
.build())
.build()))
.build()))
.result("result")
.retryConfiguration(RetryConfigurationProperty.builder()
.retryMode("retryMode")
.build())
.build())
.onSuccess(SuccessConditionsProperty.builder()
.conditions(List.of(ConditionProperty.builder()
.result("result")
.rules(List.of(RuleDeclarationProperty.builder()
.commands(List.of("commands"))
.configuration(configuration)
.inputArtifacts(List.of(InputArtifactProperty.builder()
.name("name")
.build()))
.name("name")
.region("region")
.roleArn("roleArn")
.ruleTypeId(RuleTypeIdProperty.builder()
.category("category")
.owner("owner")
.provider("provider")
.version("version")
.build())
.build()))
.build()))
.build())
.build()))
// the properties below are optional
.artifactStore(ArtifactStoreProperty.builder()
.location("location")
.type("type")
// the properties below are optional
.encryptionKey(EncryptionKeyProperty.builder()
.id("id")
.type("type")
.build())
.build())
.artifactStores(List.of(ArtifactStoreMapProperty.builder()
.artifactStore(ArtifactStoreProperty.builder()
.location("location")
.type("type")
// the properties below are optional
.encryptionKey(EncryptionKeyProperty.builder()
.id("id")
.type("type")
.build())
.build())
.region("region")
.build()))
.disableInboundStageTransitions(List.of(StageTransitionProperty.builder()
.reason("reason")
.stageName("stageName")
.build()))
.executionMode("executionMode")
.name("name")
.pipelineType("pipelineType")
.restartExecutionOnUpdate(false)
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.triggers(List.of(PipelineTriggerDeclarationProperty.builder()
.providerType("providerType")
// the properties below are optional
.gitConfiguration(GitConfigurationProperty.builder()
.sourceActionName("sourceActionName")
// the properties below are optional
.pullRequest(List.of(GitPullRequestFilterProperty.builder()
.branches(GitBranchFilterCriteriaProperty.builder()
.excludes(List.of("excludes"))
.includes(List.of("includes"))
.build())
.events(List.of("events"))
.filePaths(GitFilePathFilterCriteriaProperty.builder()
.excludes(List.of("excludes"))
.includes(List.of("includes"))
.build())
.build()))
.push(List.of(GitPushFilterProperty.builder()
.branches(GitBranchFilterCriteriaProperty.builder()
.excludes(List.of("excludes"))
.includes(List.of("includes"))
.build())
.filePaths(GitFilePathFilterCriteriaProperty.builder()
.excludes(List.of("excludes"))
.includes(List.of("includes"))
.build())
.tags(GitTagFilterCriteriaProperty.builder()
.excludes(List.of("excludes"))
.includes(List.of("includes"))
.build())
.build()))
.build())
.build()))
.variables(List.of(VariableDeclarationProperty.builder()
.name("name")
// the properties below are optional
.defaultValue("defaultValue")
.description("description")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceRepresents information about an action declaration.static interfaceRepresents information about an action type.static interfaceA mapping ofartifactStoreobjects and their corresponding AWS Regions.static interfaceThe S3 bucket where artifacts for the pipeline are stored.static interfaceThe conditions for making checks for entry to a stage.static interfaceReserved for future use.static final classA fluent builder forCfnPipeline.static interfaceThe condition for the stage.static interfaceRepresents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.static interfaceThe environment variables for the action.static interfaceThe configuration that specifies the result, such as rollback, to occur upon stage failure.static interfaceThe Git repository branches specified as filter criteria to start the pipeline.static interfaceA type of trigger configuration for Git-based source actions.static interfaceThe Git repository file paths specified as filter criteria to start the pipeline.static interfaceThe event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.static interfaceThe event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.static interfaceThe Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.static interfaceRepresents information about an artifact to be worked on, such as a test or build artifact.static interfaceRepresents information about the output of an action.static interfaceRepresents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.static interfaceThe retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.static interfaceRepresents information about the rule to be created for an associated condition.static interfaceThe ID for the rule type, which is made up of the combined values for category, owner, provider, and version.static interfaceRepresents information about a stage and its definition.static interfaceThe name of the pipeline in which you want to disable the flow of artifacts from one stage to another.static interfaceThe conditions for making checks that, if met, succeed a stage.static interfaceA variable declared at the pipeline level.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.IPipelineRef
IPipelineRef.Jsii$Default, IPipelineRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnPipeline(software.amazon.jsii.JsiiObjectRef objRef) CfnPipeline(software.constructs.Construct scope, String id, CfnPipelineProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic IPipelineReffromPipelineName(software.constructs.Construct scope, String id, String pipelineName) Creates a new IPipelineRef from a pipelineName.The S3 bucket where artifacts for the pipeline are stored.A mapping ofartifactStoreobjects and their corresponding AWS Regions.The version of the pipeline.Represents the input of aDisableStageTransitionaction.The method that the pipeline will use to handle multiple executions.getName()The name of the pipeline.A reference to a Pipeline resource.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.Indicates whether to rerun the CodePipeline pipeline after you update it.The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with noactionRoleArn, or to use to assume roles for actions with anactionRoleArn.Represents information about a stage and its definition.getTags()Tag Manager which manages the tags for this resource.Specifies the tags applied to the pipeline.The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.A list that defines the pipeline variables for a pipeline resource.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetArtifactStore(IResolvable value) The S3 bucket where artifacts for the pipeline are stored.voidThe S3 bucket where artifacts for the pipeline are stored.voidsetArtifactStores(List<Object> value) A mapping ofartifactStoreobjects and their corresponding AWS Regions.voidsetArtifactStores(IResolvable value) A mapping ofartifactStoreobjects and their corresponding AWS Regions.voidRepresents the input of aDisableStageTransitionaction.voidRepresents the input of aDisableStageTransitionaction.voidsetExecutionMode(String value) The method that the pipeline will use to handle multiple executions.voidThe name of the pipeline.voidsetPipelineType(String value) 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.voidIndicates whether to rerun the CodePipeline pipeline after you update it.voidIndicates whether to rerun the CodePipeline pipeline after you update it.voidsetRoleArn(String value) The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with noactionRoleArn, or to use to assume roles for actions with anactionRoleArn.voidRepresents information about a stage and its definition.voidsetStages(IResolvable value) Represents information about a stage and its definition.voidsetTagsRaw(List<CfnTag> value) Specifies the tags applied to the pipeline.voidsetTriggers(List<Object> value) The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.voidsetTriggers(IResolvable value) The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.voidsetVariables(List<Object> value) A list that defines the pipeline variables for a pipeline resource.voidsetVariables(IResolvable value) A list that defines the pipeline variables for a pipeline resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnPipeline
protected CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPipeline
protected CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPipeline
@Stability(Stable) public CfnPipeline(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPipelineProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
fromPipelineName
@Stability(Stable) @NotNull public static IPipelineRef fromPipelineName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String pipelineName) Creates a new IPipelineRef from a pipelineName.- Parameters:
scope- This parameter is required.id- This parameter is required.pipelineName- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrVersion
The version of the pipeline.A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getPipelineRef
A reference to a Pipeline resource.- Specified by:
getPipelineRefin interfaceIPipelineRef
-
getTags
Tag Manager which manages the tags for this resource. -
getRoleArn
The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with noactionRoleArn, or to use to assume roles for actions with anactionRoleArn. -
setRoleArn
The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with noactionRoleArn, or to use to assume roles for actions with anactionRoleArn. -
getStages
Represents information about a stage and its definition.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPipeline.StageDeclarationProperty> -
setStages
Represents information about a stage and its definition. -
setStages
Represents information about a stage and its definition. -
getArtifactStore
The S3 bucket where artifacts for the pipeline are stored.Returns union: either
IResolvableorCfnPipeline.ArtifactStoreProperty -
setArtifactStore
The S3 bucket where artifacts for the pipeline are stored. -
setArtifactStore
The S3 bucket where artifacts for the pipeline are stored. -
getArtifactStores
A mapping ofartifactStoreobjects and their corresponding AWS Regions.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPipeline.ArtifactStoreMapProperty> -
setArtifactStores
A mapping ofartifactStoreobjects and their corresponding AWS Regions. -
setArtifactStores
A mapping ofartifactStoreobjects and their corresponding AWS Regions. -
getDisableInboundStageTransitions
Represents the input of aDisableStageTransitionaction.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPipeline.StageTransitionProperty> -
setDisableInboundStageTransitions
Represents the input of aDisableStageTransitionaction. -
setDisableInboundStageTransitions
Represents the input of aDisableStageTransitionaction. -
getExecutionMode
The method that the pipeline will use to handle multiple executions. -
setExecutionMode
The method that the pipeline will use to handle multiple executions. -
getName
The name of the pipeline. -
setName
The name of the pipeline. -
getPipelineType
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. -
setPipelineType
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. -
getRestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it.Returns union: either
BooleanorIResolvable -
setRestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it. -
setRestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it. -
getTagsRaw
Specifies the tags applied to the pipeline. -
setTagsRaw
Specifies the tags applied to the pipeline. -
getTriggers
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPipeline.PipelineTriggerDeclarationProperty> -
setTriggers
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline. -
setTriggers
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline. -
getVariables
A list that defines the pipeline variables for a pipeline resource.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPipeline.VariableDeclarationProperty> -
setVariables
A list that defines the pipeline variables for a pipeline resource. -
setVariables
A list that defines the pipeline variables for a pipeline resource.
-