Package software.amazon.awssdk.services.cloudtrail.model

Interface CreateDashboardRequest.Builder

    • Method Detail

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

      • 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).

        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:
        #tagsList(java.util.Collection)

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