aws-cdk-lib.aws_codepipeline_actions.CodeStarConnectionsSourceAction

class CodeStarConnectionsSourceAction

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.Actions.CodeStarConnectionsSourceAction
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#CodeStarConnectionsSourceAction
Javasoftware.amazon.awscdk.services.codepipeline.actions.CodeStarConnectionsSourceAction
Pythonaws_cdk.aws_codepipeline_actions.CodeStarConnectionsSourceAction
TypeScript (source)aws-cdk-lib » aws_codepipeline_actions » CodeStarConnectionsSourceAction

Implements IAction

Extends Action

A CodePipeline source action for the CodeStar Connections source, which allows connecting to GitHub and BitBucket.

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',
});

Initializer

new CodeStarConnectionsSourceAction(props: CodeStarConnectionsSourceActionProps)

Parameters

  • props CodeStarConnectionsSourceActionProps

Properties

NameTypeDescription
actionPropertiesActionPropertiesThe simple properties of the Action, like its Owner, name, etc.
variablesCodeStarSourceVariablesThe variables emitted by this action.

actionProperties

Type: ActionProperties

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.


variables

Type: CodeStarSourceVariables

The variables emitted by this action.

Methods

NameDescription
bind(scope, stage, options)The callback invoked when this Action is added to a Pipeline.
onStateChange(name, target?, options?)Creates an Event that will be triggered whenever the state of this Action changes.
protected bound(_scope, _stage, options)This is a renamed version of the IAction.bind method.

bind(scope, stage, options)

public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

  • scope Construct
  • stage IStage
  • options ActionBindOptions

Returns

  • ActionConfig

The callback invoked when this Action is added to a Pipeline.


onStateChange(name, target?, options?)

public onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

Parameters

  • name string
  • target IRuleTarget
  • options RuleProps

Returns

  • Rule

Creates an Event that will be triggered whenever the state of this Action changes.


protected bound(_scope, _stage, options)

protected bound(_scope: Construct, _stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

  • _scope Construct
  • _stage IStage
  • options ActionBindOptions

Returns

  • ActionConfig

This is a renamed version of the IAction.bind method.