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

Interface CreateReportPlanRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<CreateReportPlanRequest.Builder,CreateReportPlanRequest>, SdkBuilder<CreateReportPlanRequest.Builder,CreateReportPlanRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateReportPlanRequest
public static interface CreateReportPlanRequest.Builder extends BackupRequest.Builder, SdkPojo, CopyableBuilder<CreateReportPlanRequest.Builder,CreateReportPlanRequest>

  • Method Details

    • 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.

    • reportDeliveryChannel

      default CreateReportPlanRequest.Builder reportDeliveryChannel(Consumer<ReportDeliveryChannel.Builder> 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.

      This is a convenience method that creates an instance of the ReportDeliveryChannel.Builder avoiding the need to create one manually via ReportDeliveryChannel.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reportDeliveryChannel(ReportDeliveryChannel).

      Parameters:
      reportDeliveryChannel - a consumer that will call methods on ReportDeliveryChannel.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • reportSetting

      default CreateReportPlanRequest.Builder reportSetting(Consumer<ReportSetting.Builder> 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.

      This is a convenience method that creates an instance of the ReportSetting.Builder avoiding the need to create one manually via ReportSetting.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reportSetting(ReportSetting).

      Parameters:
      reportSetting - a consumer that will call methods on ReportSetting.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • overrideConfiguration

      CreateReportPlanRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateReportPlanRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.