Class: AWSCDK::Backup::CfnReportPlan::ReportSettingProperty

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

Overview

Contains detailed information about a report setting.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(report_template:, accounts: nil, framework_arns: nil, organization_units: nil, regions: nil) ⇒ ReportSettingProperty

Returns a new instance of ReportSettingProperty.

Parameters:

  • report_template (String) —

    Identifies the report template for the report. Reports are built using a report template. The report templates are:.

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

    These are the accounts to be included in the report.

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

    The Amazon Resource Names (ARNs) of the frameworks a report covers.

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

    These are the Organizational Units to be included in the report.

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

    These are the Regions to be included in the report.



638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'backup/cfn_report_plan.rb', line 638

def initialize(report_template:, accounts: nil, framework_arns: nil, organization_units: nil, regions: nil)
  @report_template = report_template
  Jsii::Type.check_type(@report_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "reportTemplate")
  @accounts = accounts
  Jsii::Type.check_type(@accounts, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "accounts") unless @accounts.nil?
  @framework_arns = framework_arns
  Jsii::Type.check_type(@framework_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "frameworkArns") unless @framework_arns.nil?
  @organization_units = organization_units
  Jsii::Type.check_type(@organization_units, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "organizationUnits") unless @organization_units.nil?
  @regions = regions
  Jsii::Type.check_type(@regions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "regions") unless @regions.nil?
end

Instance Attribute Details

#accounts ⇒ Array<String>? (readonly)

These are the accounts to be included in the report.

Use string value of ROOT to include all organizational units.

Returns:

  • (Array<String>, nil)

See Also:



664
665
666
 
# File 'backup/cfn_report_plan.rb', line 664

def accounts
  @accounts
end

#framework_arns ⇒ Array<String>? (readonly)

The Amazon Resource Names (ARNs) of the frameworks a report covers.

Returns:

  • (Array<String>, nil)

See Also:



669
670
671
 
# File 'backup/cfn_report_plan.rb', line 669

def framework_arns
  @framework_arns
end

#organization_units ⇒ Array<String>? (readonly)

These are the Organizational Units to be included in the report.

Returns:

  • (Array<String>, nil)

See Also:



674
675
676
 
# File 'backup/cfn_report_plan.rb', line 674

def organization_units
  @organization_units
end

#regions ⇒ Array<String>? (readonly)

These are the Regions to be included in the report.

Use the wildcard as the string value to include all Regions.

Returns:

  • (Array<String>, nil)

See Also:



681
682
683
 
# File 'backup/cfn_report_plan.rb', line 681

def regions
  @regions
end

#report_template ⇒ String (readonly)

Identifies the report template for the report. Reports are built using a report template. The report templates are:.

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT

Returns:

  • (String)

See Also:



657
658
659
 
# File 'backup/cfn_report_plan.rb', line 657

def report_template
  @report_template
end

Class Method Details

.jsii_properties ⇒ Object 



683
684
685
686
687
688
689
690
691
 
# File 'backup/cfn_report_plan.rb', line 683

def self.jsii_properties
  {
    :report_template => "reportTemplate",
    :accounts => "accounts",
    :framework_arns => "frameworkArns",
    :organization_units => "organizationUnits",
    :regions => "regions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



693
694
695
696
697
698
699
700
701
702
703
 
# File 'backup/cfn_report_plan.rb', line 693

def to_jsii
  result = {}
  result.merge!({
    "reportTemplate" => @report_template,
    "accounts" => @accounts,
    "frameworkArns" => @framework_arns,
    "organizationUnits" => @organization_units,
    "regions" => @regions,
  })
  result.compact
end