Interface UpdateDashboardRequest.Builder

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

  • Method Details

    • dashboardId

      UpdateDashboardRequest.Builder dashboardId(String dashboardId)

      The name or ARN of the dashboard.

      Parameters:
      dashboardId - The name or ARN of the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widgets

      UpdateDashboardRequest.Builder widgets(Collection<RequestWidget> widgets)

      An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

      To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

      To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

      Parameters:
      widgets - An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

      To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

      To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widgets

      UpdateDashboardRequest.Builder widgets(RequestWidget... widgets)

      An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

      To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

      To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

      Parameters:
      widgets - An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

      To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

      To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widgets

      UpdateDashboardRequest.Builder widgets(Consumer<RequestWidget.Builder>... widgets)

      An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

      To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

      To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to widgets(List<RequestWidget>).

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

    • refreshSchedule

      UpdateDashboardRequest.Builder refreshSchedule(RefreshSchedule refreshSchedule)

      The refresh schedule configuration for the dashboard.

      Parameters:
      refreshSchedule - The refresh schedule configuration for the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • refreshSchedule

      default UpdateDashboardRequest.Builder refreshSchedule(Consumer<RefreshSchedule.Builder> refreshSchedule)

      The refresh schedule configuration for the dashboard.

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

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

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

    • terminationProtectionEnabled

      UpdateDashboardRequest.Builder terminationProtectionEnabled(Boolean terminationProtectionEnabled)

      Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

      Parameters:
      terminationProtectionEnabled - Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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