Class: Aws::Backup::Types::ReportDeliveryChannel

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Note:

When making an API call, you may pass ReportDeliveryChannel data as a hash:

{
  s3_bucket_name: "string", # required
  s3_key_prefix: "string",
  formats: ["string"],
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#formatsArray<String>

A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

Returns:

  • (Array<String>)


5376
5377
5378
5379
5380
5381
5382
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5376

class ReportDeliveryChannel < Struct.new(
  :s3_bucket_name,
  :s3_key_prefix,
  :formats)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_nameString

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

Returns:

  • (String)


5376
5377
5378
5379
5380
5381
5382
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5376

class ReportDeliveryChannel < Struct.new(
  :s3_bucket_name,
  :s3_key_prefix,
  :formats)
  SENSITIVE = []
  include Aws::Structure
end

#s3_key_prefixString

The prefix for where 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)


5376
5377
5378
5379
5380
5381
5382
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5376

class ReportDeliveryChannel < Struct.new(
  :s3_bucket_name,
  :s3_key_prefix,
  :formats)
  SENSITIVE = []
  include Aws::Structure
end