Class: AWSCDK::CodeBuild::CfnProject::ScopeConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CodeBuild::CfnProject::ScopeConfigurationProperty

Defined in:

code_build/cfn_project.rb

Overview

Contains configuration information about the scope for a webhook.

See Also:

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

Instance Attribute Summary

• #domain ⇒ String^? readonly

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

• #name ⇒ String readonly

  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.

• #scope ⇒ String^? readonly

  The type of scope for a GitHub or GitLab webhook.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, domain: nil, scope: nil) ⇒ ScopeConfigurationProperty constructor

  A new instance of ScopeConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, domain: nil, scope: nil) ⇒ ScopeConfigurationProperty

Returns a new instance of ScopeConfigurationProperty.

Parameters:

• name (String) —

  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.

• domain (String, nil) (defaults to: nil) —

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

• scope (String, nil) (defaults to: nil) —

  The type of scope for a GitHub or GitLab webhook.

# File 'code_build/cfn_project.rb', line 2127

def initialize(name:, domain: nil, scope: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain") unless @domain.nil?
  @scope = scope
  Jsii::Type.check_type(@scope, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scope") unless @scope.nil?
end

Instance Attribute Details

#domain ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

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

# File 'code_build/cfn_project.rb', line 2147

def domain
  @domain
end

#name ⇒ String (readonly)

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.

Returns:

• (String)

See Also:

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

# File 'code_build/cfn_project.rb', line 2140

def name
  @name
end

#scope ⇒ String^? (readonly)

The type of scope for a GitHub or GitLab webhook.

The scope default is GITHUB_ORGANIZATION.

Returns:

• (String, nil)

See Also:

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

# File 'code_build/cfn_project.rb', line 2154

def scope
  @scope
end

Class Method Details

.jsii_properties ⇒ Object

# File 'code_build/cfn_project.rb', line 2156

def self.jsii_properties
  {
    :name => "name",
    :domain => "domain",
    :scope => "scope",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'code_build/cfn_project.rb', line 2164

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "domain" => @domain,
    "scope" => @scope,
  })
  result.compact
end