Class: AWSCDK::CodeBuild::CfnProject::ProjectBuildBatchConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
code_build/cfn_project.rb

Overview

Contains configuration information about a batch build project.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(batch_report_mode: nil, combine_artifacts: nil, restrictions: nil, service_role: nil, timeout_in_mins: nil) ⇒ ProjectBuildBatchConfigProperty

Returns a new instance of ProjectBuildBatchConfigProperty.

Parameters:

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

    Specifies how build status reports are sent to the source provider for the batch build.

  • combine_artifacts (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies if the build artifacts for the batch build should be combined into a single artifact location.

  • restrictions (AWSCDK::IResolvable, AWSCDK::CodeBuild::CfnProject::BatchRestrictionsProperty, nil) (defaults to: nil) —

    A BatchRestrictions object that specifies the restrictions for the batch build.

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

    Specifies the service role ARN for the batch build project.

  • timeout_in_mins (Numeric, nil) (defaults to: nil) —

    Specifies the maximum amount of time, in minutes, that the batch build must be completed in.



1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'code_build/cfn_project.rb', line 1561

def initialize(batch_report_mode: nil, combine_artifacts: nil, restrictions: nil, service_role: nil, timeout_in_mins: nil)
  @batch_report_mode = batch_report_mode
  Jsii::Type.check_type(@batch_report_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "batchReportMode") unless @batch_report_mode.nil?
  @combine_artifacts = combine_artifacts
  Jsii::Type.check_type(@combine_artifacts, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "combineArtifacts") unless @combine_artifacts.nil?
  @restrictions = restrictions.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnProject::BatchRestrictionsProperty.new(**restrictions.transform_keys(&:to_sym)) : restrictions
  Jsii::Type.check_type(@restrictions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUHJvamVjdC5CYXRjaFJlc3RyaWN0aW9uc1Byb3BlcnR5In1dfX0=")), "restrictions") unless @restrictions.nil?
  @service_role = service_role
  Jsii::Type.check_type(@service_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceRole") unless @service_role.nil?
  @timeout_in_mins = timeout_in_mins
  Jsii::Type.check_type(@timeout_in_mins, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeoutInMins") unless @timeout_in_mins.nil?
end

Instance Attribute Details

#batch_report_mode ⇒ String? (readonly)

Specifies how build status reports are sent to the source provider for the batch build.

This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.

  • REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
  • REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.

Returns:

  • (String, nil)

See Also:



1583
1584
1585
 
# File 'code_build/cfn_project.rb', line 1583

def batch_report_mode
  @batch_report_mode
end

#combine_artifacts ⇒ Boolean, ... (readonly)

Specifies if the build artifacts for the batch build should be combined into a single artifact location.

Returns:

See Also:



1588
1589
1590
 
# File 'code_build/cfn_project.rb', line 1588

def combine_artifacts
  @combine_artifacts
end

#restrictions ⇒ AWSCDK::IResolvable, ... (readonly)

A BatchRestrictions object that specifies the restrictions for the batch build.

Returns:

See Also:



1593
1594
1595
 
# File 'code_build/cfn_project.rb', line 1593

def restrictions
  @restrictions
end

#service_role ⇒ String? (readonly)

Specifies the service role ARN for the batch build project.

Returns:

  • (String, nil)

See Also:



1598
1599
1600
 
# File 'code_build/cfn_project.rb', line 1598

def service_role
  @service_role
end

#timeout_in_mins ⇒ Numeric? (readonly)

Specifies the maximum amount of time, in minutes, that the batch build must be completed in.

Returns:

  • (Numeric, nil)

See Also:



1603
1604
1605
 
# File 'code_build/cfn_project.rb', line 1603

def timeout_in_mins
  @timeout_in_mins
end

Class Method Details

.jsii_properties ⇒ Object 



1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'code_build/cfn_project.rb', line 1605

def self.jsii_properties
  {
    :batch_report_mode => "batchReportMode",
    :combine_artifacts => "combineArtifacts",
    :restrictions => "restrictions",
    :service_role => "serviceRole",
    :timeout_in_mins => "timeoutInMins",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
 
# File 'code_build/cfn_project.rb', line 1615

def to_jsii
  result = {}
  result.merge!({
    "batchReportMode" => @batch_report_mode,
    "combineArtifacts" => @combine_artifacts,
    "restrictions" => @restrictions,
    "serviceRole" => @service_role,
    "timeoutInMins" => @timeout_in_mins,
  })
  result.compact
end