@cloudcomponents/cdk-pull-request-check
@cloudcomponents/cdk-pull-request-check / PullRequestCheck
Represents a reference to a PullRequestCheck.
-
Construct↳
PullRequestCheck
- addToRolePolicy
- onCheckFailed
- onCheckStarted
- onCheckSucceeded
- onPrepare
- onSynthesize
- onValidate
- prepare
- synthesize
- toString
- validate
- isConstruct
• new PullRequestCheck(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
PullRequestCheckProps |
Construct.constructor
• Optional Readonly codeBuildResultFunction: IFunction
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
• Private pullRequestProject: Project
▸ addToRolePolicy(statement): void
Add a permission only if there's a policy attached.
| Name | Type | Description |
|---|---|---|
statement |
PolicyStatement |
The permissions statement to add |
void
▸ onCheckFailed(id, options?): Rule
Defines an event rule which triggers when a check fails.
| Name | Type |
|---|---|
id |
string |
options? |
OnEventOptions |
Rule
▸ onCheckStarted(id, options?): Rule
Defines an event rule which triggers when a check starts.
| Name | Type |
|---|---|
id |
string |
options? |
OnEventOptions |
Rule
▸ onCheckSucceeded(id, options?): Rule
Defines an event rule which triggers when a check complets successfully.
| Name | Type |
|---|---|
id |
string |
options? |
OnEventOptions |
Rule
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-pull-request-check / PullRequestCheckProps
- allowAllOutbound
- artifacts
- buildImage
- buildSpec
- computeType
- environmentVariables
- postComment
- privileged
- projectName
- repository
- role
- securityGroups
- subnetSelection
- updateApprovalState
- vpc
• Optional Readonly allowAllOutbound: boolean
Whether to allow the CodeBuild to send all network traffic. If set to false, you must individually add traffic rules to allow the CodeBuild project to connect to network targets. Only used if 'vpc' is supplied.
default true
• Optional Readonly artifacts: IArtifacts
Defines where build artifacts will be stored.
Could be: PipelineBuildArtifacts, NoArtifacts and S3Artifacts.
default NoArtifacts
• Optional Readonly buildImage: IBuildImage
Build environment to use for the build.
default BuildEnvironment.LinuxBuildImage.STANDARD_2_0
• Readonly buildSpec: BuildSpec
Filename or contents of buildspec in JSON format.
see https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example
• Optional Readonly computeType: ComputeType
The type of compute to use for this build. See the {@link ComputeType} enum for the possible values.
default taken from {@link #buildImage#defaultComputeType}
• Optional Readonly environmentVariables: Object
The environment variables that your builds can use.
▪ [name: string]: BuildEnvironmentVariable
• Optional Readonly postComment: boolean
Specifies whether comments should be written in the request
default true
• Optional Readonly privileged: boolean
Indicates how the project builds Docker images. Specify true to enable running the Docker daemon inside a Docker container. This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail.
default false
• Optional Readonly projectName: string
The human-visible name of this PullRequest-Project.
- @default taken from {@link #repository:#repositoryName}-pull-request
• Readonly repository: IRepository
The CodeCommit repository.
• Optional Readonly role: IRole
The IAM service Role of the Project.
• Optional Readonly securityGroups: ISecurityGroup[]
What security group to associate with the codebuild project's network interfaces. If no security group is identified, one will be created automatically. Only used if 'vpc' is supplied.
default Security group will be automatically created
• Optional Readonly subnetSelection: SubnetSelection
Where to place the network interfaces within the VPC. Only used if 'vpc' is supplied.
default All private subnets
• Optional Readonly updateApprovalState: boolean
Indicates whether the approval state [APPROVE, REVOKE] should be updated
default true
• Optional Readonly vpc: IVpc
VPC network to place codebuild network interfaces. Specify this if the codebuild project needs to access resources in a VPC.
default No VPC is specified