software.amazon.awscdk.pipelines

Interface ConnectionSourceOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ConnectionSourceOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T22:36:25.823Z")
 @Stability(value=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

Nested Classes

Modifier and Type	Interface and Description
static class	ConnectionSourceOptions.Builder A builder for ConnectionSourceOptions
static class	ConnectionSourceOptions.Jsii$Proxy An implementation for ConnectionSourceOptions

Method Summary

Modifier and Type	Method and Description
static ConnectionSourceOptions.Builder	builder()
default Boolean	getCodeBuildCloneOutput() Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.
String	getConnectionArn() The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.
default Boolean	getTriggerOnPush() 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 Detail

getConnectionArn

@Stability(value=Stable)
 @NotNull
String 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:

https://docs.aws.amazon.com/codepipeline/latest/userguide/connections-create.html

getCodeBuildCloneOutput

@Stability(value=Stable)
 @Nullable
default Boolean getCodeBuildCloneOutput()

Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.

Note: if this option is true, then only CodeBuild actions can use the resulting {@link output}.

Default: false

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html#action-reference-CodestarConnectionSource-config

getTriggerOnPush

@Stability(value=Stable)
 @Nullable
default Boolean 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:

https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html

builder

@Stability(value=Stable)
static ConnectionSourceOptions.Builder builder()

Returns:

a ConnectionSourceOptions.Builder of ConnectionSourceOptions