interface CodeStarConnectionsSourceActionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodePipeline.Actions.CodeStarConnectionsSourceActionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#CodeStarConnectionsSourceActionProps |
![]() | software.amazon.awscdk.services.codepipeline.actions.CodeStarConnectionsSourceActionProps |
![]() | aws_cdk.aws_codepipeline_actions.CodeStarConnectionsSourceActionProps |
![]() | aws-cdk-lib » aws_codepipeline_actions » CodeStarConnectionsSourceActionProps |
Construction properties for CodeStarConnectionsSourceAction
.
Example
const sourceOutput = new codepipeline.Artifact();
const sourceAction = new codepipeline_actions.CodeStarConnectionsSourceAction({
actionName: 'BitBucket_Source',
owner: 'aws',
repo: 'aws-cdk',
output: sourceOutput,
connectionArn: 'arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh',
});
Properties
Name | Type | Description |
---|---|---|
action | string | The physical, human-readable name of the Action. |
connection | string | The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository. |
output | Artifact | The output artifact that this action produces. |
owner | string | The owning user or organization of the repository. |
repo | string | The name of the repository. |
branch? | string | The branch to build. |
code | boolean | 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. |
role? | IRole | The Role in which context's this Action will be executing in. |
run | number | The runOrder property for this Action. |
trigger | boolean | Controls automatically starting your pipeline when a new commit is made on the configured repository and branch. |
variables | string | The name of the namespace to use for variables emitted by this action. |
actionName
Type:
string
The physical, human-readable name of the Action.
Note that Action names must be unique within a single Stage.
connectionArn
Type:
string
The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.
See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/connections-create.html Example
'arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh'
output
Type:
Artifact
The output artifact that this action produces.
Can be used as input for further pipeline actions.
owner
Type:
string
The owning user or organization of the repository. Example
'aws'
repo
Type:
string
The name of the repository. Example
'aws-cdk'
branch?
Type:
string
(optional, default: 'master')
The branch to build.
codeBuildCloneOutput?
Type:
boolean
(optional, default: false)
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 output
.
role?
Type:
IRole
(optional, default: a new Role will be generated)
The Role in which context's this Action will be executing in.
The Pipeline's Role will assume this Role
(the required permissions for that will be granted automatically)
right before executing this Action.
This Action will be passed into your IAction.bind
method in the ActionBindOptions.role
property.
runOrder?
Type:
number
(optional, default: 1)
The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
triggerOnPush?
Type:
boolean
(optional, default: true)
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.
variablesNamespace?
Type:
string
(optional, default: a name will be generated, based on the stage and action names,
if any of the action's variables were referenced - otherwise,
no namespace will be set)
The name of the namespace to use for variables emitted by this action.