Package software.amazon.awscdk.services.backup

Interface CfnReportPlan.ReportDeliveryChannelProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReportPlan.ReportDeliveryChannelProperty.Jsii$Proxy

Enclosing class:

CfnReportPlan

@Stability(Stable)
public static interface CfnReportPlan.ReportDeliveryChannelProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backup.*;
 ReportDeliveryChannelProperty reportDeliveryChannelProperty = ReportDeliveryChannelProperty.builder()
         .s3BucketName("s3BucketName")
         // the properties below are optional
         .formats(List.of("formats"))
         .s3KeyPrefix("s3KeyPrefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnReportPlan.ReportDeliveryChannelProperty.Builder	A builder for CfnReportPlan.ReportDeliveryChannelProperty
static final class	CfnReportPlan.ReportDeliveryChannelProperty.Jsii$Proxy	An implementation for CfnReportPlan.ReportDeliveryChannelProperty

Method Summary

Modifier and Type	Method	Description
static CfnReportPlan.ReportDeliveryChannelProperty.Builder	builder()
default List<String>	getFormats()	The format of your reports: CSV , JSON , or both.
String	getS3BucketName()	The unique name of the S3 bucket that receives your reports.
default String	getS3KeyPrefix()	The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3BucketName

@Stability(Stable)
@NotNull
String getS3BucketName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html#cfn-backup-reportplan-reportdeliverychannel-s3bucketname

getFormats

@Stability(Stable)
@Nullable
default List<String> getFormats()

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

If not specified, the default format is CSV .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html#cfn-backup-reportplan-reportdeliverychannel-formats

getS3KeyPrefix

@Stability(Stable)
@Nullable
default String getS3KeyPrefix()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html#cfn-backup-reportplan-reportdeliverychannel-s3keyprefix

builder

@Stability(Stable)
static CfnReportPlan.ReportDeliveryChannelProperty.Builder builder()

Returns:

a CfnReportPlan.ReportDeliveryChannelProperty.Builder of CfnReportPlan.ReportDeliveryChannelProperty