Package software.amazon.awssdk.services.backup.model

Interface CreateReportPlanRequest.Builder

    • Method Detail

      • reportPlanName

        CreateReportPlanRequest.Builder reportPlanName​(String reportPlanName)

        The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

        Parameters:
        reportPlanName - The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reportPlanDescription

        CreateReportPlanRequest.Builder reportPlanDescription​(String reportPlanDescription)

        An optional description of the report plan with a maximum of 1,024 characters.

        Parameters:
        reportPlanDescription - An optional description of the report plan with a maximum of 1,024 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reportDeliveryChannel

        CreateReportPlanRequest.Builder reportDeliveryChannel​(ReportDeliveryChannel reportDeliveryChannel)

        A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

        Parameters:
        reportDeliveryChannel - A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reportSetting

        CreateReportPlanRequest.Builder reportSetting​(ReportSetting reportSetting)

        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

        If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

        Parameters:
        reportSetting - 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

        If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reportPlanTags

        CreateReportPlanRequest.Builder reportPlanTags​(Map<String,​String> reportPlanTags)

        Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

        Parameters:
        reportPlanTags - Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • idempotencyToken

        CreateReportPlanRequest.Builder idempotencyToken​(String idempotencyToken)

        A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

        Parameters:
        idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
        Returns:
        Returns a reference to this object so that method calls can be chained together.