Interface UpdateReportPlanRequest.Builder

  • Method Details

    • reportPlanName

      UpdateReportPlanRequest.Builder reportPlanName(String reportPlanName)

      The unique name of the report plan. This name is 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. This name is 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

      UpdateReportPlanRequest.Builder reportPlanDescription(String reportPlanDescription)

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

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

      UpdateReportPlanRequest.Builder reportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel)

      The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

      Parameters:
      reportDeliveryChannel - The information about where 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 UpdateReportPlanRequest.Builder reportDeliveryChannel(Consumer<ReportDeliveryChannel.Builder> reportDeliveryChannel)

      The information about where 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

      UpdateReportPlanRequest.Builder reportSetting(ReportSetting reportSetting)

      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 - 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 UpdateReportPlanRequest.Builder reportSetting(Consumer<ReportSetting.Builder> reportSetting)

      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:
    • idempotencyToken

      UpdateReportPlanRequest.Builder idempotencyToken(String idempotencyToken)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. 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 UpdateReportPlanInput. 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

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

      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.