Package software.amazon.awssdk.services.redshift.model

Interface UsageLimit.Builder

    • Method Detail

      • usageLimitId

        UsageLimit.Builder usageLimitId​(String usageLimitId)

        The identifier of the usage limit.

        Parameters:
        usageLimitId - The identifier of the usage limit.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterIdentifier

        UsageLimit.Builder clusterIdentifier​(String clusterIdentifier)

        The identifier of the cluster with a usage limit.

        Parameters:
        clusterIdentifier - The identifier of the cluster with a usage limit.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featureType

        UsageLimit.Builder featureType​(String featureType)

        The Amazon Redshift feature to which the limit applies.

        Parameters:
        featureType - The Amazon Redshift feature to which the limit applies.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UsageLimitFeatureType, UsageLimitFeatureType

      • limitType

        UsageLimit.Builder limitType​(String limitType)

        The type of limit. Depending on the feature type, this can be based on a time duration or data size.

        Parameters:
        limitType - The type of limit. Depending on the feature type, this can be based on a time duration or data size.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UsageLimitLimitType, UsageLimitLimitType

      • limitType

        UsageLimit.Builder limitType​(UsageLimitLimitType limitType)

        The type of limit. Depending on the feature type, this can be based on a time duration or data size.

        Parameters:
        limitType - The type of limit. Depending on the feature type, this can be based on a time duration or data size.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UsageLimitLimitType, UsageLimitLimitType

      • amount

        UsageLimit.Builder amount​(Long amount)

        The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

        Parameters:
        amount - The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • period

        UsageLimit.Builder period​(String period)

        The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

        Parameters:
        period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UsageLimitPeriod, UsageLimitPeriod

      • period

        UsageLimit.Builder period​(UsageLimitPeriod period)

        The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

        Parameters:
        period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UsageLimitPeriod, UsageLimitPeriod

      • breachAction

        UsageLimit.Builder breachAction​(String breachAction)

        The action that Amazon Redshift takes when the limit is reached. Possible values are:

        • log - To log an event in a system table. The default is log.

        • emit-metric - To emit CloudWatch metrics.

        • disable - To disable the feature until the next usage period begins.

        Parameters:
        breachAction - The action that Amazon Redshift takes when the limit is reached. Possible values are:

        • log - To log an event in a system table. The default is log.

        • emit-metric - To emit CloudWatch metrics.

        • disable - To disable the feature until the next usage period begins.

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

      • breachAction

        UsageLimit.Builder breachAction​(UsageLimitBreachAction breachAction)

        The action that Amazon Redshift takes when the limit is reached. Possible values are:

        • log - To log an event in a system table. The default is log.

        • emit-metric - To emit CloudWatch metrics.

        • disable - To disable the feature until the next usage period begins.

        Parameters:
        breachAction - The action that Amazon Redshift takes when the limit is reached. Possible values are:

        • log - To log an event in a system table. The default is log.

        • emit-metric - To emit CloudWatch metrics.

        • disable - To disable the feature until the next usage period begins.

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

      • tags

        UsageLimit.Builder tags​(Collection<Tag> tags)

        A list of tag instances.

        Parameters:
        tags - A list of tag instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        UsageLimit.Builder tags​(Tag... tags)

        A list of tag instances.

        Parameters:
        tags - A list of tag instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        UsageLimit.Builder tags​(Consumer<Tag.Builder>... tags)

        A list of tag instances.

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

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