Interface ScheduledReportInput.Builder

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

  • Method Details

    • name

      ScheduledReportInput.Builder name(String 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

      ScheduledReportInput.Builder dashboardArn(String dashboardArn)

      The ARN of the dashboard to generate the scheduled report from.

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

    • scheduledReportExecutionRoleArn

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

      ScheduledReportInput.Builder scheduleConfig(ScheduleConfig scheduleConfig)

      The schedule configuration that defines when and how often the report is generated. If the schedule state is not specified, it defaults to ENABLED.

      Parameters:
      scheduleConfig - The schedule configuration that defines when and how often the report is generated. If the schedule state is not specified, it defaults to ENABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleConfig

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

      The schedule configuration that defines when and how often the report is generated. If the schedule state is not specified, it defaults to ENABLED.

      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

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

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

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

      ScheduledReportInput.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 ScheduledReportInput.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: