Package software.amazon.awscdk.services.codebuild

Interface CfnProject.ScopeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProject.ScopeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnProject

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

Contains configuration information about the scope for a 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.*;
 ScopeConfigurationProperty scopeConfigurationProperty = ScopeConfigurationProperty.builder()
         .name("name")
         // the properties below are optional
         .domain("domain")
         .scope("scope")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnProject.ScopeConfigurationProperty.Builder	builder()
default String	getDomain()	The domain of the GitHub Enterprise organization or the GitLab Self Managed group.
String	getName()	The name of either the enterprise or organization that will send webhook events to CodeBuild , depending on if the webhook is a global or organization webhook respectively.
default String	getScope()	The type of scope for a GitHub or GitLab webhook.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of either the enterprise or organization that will send webhook events to CodeBuild , depending on if the webhook is a global or organization webhook respectively.

See Also:

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

getDomain

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

The domain of the GitHub Enterprise organization or the GitLab Self Managed group.

Note that this parameter is only required if your project's source type is GITHUB_ENTERPRISE or GITLAB_SELF_MANAGED.

See Also:

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

getScope

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

The type of scope for a GitHub or GitLab webhook.

The scope default is GITHUB_ORGANIZATION.

See Also:

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

builder

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

Returns:

a CfnProject.ScopeConfigurationProperty.Builder of CfnProject.ScopeConfigurationProperty