Package software.amazon.awscdk.services.redshift

Class CfnUsageLimit

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.redshift.CfnUsageLimit
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IUsageLimitRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:59.726Z") @Stability(Stable) public class CfnUsageLimit extends CfnResource implements IInspectable, IUsageLimitRef, ITaggableV2
Resource Type definition for AWS::Redshift::UsageLimit.

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.*;
 CfnUsageLimit cfnUsageLimit = CfnUsageLimit.Builder.create(this, "MyCfnUsageLimit")
         .amount(123)
         .clusterIdentifier("clusterIdentifier")
         .featureType("featureType")
         .limitType("limitType")
         // the properties below are optional
         .breachAction("breachAction")
         .period("period")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUsageLimit

      protected CfnUsageLimit(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUsageLimit

      protected CfnUsageLimit(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUsageLimit

      @Stability(Stable) public CfnUsageLimit(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUsageLimitProps props)
      Create a new AWS::Redshift::UsageLimit.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForUsageLimit

      @Stability(Stable) @NotNull public static String arnForUsageLimit(@NotNull IUsageLimitRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnUsageLimit

      @Stability(Stable) @NotNull public static Boolean isCfnUsageLimit(@NotNull Object x)
      Checks whether the given object is a CfnUsageLimit.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the usage limit.

    • getAttrUsageLimitId

      @Stability(Stable) @NotNull public String getAttrUsageLimitId()
      The identifier of the usage limit.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getUsageLimitRef

      @Stability(Stable) @NotNull public UsageLimitReference getUsageLimitRef()
      A reference to a UsageLimit resource.
      Specified by:
      getUsageLimitRef in interface IUsageLimitRef

    • getAmount

      @Stability(Stable) @NotNull public Number getAmount()
      The limit amount.

    • setAmount

      @Stability(Stable) public void setAmount(@NotNull Number value)
      The limit amount.

    • getClusterIdentifier

      @Stability(Stable) @NotNull public String getClusterIdentifier()
      The identifier of the cluster that you want to limit usage.

    • setClusterIdentifier

      @Stability(Stable) public void setClusterIdentifier(@NotNull String value)
      The identifier of the cluster that you want to limit usage.

    • getFeatureType

      @Stability(Stable) @NotNull public String getFeatureType()
      The Amazon Redshift feature that you want to limit.

    • setFeatureType

      @Stability(Stable) public void setFeatureType(@NotNull String value)
      The Amazon Redshift feature that you want to limit.

    • getLimitType

      @Stability(Stable) @NotNull public String getLimitType()
      The type of limit.

    • setLimitType

      @Stability(Stable) public void setLimitType(@NotNull String value)
      The type of limit.

    • getBreachAction

      @Stability(Stable) @Nullable public String getBreachAction()
      The action that Amazon Redshift takes when the limit is reached.

    • setBreachAction

      @Stability(Stable) public void setBreachAction(@Nullable String value)
      The action that Amazon Redshift takes when the limit is reached.

    • getPeriod

      @Stability(Stable) @Nullable public String getPeriod()
      The time period that the amount applies to.

    • setPeriod

      @Stability(Stable) public void setPeriod(@Nullable String value)
      The time period that the amount applies to.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tag instances.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tag instances.