Interface ScheduledReport.Builder

  • Method Details

    • arn

      The ARN of the scheduled report.

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

      The name of the scheduled report.

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

      ScheduledReport.Builder dashboardArn(String dashboardArn)

      The ARN of the dashboard associated with the scheduled report.

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

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

      ScheduledReport.Builder scheduleConfig(ScheduleConfig scheduleConfig)

      The schedule configuration that defines when and how often the report is generated.

      Parameters:
      scheduleConfig - The schedule configuration that defines when and how often the report is generated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scheduleConfig

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

      The schedule configuration that defines when and how often the report is generated.

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

      ScheduledReport.Builder description(String description)

      A description of the scheduled report's purpose or contents.

      Parameters:
      description - A description of the scheduled report's purpose or contents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • widgetIds

      ScheduledReport.Builder widgetIds(Collection<String> widgetIds)

      The list of widget identifiers included in the scheduled report.

      Parameters:
      widgetIds - The list of widget identifiers included in the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • widgetIds

      ScheduledReport.Builder widgetIds(String... widgetIds)

      The list of widget identifiers included in the scheduled report.

      Parameters:
      widgetIds - The list of widget identifiers included in the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • widgetDateRangeOverride

      ScheduledReport.Builder widgetDateRangeOverride(DateTimeRange widgetDateRangeOverride)

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

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

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

      The date range override applied 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:
    • createdAt

      ScheduledReport.Builder createdAt(Instant createdAt)

      The timestamp when the scheduled report was created.

      Parameters:
      createdAt - The timestamp when the scheduled report was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      ScheduledReport.Builder updatedAt(Instant updatedAt)

      The timestamp when the scheduled report was last modified.

      Parameters:
      updatedAt - The timestamp when the scheduled report was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lastExecutionAt

      ScheduledReport.Builder lastExecutionAt(Instant lastExecutionAt)

      The timestamp of the most recent execution of the scheduled report.

      Parameters:
      lastExecutionAt - The timestamp of the most recent execution of the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • healthStatus

      ScheduledReport.Builder healthStatus(HealthStatus healthStatus)

      The health status of the scheduled report at last refresh time.

      Parameters:
      healthStatus - The health status of the scheduled report at last refresh time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • healthStatus

      default ScheduledReport.Builder healthStatus(Consumer<HealthStatus.Builder> healthStatus)

      The health status of the scheduled report at last refresh time.

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

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

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