Class: AWSCDK::CodeBuild::CfnReportGroupProps

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

Overview

Properties for defining a CfnReportGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(export_config:, type:, delete_reports: nil, name: nil, tags: nil) ⇒ CfnReportGroupProps

Returns a new instance of CfnReportGroupProps.

Parameters:

  • export_config (AWSCDK::IResolvable, AWSCDK::CodeBuild::CfnReportGroup::ReportExportConfigProperty) —

    Information about the destination where the raw data of this ReportGroup is exported.

  • type (String) —

    The type of the ReportGroup . This can be one of the following values:.

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

    When deleting a report group, specifies if reports within the report group should be deleted.

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

    The name of the ReportGroup .

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of tag key and value pairs associated with this report group.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'code_build/cfn_report_group_props.rb', line 14

def initialize(export_config:, type:, delete_reports: nil, name: nil, tags: nil)
  @export_config = export_config.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnReportGroup::ReportExportConfigProperty.new(**export_config.transform_keys(&:to_sym)) : export_config
  Jsii::Type.check_type(@export_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuUmVwb3J0R3JvdXAuUmVwb3J0RXhwb3J0Q29uZmlnUHJvcGVydHkifV19fQ==")), "exportConfig")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @delete_reports = delete_reports
  Jsii::Type.check_type(@delete_reports, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deleteReports") unless @delete_reports.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#delete_reports ⇒ Boolean, ... (readonly)

When deleting a report group, specifies if reports within the report group should be deleted.

  • true - Deletes any reports that belong to the report group before deleting the report group.
  • false - You must delete any reports in the report group. This is the default value. If you delete a report group that contains one or more reports, an exception is thrown.

Returns:

See Also:



47
48
49
 
# File 'code_build/cfn_report_group_props.rb', line 47

def delete_reports
  @delete_reports
end

#export_config ⇒ AWSCDK::IResolvable, AWSCDK::CodeBuild::CfnReportGroup::ReportExportConfigProperty (readonly)

Information about the destination where the raw data of this ReportGroup is exported.

Returns:

See Also:



31
32
33
 
# File 'code_build/cfn_report_group_props.rb', line 31

def export_config
  @export_config
end

#name ⇒ String? (readonly)

The name of the ReportGroup .

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'code_build/cfn_report_group_props.rb', line 52

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of tag key and value pairs associated with this report group.

These tags are available for use by AWS services that support AWS CodeBuild report group tags.

Returns:

See Also:



59
60
61
 
# File 'code_build/cfn_report_group_props.rb', line 59

def tags
  @tags
end

#type ⇒ String (readonly)

The type of the ReportGroup . This can be one of the following values:.

  • CODE_COVERAGE - The report group contains code coverage reports.
  • TEST - The report group contains test reports.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'code_build/cfn_report_group_props.rb', line 39

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
 
# File 'code_build/cfn_report_group_props.rb', line 61

def self.jsii_properties
  {
    :export_config => "exportConfig",
    :type => "type",
    :delete_reports => "deleteReports",
    :name => "name",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'code_build/cfn_report_group_props.rb', line 71

def to_jsii
  result = {}
  result.merge!({
    "exportConfig" => @export_config,
    "type" => @type,
    "deleteReports" => @delete_reports,
    "name" => @name,
    "tags" => @tags,
  })
  result.compact
end