Class: AWSCDK::CodeBuild::CfnReportGroup::S3ReportExportConfigProperty

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

Overview

Information about the S3 bucket where the raw data of a report are exported.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket:, bucket_owner: nil, encryption_disabled: nil, encryption_key: nil, packaging: nil, path: nil) ⇒ S3ReportExportConfigProperty

Returns a new instance of S3ReportExportConfigProperty.

Parameters:

  • bucket (String) —

    The name of the S3 bucket where the raw data of a report are exported.

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

    The AWS account identifier of the owner of the Amazon S3 bucket.

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

    A boolean value that specifies if the results of a report are encrypted.

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

    The encryption key for the report's encrypted raw data.

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

    The type of build output artifact to create. Valid values include:.

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

    The path to the exported report's raw data results.



631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'code_build/cfn_report_group.rb', line 631

def initialize(bucket:, bucket_owner: nil, encryption_disabled: nil, encryption_key: nil, packaging: nil, path: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucket")
  @bucket_owner = bucket_owner
  Jsii::Type.check_type(@bucket_owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketOwner") unless @bucket_owner.nil?
  @encryption_disabled = encryption_disabled
  Jsii::Type.check_type(@encryption_disabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "encryptionDisabled") unless @encryption_disabled.nil?
  @encryption_key = encryption_key
  Jsii::Type.check_type(@encryption_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionKey") unless @encryption_key.nil?
  @packaging = packaging
  Jsii::Type.check_type(@packaging, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "packaging") unless @packaging.nil?
  @path = path
  Jsii::Type.check_type(@path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless @path.nil?
end

Instance Attribute Details

#bucket ⇒ String (readonly)

The name of the S3 bucket where the raw data of a report are exported.

Returns:

  • (String)

See Also:



650
651
652
 
# File 'code_build/cfn_report_group.rb', line 650

def bucket
  @bucket
end

#bucket_owner ⇒ String? (readonly)

The AWS account identifier of the owner of the Amazon S3 bucket.

This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.

Returns:

  • (String, nil)

See Also:



657
658
659
 
# File 'code_build/cfn_report_group.rb', line 657

def bucket_owner
  @bucket_owner
end

#encryption_disabled ⇒ Boolean, ... (readonly)

A boolean value that specifies if the results of a report are encrypted.

Returns:

See Also:



662
663
664
 
# File 'code_build/cfn_report_group.rb', line 662

def encryption_disabled
  @encryption_disabled
end

#encryption_key ⇒ String? (readonly)

The encryption key for the report's encrypted raw data.

Returns:

  • (String, nil)

See Also:



667
668
669
 
# File 'code_build/cfn_report_group.rb', line 667

def encryption_key
  @encryption_key
end

#packaging ⇒ String? (readonly)

The type of build output artifact to create. Valid values include:.

  • NONE : CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
  • ZIP : CodeBuild creates a ZIP file with the raw data in the output bucket.

Returns:

  • (String, nil)

See Also:



675
676
677
 
# File 'code_build/cfn_report_group.rb', line 675

def packaging
  @packaging
end

#path ⇒ String? (readonly)

The path to the exported report's raw data results.

Returns:

  • (String, nil)

See Also:



680
681
682
 
# File 'code_build/cfn_report_group.rb', line 680

def path
  @path
end

Class Method Details

.jsii_properties ⇒ Object 



682
683
684
685
686
687
688
689
690
691
 
# File 'code_build/cfn_report_group.rb', line 682

def self.jsii_properties
  {
    :bucket => "bucket",
    :bucket_owner => "bucketOwner",
    :encryption_disabled => "encryptionDisabled",
    :encryption_key => "encryptionKey",
    :packaging => "packaging",
    :path => "path",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'code_build/cfn_report_group.rb', line 693

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "bucketOwner" => @bucket_owner,
    "encryptionDisabled" => @encryption_disabled,
    "encryptionKey" => @encryption_key,
    "packaging" => @packaging,
    "path" => @path,
  })
  result.compact
end