Interface UpdateScheduledReportRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BcmDashboardsRequest.Builder, Buildable, CopyableBuilder<UpdateScheduledReportRequest.Builder,UpdateScheduledReportRequest>, SdkBuilder<UpdateScheduledReportRequest.Builder,UpdateScheduledReportRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateScheduledReportRequest
@Mutable @NotThreadSafe public static interface UpdateScheduledReportRequest.Builder extends BcmDashboardsRequest.Builder, SdkPojo, CopyableBuilder<UpdateScheduledReportRequest.Builder,UpdateScheduledReportRequest>

  • Method Details

    • arn

      UpdateScheduledReportRequest.Builder arn(String arn)

      The ARN of the scheduled report to update.

      Parameters:
      arn - The ARN of the scheduled report to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UpdateScheduledReportRequest.Builder name(String name)

      The new name for the scheduled report.

      Parameters:
      name - The new name for the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateScheduledReportRequest.Builder description(String description)

      The new description for the scheduled report.

      Parameters:
      description - The new description for the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dashboardArn

      UpdateScheduledReportRequest.Builder dashboardArn(String dashboardArn)

      The ARN of the dashboard to associate with the scheduled report.

      Parameters:
      dashboardArn - The ARN of the dashboard to associate with the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduledReportExecutionRoleArn

      UpdateScheduledReportRequest.Builder scheduledReportExecutionRoleArn(String scheduledReportExecutionRoleArn)

      The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.

      Parameters:
      scheduledReportExecutionRoleArn - The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleConfig

      UpdateScheduledReportRequest.Builder scheduleConfig(ScheduleConfig scheduleConfig)

      The updated schedule configuration for the report.

      Parameters:
      scheduleConfig - The updated schedule configuration for the report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleConfig

      default UpdateScheduledReportRequest.Builder scheduleConfig(Consumer<ScheduleConfig.Builder> scheduleConfig)

      The updated schedule configuration for the report.

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

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

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

    • widgetIds

      UpdateScheduledReportRequest.Builder widgetIds(Collection<String> widgetIds)

      The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.

      Parameters:
      widgetIds - The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widgetIds

      UpdateScheduledReportRequest.Builder widgetIds(String... widgetIds)

      The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.

      Parameters:
      widgetIds - The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widgetDateRangeOverride

      UpdateScheduledReportRequest.Builder widgetDateRangeOverride(DateTimeRange widgetDateRangeOverride)

      The date range override to apply to widgets in the scheduled report.

      Parameters:
      widgetDateRangeOverride - The date range override to apply to widgets in the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widgetDateRangeOverride

      default UpdateScheduledReportRequest.Builder widgetDateRangeOverride(Consumer<DateTimeRange.Builder> widgetDateRangeOverride)

      The date range override to apply to widgets in the scheduled report.

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

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

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

    • clearWidgetIds

      UpdateScheduledReportRequest.Builder clearWidgetIds(Boolean clearWidgetIds)

      Set to true to clear existing widgetIds.

      Parameters:
      clearWidgetIds - Set to true to clear existing widgetIds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clearWidgetDateRangeOverride

      UpdateScheduledReportRequest.Builder clearWidgetDateRangeOverride(Boolean clearWidgetDateRangeOverride)

      Set to true to clear existing widgetDateRangeOverride.

      Parameters:
      clearWidgetDateRangeOverride - Set to true to clear existing widgetDateRangeOverride.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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