Package software.amazon.awscdk.services.codebuild

Interface CfnProject.ProjectTriggersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProject.ProjectTriggersProperty.Jsii$Proxy

Enclosing class:

CfnProject

@Stability(Stable)
public static interface CfnProject.ProjectTriggersProperty
extends software.amazon.jsii.JsiiSerializable

ProjectTriggers is a property of the AWS CodeBuild Project resource that specifies webhooks that trigger an AWS CodeBuild build.

The Webhook feature isn't available in AWS CloudFormation for GitHub Enterprise projects. Use the AWS CLI or AWS CodeBuild console to create the webhook.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codebuild.*;
 ProjectTriggersProperty projectTriggersProperty = ProjectTriggersProperty.builder()
         .buildType("buildType")
         .filterGroups(List.of(List.of(WebhookFilterProperty.builder()
                 .pattern("pattern")
                 .type("type")
                 // the properties below are optional
                 .excludeMatchedPattern(false)
                 .build())))
         .pullRequestBuildPolicy(PullRequestBuildPolicyProperty.builder()
                 .requiresCommentApproval("requiresCommentApproval")
                 // the properties below are optional
                 .approverRoles(List.of("approverRoles"))
                 .build())
         .scopeConfiguration(ScopeConfigurationProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .domain("domain")
                 .scope("scope")
                 .build())
         .webhook(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProject.ProjectTriggersProperty.Builder	A builder for CfnProject.ProjectTriggersProperty
static final class	CfnProject.ProjectTriggersProperty.Jsii$Proxy	An implementation for CfnProject.ProjectTriggersProperty

Method Summary

Modifier and Type	Method	Description
static CfnProject.ProjectTriggersProperty.Builder	builder()
default String	getBuildType()	Specifies the type of build this webhook will trigger.
default Object	getFilterGroups()	A list of lists of WebhookFilter objects used to determine which webhook events are triggered.
default Object	getPullRequestBuildPolicy()	Returns union: either IResolvable or CfnProject.PullRequestBuildPolicyProperty
default Object	getScopeConfiguration()	Contains configuration information about the scope for a webhook.
default Object	getWebhook()	Specifies whether or not to begin automatically rebuilding the source code every time a code change is pushed to the repository.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBuildType

@Stability(Stable)
@Nullable
default String getBuildType()

Specifies the type of build this webhook will trigger. Allowed values are:.

• BUILD - A single build
• BUILD_BATCH - A batch build

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-buildtype

getFilterGroups

@Stability(Stable)
@Nullable
default Object getFilterGroups()

A list of lists of WebhookFilter objects used to determine which webhook events are triggered.

At least one WebhookFilter in the array must specify EVENT as its type.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or Listinvalid input: '<'either IResolvable or CfnProject.WebhookFilterProperty>>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-filtergroups

getPullRequestBuildPolicy

@Stability(Stable)
@Nullable
default Object getPullRequestBuildPolicy()

Returns union: either IResolvable or CfnProject.PullRequestBuildPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-pullrequestbuildpolicy

getScopeConfiguration

@Stability(Stable)
@Nullable
default Object getScopeConfiguration()

Contains configuration information about the scope for a webhook.

Returns union: either IResolvable or CfnProject.ScopeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-scopeconfiguration

getWebhook

@Stability(Stable)
@Nullable
default Object getWebhook()

Specifies whether or not to begin automatically rebuilding the source code every time a code change is pushed to the repository.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-webhook

builder

@Stability(Stable)
static CfnProject.ProjectTriggersProperty.Builder builder()

Returns:

a CfnProject.ProjectTriggersProperty.Builder of CfnProject.ProjectTriggersProperty