API.md

API Reference

Classes

Name	Description
CodePipelineMergeAction	Represents a reference to a CodePipelineMergeAction.
MergeBranchesFunction	No description

Structs

Name	Description
CodePipelineMergeActionProps	No description
MergeBranchesFunctionProps	No description

class CodePipelineMergeAction

Represents a reference to a CodePipelineMergeAction.

Implements: IAction Extends: Action

Initializer

new CodePipelineMergeAction(props: CodePipelineMergeActionProps)

• props (CodePipelineMergeActionProps) No description
  • actionName (string) The physical, human-readable name of the Action.
  • runOrder (number) The runOrder property for this Action. Default: 1
  • variablesNamespace (string) The name of the namespace to use for variables emitted by this action. 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
  • role (IRole) The Role in which context's this Action will be executing in. Default: a new Role will be generated
  • destinationCommitSpecifier (string) The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
  • repository (IRepository) The CodeCommit repository.
  • sourceCommitSpecifier (string) The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
  • crossAccountRole (IRole) Role for crossAccount permission. Optional

Methods

protected bound(scope, _stage, options)

This is a renamed version of the {@link IAction.bind} method.

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

• scope (Construct) No description
• _stage (IStage) No description
• options (ActionBindOptions) No description
  • bucket (IBucket) No description
  • role (IRole) No description

Returns:

• ActionConfig

class MergeBranchesFunction

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IFunction, IConstruct, IDependable, IConstruct, IResource, IConnectable, IGrantable, IClientVpnConnectionHandler Extends: Function

Initializer

new MergeBranchesFunction(scope: Construct, id: string, props: MergeBranchesFunctionProps)

• scope (Construct) No description
• id (string) No description
• props (MergeBranchesFunctionProps) No description
  • repository (IRepository) The CodeCommit repository.
  • crossAccountRole (IRole) Role for crossAccount permission. Optional

struct CodePipelineMergeActionProps

Name	Type	Description
actionName	string	The physical, human-readable name of the Action.
destinationCommitSpecifier	string	The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
repository	IRepository	The CodeCommit repository.
sourceCommitSpecifier	string	The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).
crossAccountRole?	IRole	Role for crossAccount permission. Optional
role?	IRole	The Role in which context's this Action will be executing in. Default: a new Role will be generated
runOrder?	number	The runOrder property for this Action. Default: 1
variablesNamespace?	string	The name of the namespace to use for variables emitted by this action. 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

struct MergeBranchesFunctionProps

Name	Type	Description
repository	IRepository	The CodeCommit repository.
crossAccountRole?	IRole	Role for crossAccount permission. Optional