CodeStarConnectionsSourceAction Class
A CodePipeline source action for the CodeStar Connections source, which allows connecting to GitHub and BitBucket.
Example
ts
declare const project: codebuild.Project;
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',
variablesNamespace: 'SomeSpace', // optional - by default, a name will be generated for you
});
// later:
new codepipeline_actions.CodeBuildAction({
actionName: 'CodeBuild',
project,
input: sourceOutput,
environmentVariables: {
COMMIT_ID: {
value: sourceAction.variables.commitId,
},
},
});
python
# project: codebuild.Project
source_output = codepipeline.Artifact()
source_action = codepipeline_actions.CodeStarConnectionsSourceAction(
action_name="BitBucket_Source",
owner="aws",
repo="aws-cdk",
output=source_output,
connection_arn="arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh",
variables_namespace="SomeSpace"
)
# later:
codepipeline_actions.CodeBuildAction(
action_name="CodeBuild",
project=project,
input=source_output,
environment_variables={
"COMMIT_ID": codebuild.BuildEnvironmentVariable(
value=source_action.variables.commit_id
)
}
)
java
Project project;
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")
.variablesNamespace("SomeSpace")
.build();
// later:
// later:
CodeBuildAction.Builder.create()
.actionName("CodeBuild")
.project(project)
.input(sourceOutput)
.environmentVariables(Map.of(
"COMMIT_ID", BuildEnvironmentVariable.builder()
.value(sourceAction.getVariables().getCommitId())
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
Project project;
var sourceOutput = new Artifact();
var sourceAction = new CodeStarConnectionsSourceAction(new CodeStarConnectionsSourceActionProps {
ActionName = "BitBucket_Source",
Owner = "aws",
Repo = "aws-cdk",
Output = sourceOutput,
ConnectionArn = "arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh",
VariablesNamespace = "SomeSpace"
});
// later:
// later:
new CodeBuildAction(new CodeBuildActionProps {
ActionName = "CodeBuild",
Project = project,
Input = sourceOutput,
EnvironmentVariables = new Dictionary<string, BuildEnvironmentVariable> {
{ "COMMIT_ID", new BuildEnvironmentVariable {
Value = sourceAction.Variables.CommitId
} }
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var project Project
sourceOutput := codepipeline.NewArtifact()
sourceAction := codepipeline_actions.NewCodeStarConnectionsSourceAction(&CodeStarConnectionsSourceActionProps{
ActionName: jsii.String("BitBucket_Source"),
Owner: jsii.String("aws"),
Repo: jsii.String("aws-cdk"),
Output: sourceOutput,
ConnectionArn: jsii.String("arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh"),
VariablesNamespace: jsii.String("SomeSpace"),
})
// later:
// later:
codepipeline_actions.NewCodeBuildAction(&CodeBuildActionProps{
ActionName: jsii.String("CodeBuild"),
Project: Project,
Input: sourceOutput,
EnvironmentVariables: map[string]BuildEnvironmentVariable{
"COMMIT_ID": &BuildEnvironmentVariable{
"value": sourceAction.variables.commitId,
},
},
})
Initializer
ts
new CodeStarConnectionsSourceAction(props: CodeStarConnectionsSourceActionProps)
python
CodeStarConnectionsSourceAction(props: CodeStarConnectionsSourceActionProps)
java
new CodeStarConnectionsSourceAction(CodeStarConnectionsSourceActionProps props)
csharp
new CodeStarConnectionsSourceAction(CodeStarConnectionsSourceActionProps props)
go
NewCodeStarConnectionsSourceAction(Props CodeStarConnectionsSourceActionProps)
Properties
actionPropertiesActionPropertiesaction_propertiesActionPropertiesactionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesrequired#The simple properties of the Action, like its Owner, name, etc.
Note that this accessor will be called before the bind callback.
variablesCodeStarSourceVariablesvariablesCodeStarSourceVariablesvariablesCodeStarSourceVariablesVariablesCodeStarSourceVariablesVariablesCodeStarSourceVariablesrequired#The variables emitted by this action.
Methods
bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfigdef bind(self, scope: Construct, stage: IStage, options: ActionBindOptions) -> ActionConfigpublic ActionConfig bind(Construct scope, IStage stage, ActionBindOptions options)public ActionConfig Bind(Construct scope, IStage stage, ActionBindOptions options)func Bind(Scope Construct, Stage IStage, Options ActionBindOptions) ActionConfig#The callback invoked when this Action is added to a Pipeline.
onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Ruledef on_state_change(self, name: str, target: typing.Optional[IRuleTarget] = None, options: typing.Optional[RuleProps] = None) -> Rulepublic Rule onStateChange(String name, IRuleTarget target, RuleProps options)public Rule OnStateChange(string name, IRuleTarget? target = null, RuleProps? options = null)func OnStateChange(Name *string, Target IRuleTarget, Options RuleProps) Rule#Creates an Event that will be triggered whenever the state of this Action changes.