Interface PutDashboardRequest.Builder

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

  • Method Details

    • dashboardName

      PutDashboardRequest.Builder dashboardName(String dashboardName)

      The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.

      Parameters:
      dashboardName - The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dashboardBody

      PutDashboardRequest.Builder dashboardBody(String dashboardBody)

      The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

      For more information about the syntax, see Dashboard Body Structure and Syntax.

      Parameters:
      dashboardBody - The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

      For more information about the syntax, see Dashboard Body Structure and Syntax.

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

    • tags

      PutDashboardRequest.Builder tags(Collection<Tag> tags)

      A list of key-value pairs to associate with the dashboard. You can associate as many as 50 tags with a dashboard.

      Tags can help you organize and categorize your dashboards. You can also use them to scope user permissions by granting a user permission to access or change only dashboards with certain tag values.

      You can use this parameter only when creating a new dashboard. If you specify Tags when updating an existing dashboard, the tag updates are ignored. To add or update tags on an existing dashboard, use TagResource. To remove tags, use UntagResource.

      Parameters:
      tags - A list of key-value pairs to associate with the dashboard. You can associate as many as 50 tags with a dashboard.

      Tags can help you organize and categorize your dashboards. You can also use them to scope user permissions by granting a user permission to access or change only dashboards with certain tag values.

      You can use this parameter only when creating a new dashboard. If you specify Tags when updating an existing dashboard, the tag updates are ignored. To add or update tags on an existing dashboard, use TagResource. To remove tags, use UntagResource.

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

    • tags

      PutDashboardRequest.Builder tags(Tag... tags)

      A list of key-value pairs to associate with the dashboard. You can associate as many as 50 tags with a dashboard.

      Tags can help you organize and categorize your dashboards. You can also use them to scope user permissions by granting a user permission to access or change only dashboards with certain tag values.

      You can use this parameter only when creating a new dashboard. If you specify Tags when updating an existing dashboard, the tag updates are ignored. To add or update tags on an existing dashboard, use TagResource. To remove tags, use UntagResource.

      Parameters:
      tags - A list of key-value pairs to associate with the dashboard. You can associate as many as 50 tags with a dashboard.

      Tags can help you organize and categorize your dashboards. You can also use them to scope user permissions by granting a user permission to access or change only dashboards with certain tag values.

      You can use this parameter only when creating a new dashboard. If you specify Tags when updating an existing dashboard, the tag updates are ignored. To add or update tags on an existing dashboard, use TagResource. To remove tags, use UntagResource.

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

    • tags

      PutDashboardRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of key-value pairs to associate with the dashboard. You can associate as many as 50 tags with a dashboard.

      Tags can help you organize and categorize your dashboards. You can also use them to scope user permissions by granting a user permission to access or change only dashboards with certain tag values.

      You can use this parameter only when creating a new dashboard. If you specify Tags when updating an existing dashboard, the tag updates are ignored. To add or update tags on an existing dashboard, use TagResource. To remove tags, use UntagResource.

      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 tags(List<Tag>).

      Parameters:
      tags - 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:

    • overrideConfiguration

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

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