Package software.amazon.awscdk.pipelines
Interface ConnectionSourceOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
ConnectionSourceOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:49.812Z")
@Stability(Stable)
public interface ConnectionSourceOptions
extends software.amazon.jsii.JsiiSerializable
Configuration options for CodeStar source.
Example:
CodePipeline pipeline = CodePipeline.Builder.create(this, "Pipeline") .synth(ShellStep.Builder.create("Synth") .input(CodePipelineSource.connection("my-org/my-app", "main", ConnectionSourceOptions.builder() .connectionArn("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41") .build())) .commands(List.of("npm ci", "npm run build", "npx cdk synth")) .build()) // Turn this on because the pipeline uses Docker image assets .dockerEnabledForSelfMutation(true) .build(); pipeline.addWave("MyWave", WaveOptions.builder() .post(List.of( CodeBuildStep.Builder.create("RunApproval") .commands(List.of("command-from-image")) .buildEnvironment(BuildEnvironment.builder() // The user of a Docker image asset in the pipeline requires turning on // 'dockerEnabledForSelfMutation'. .buildImage(LinuxBuildImage.fromAsset(this, "Image", DockerImageAssetProps.builder() .directory("./docker-image") .build())) .build()) .build())) .build());
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forConnectionSourceOptions
static final class
An implementation forConnectionSourceOptions
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Boolean
If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.default Boolean
Controls automatically starting your pipeline when a new commit is made on the configured repository and branch.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getConnectionArn
The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.Example:
"arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh";
- See Also:
-
getCodeBuildCloneOutput
If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).This provides access to repository history, and retains symlinks (symlinks would otherwise be removed by CodePipeline).
Note: if this option is true, only CodeBuild jobs can use the output artifact.
Default: false
- See Also:
-
getTriggerOnPush
Controls automatically starting your pipeline when a new commit is made on the configured repository and branch.If unspecified, the default value is true, and the field does not display by default.
Default: true
- See Also:
-
builder
- Returns:
- a
ConnectionSourceOptions.Builder
ofConnectionSourceOptions
-