Class: AWSCDK::Backup::CfnReportPlan::ReportDeliveryChannelProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
backup/cfn_report_plan.rb

Overview

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(s3_bucket_name:, formats: nil, s3_key_prefix: nil) ⇒ ReportDeliveryChannelProperty

Returns a new instance of ReportDeliveryChannelProperty.

Parameters:

  • s3_bucket_name (String) —

    The unique name of the S3 bucket that receives your reports.

  • formats (Array<String>, nil) (defaults to: nil) —

    The format of your reports: CSV , JSON , or both.

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

    The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3.



579
580
581
582
583
584
585
586
 
# File 'backup/cfn_report_plan.rb', line 579

def initialize(s3_bucket_name:, formats: nil, s3_key_prefix: nil)
  @s3_bucket_name = s3_bucket_name
  Jsii::Type.check_type(@s3_bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketName")
  @formats = formats
  Jsii::Type.check_type(@formats, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "formats") unless @formats.nil?
  @s3_key_prefix = s3_key_prefix
  Jsii::Type.check_type(@s3_key_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3KeyPrefix") unless @s3_key_prefix.nil?
end

Instance Attribute Details

#formats ⇒ Array<String>? (readonly)

The format of your reports: CSV , JSON , or both.

If not specified, the default format is CSV .

Returns:

  • (Array<String>, nil)

See Also:



599
600
601
 
# File 'backup/cfn_report_plan.rb', line 599

def formats
  @formats
end

#s3_bucket_name ⇒ String (readonly)

The unique name of the S3 bucket that receives your reports.

Returns:

  • (String)

See Also:



592
593
594
 
# File 'backup/cfn_report_plan.rb', line 592

def s3_bucket_name
  @s3_bucket_name
end

#s3_key_prefix ⇒ String? (readonly)

The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3.

The prefix is this part of the following path: s3://your-bucket-name/ prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

Returns:

  • (String, nil)

See Also:



606
607
608
 
# File 'backup/cfn_report_plan.rb', line 606

def s3_key_prefix
  @s3_key_prefix
end

Class Method Details

.jsii_properties ⇒ Object 



608
609
610
611
612
613
614
 
# File 'backup/cfn_report_plan.rb', line 608

def self.jsii_properties
  {
    :s3_bucket_name => "s3BucketName",
    :formats => "formats",
    :s3_key_prefix => "s3KeyPrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



616
617
618
619
620
621
622
623
624
 
# File 'backup/cfn_report_plan.rb', line 616

def to_jsii
  result = {}
  result.merge!({
    "s3BucketName" => @s3_bucket_name,
    "formats" => @formats,
    "s3KeyPrefix" => @s3_key_prefix,
  })
  result.compact
end