Interface ConnectionSourceOptions

Configuration options for CodeStar source

interface ConnectionSourceOptions {
    actionName?: string;
    codeBuildCloneOutput?: boolean;
    connectionArn: string;
    triggerOnPush?: boolean;
}

Properties

actionName? codeBuildCloneOutput? connectionArn triggerOnPush?

Properties

Optional Readonly actionName

actionName?: string

The action name used for this source in the CodePipeline

Default

- The repository string

Optional Readonly codeBuildCloneOutput

codeBuildCloneOutput?: boolean

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

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

Readonly connectionArn

connectionArn: string

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

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

Optional Readonly triggerOnPush

triggerOnPush?: boolean

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

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

Settings

Member Visibility

Theme

On This Page

actionNamecodeBuildCloneOutputconnectionArntriggerOnPush

Generated using TypeDoc