Interface CfnPipelineProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPipelineProps.Jsii$Proxy
CfnPipeline
.
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; CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder() .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 .configuration(configuration) .inputArtifacts(List.of(InputArtifactProperty.builder() .name("name") .build())) .namespace("namespace") .outputArtifacts(List.of(OutputArtifactProperty.builder() .name("name") .build())) .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() .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() .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") .build()) .onSuccess(SuccessConditionsProperty.builder() .conditions(List.of(ConditionProperty.builder() .result("result") .rules(List.of(RuleDeclarationProperty.builder() .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 TypeInterfaceDescriptionstatic final class
A builder forCfnPipelineProps
static final class
An implementation forCfnPipelineProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnPipelineProps.Builder
builder()
default Object
The S3 bucket where artifacts for the pipeline are stored.default Object
A mapping ofartifactStore
objects and their corresponding AWS Regions.default Object
Represents the input of aDisableStageTransition
action.default String
The method that the pipeline will use to handle multiple executions.default String
getName()
The name of the pipeline.default String
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.default Object
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()
Specifies the tags applied to the pipeline.default Object
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.default Object
A list that defines the pipeline variables for a pipeline resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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
.- See Also:
-
getStages
Represents information about a stage and its definition.- See Also:
-
getArtifactStore
The S3 bucket where artifacts for the pipeline are stored.You must include either
artifactStore
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.- See Also:
-
getArtifactStores
A mapping ofartifactStore
objects and their corresponding AWS Regions.There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
You must include either
artifactStore
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.- See Also:
-
getDisableInboundStageTransitions
Represents the input of aDisableStageTransition
action.- See Also:
-
getExecutionMode
The method that the pipeline will use to handle multiple executions.The default mode is SUPERSEDED.
Default: - "SUPERSEDED"
- See Also:
-
getName
The name of the pipeline.- See Also:
-
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.- V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
- V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.
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? .
- See Also:
-
getRestartExecutionOnUpdate
Indicates whether to rerun the CodePipeline pipeline after you update it.- See Also:
-
getTags
Specifies the tags applied to the pipeline.- See Also:
-
getTriggers
The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
- See Also:
-
getVariables
A list that defines the pipeline variables for a pipeline resource.Variable names can have alphanumeric and underscore characters, and the values must match
[A-Za-z0-9@\-_]+
.- See Also:
-
builder
- Returns:
- a
CfnPipelineProps.Builder
ofCfnPipelineProps
-