API.md

API Reference

Classes

Name	Description
CheckParameterFunction	No description
CodePipelineCheckEmailParameterAction	No description
CodePipelineCheckParameterAction	Represents a reference to a CodePipelineCheckParameterAction.
CodePipelineCheckUrlParameterAction	No description

Structs

Name	Description
CheckParamterFunctionProps	No description
CodePipelineCheckEmailParameterActionProps	No description
CodePipelineCheckParameterActionProps	No description
CodePipelineCheckUrlParameterActionProps	No description
CommonCodePipelineCheckParameterActionProps	No description
RegExp	No description

class CheckParameterFunction

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

Initializer

new CheckParameterFunction(scope: Construct, id: string, props: CheckParamterFunctionProps)

• scope (Construct) No description
• id (string) No description
• props (CheckParamterFunctionProps) No description
  • parameterName (string) The name of the parameter.
  • crossAccountRole (IRole) Role for crossAccount permission. Optional

class CodePipelineCheckEmailParameterAction

Implements: IAction Extends: CodePipelineCheckParameterAction

Initializer

new CodePipelineCheckEmailParameterAction(props: CodePipelineCheckEmailParameterActionProps)

• props (CodePipelineCheckEmailParameterActionProps) 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
  • parameterName (string) The name of the parameter.
  • crossAccountRole (IRole) Role for crossAccount permission. Optional
  • logParameter (boolean) Parameter is logged after successful check. Default: false The parameter is not logged
  • exact (boolean) Only match an exact string. Default: true

class CodePipelineCheckParameterAction

Represents a reference to a CodePipelineCheckParameterAction.

Implements: IAction Extends: Action

Initializer

new CodePipelineCheckParameterAction(props: CodePipelineCheckParameterActionProps)

• props (CodePipelineCheckParameterActionProps) 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
  • parameterName (string) The name of the parameter.
  • crossAccountRole (IRole) Role for crossAccount permission. Optional
  • logParameter (boolean) Parameter is logged after successful check. Default: false The parameter is not logged
  • regExp (RegExp) Regular expression to validate the parameter. Optional

Methods

protected bound(scope, _stage, options)

The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

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 CodePipelineCheckUrlParameterAction

Implements: IAction Extends: CodePipelineCheckParameterAction

Initializer

new CodePipelineCheckUrlParameterAction(props: CodePipelineCheckUrlParameterActionProps)

• props (CodePipelineCheckUrlParameterActionProps) 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
  • parameterName (string) The name of the parameter.
  • crossAccountRole (IRole) Role for crossAccount permission. Optional
  • logParameter (boolean) Parameter is logged after successful check. Default: false The parameter is not logged
  • exact (boolean) Only match an exact string. Default: true
  • strict (boolean) Force URLs to start with a valid protocol or www. Optional

struct CheckParamterFunctionProps

Name	Type	Description
parameterName	string	The name of the parameter.
crossAccountRole?	IRole	Role for crossAccount permission. Optional

struct CodePipelineCheckEmailParameterActionProps

Name	Type	Description
actionName	string	The physical, human-readable name of the Action.
parameterName	string	The name of the parameter.
crossAccountRole?	IRole	Role for crossAccount permission. Optional
exact?	boolean	Only match an exact string. Default: true
logParameter?	boolean	Parameter is logged after successful check. Default: false The parameter is not logged
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 CodePipelineCheckParameterActionProps

Name	Type	Description
actionName	string	The physical, human-readable name of the Action.
parameterName	string	The name of the parameter.
crossAccountRole?	IRole	Role for crossAccount permission. Optional
logParameter?	boolean	Parameter is logged after successful check. Default: false The parameter is not logged
regExp?	RegExp	Regular expression to validate the parameter. 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 CodePipelineCheckUrlParameterActionProps

Name	Type	Description
actionName	string	The physical, human-readable name of the Action.
parameterName	string	The name of the parameter.
crossAccountRole?	IRole	Role for crossAccount permission. Optional
exact?	boolean	Only match an exact string. Default: true
logParameter?	boolean	Parameter is logged after successful check. Default: false The parameter is not logged
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
strict?	boolean	Force URLs to start with a valid protocol or www. Optional
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 CommonCodePipelineCheckParameterActionProps

Name	Type	Description
actionName	string	The physical, human-readable name of the Action.
parameterName	string	The name of the parameter.
crossAccountRole?	IRole	Role for crossAccount permission. Optional
logParameter?	boolean	Parameter is logged after successful check. Default: false The parameter is not logged
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 RegExp

Name	Type	Description
source	string