Interface CreateDashboardRequest.Builder

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

  • Method Details

    • name

      CreateDashboardRequest.Builder name(String name)

      The name of the dashboard. The name must be unique to your account.

      To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.

      Parameters:
      name - The name of the dashboard. The name must be unique to your account.

      To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.

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

    • refreshSchedule

      CreateDashboardRequest.Builder refreshSchedule(RefreshSchedule refreshSchedule)

      The refresh schedule configuration for the dashboard.

      To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.

      Parameters:
      refreshSchedule - The refresh schedule configuration for the dashboard.

      To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.

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

    • refreshSchedule

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

      The refresh schedule configuration for the dashboard.

      To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.

      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:

    • tagsList

      CreateDashboardRequest.Builder tagsList(Collection<Tag> tagsList)
      Sets the value of the TagsList property for this object.
      Parameters:
      tagsList - The new value for the TagsList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagsList

      CreateDashboardRequest.Builder tagsList(Tag... tagsList)
      Sets the value of the TagsList property for this object.
      Parameters:
      tagsList - The new value for the TagsList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagsList

      CreateDashboardRequest.Builder tagsList(Consumer<Tag.Builder>... tagsList)
      Sets the value of the TagsList property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

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

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

    • terminationProtectionEnabled

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

    • widgets

      CreateDashboardRequest.Builder widgets(Collection<RequestWidget> widgets)

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

      You do not need to specify widgets for the Highlights dashboard.

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

      You do not need to specify widgets for the Highlights dashboard.

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

    • widgets

      CreateDashboardRequest.Builder widgets(RequestWidget... widgets)

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

      You do not need to specify widgets for the Highlights dashboard.

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

      You do not need to specify widgets for the Highlights dashboard.

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

    • widgets

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

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

      You do not need to specify widgets for the Highlights dashboard.

      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:

    • overrideConfiguration

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

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