software.amazon.awscdk.services.codepipeline.actions

Interface CodeStarConnectionsSourceActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodeStarConnectionsSourceActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.532Z")
 @Stability(value=Stable)
public interface CodeStarConnectionsSourceActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties for CodeStarConnectionsSourceAction.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 Artifact sourceOutput = new Artifact();
 CodeStarConnectionsSourceAction sourceAction = CodeStarConnectionsSourceAction.Builder.create()
         .actionName("BitBucket_Source")
         .owner("aws")
         .repo("aws-cdk")
         .output(sourceOutput)
         .connectionArn("arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CodeStarConnectionsSourceActionProps.Builder	builder()
default String	getBranch() The branch to build.
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.
Artifact	getOutput() The output artifact that this action produces.
String	getOwner() The owning user or organization of the repository.
String	getRepo() The name of the 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.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

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:

 // Example automatically generated from non-compiling source. May contain errors.
 "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

getOutput

@Stability(value=Stable)
 @NotNull
Artifact getOutput()

The output artifact that this action produces.

Can be used as input for further pipeline actions.

getOwner

@Stability(value=Stable)
 @NotNull
String getOwner()

The owning user or organization of the repository.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 "aws";
 

getRepo

@Stability(value=Stable)
 @NotNull
String getRepo()

The name of the repository.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 "aws-cdk";
 

getBranch

@Stability(value=Stable)
 @Nullable
default String getBranch()

The branch to build.

Default: 'master'

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 CodeStarConnectionsSourceActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a CodeStarConnectionsSourceActionProps.Builder of CodeStarConnectionsSourceActionProps