1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. redshift
  6. UsageLimit

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi

    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.

    Create UsageLimit Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UsageLimit(name: string, args: UsageLimitArgs, opts?: CustomResourceOptions);
    @overload
    def UsageLimit(resource_name: str,
                   args: UsageLimitArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def UsageLimit(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   amount: Optional[float] = None,
                   cluster_identifier: Optional[str] = None,
                   feature_type: Optional[UsageLimitFeatureType] = None,
                   limit_type: Optional[UsageLimitLimitType] = None,
                   breach_action: Optional[UsageLimitBreachAction] = None,
                   period: Optional[UsageLimitPeriod] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewUsageLimit(ctx *Context, name string, args UsageLimitArgs, opts ...ResourceOption) (*UsageLimit, error)
    public UsageLimit(string name, UsageLimitArgs args, CustomResourceOptions? opts = null)
    public UsageLimit(String name, UsageLimitArgs args)
    public UsageLimit(String name, UsageLimitArgs args, CustomResourceOptions options)
    
    type: aws-native:redshift:UsageLimit
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_redshift_usage_limit" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args UsageLimitArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UsageLimitArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UsageLimitArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UsageLimitArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UsageLimitArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    UsageLimit Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UsageLimit resource accepts the following input properties:

    Amount double
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
    ClusterIdentifier string
    The identifier of the cluster that you want to limit usage.
    FeatureType Pulumi.AwsNative.Redshift.UsageLimitFeatureType
    The Amazon Redshift feature that you want to limit.
    LimitType Pulumi.AwsNative.Redshift.UsageLimitLimitType
    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.
    BreachAction Pulumi.AwsNative.Redshift.UsageLimitBreachAction
    The action that Amazon Redshift takes when the limit is reached. The default is log.
    Period Pulumi.AwsNative.Redshift.UsageLimitPeriod
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tag instances.
    Amount float64
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
    ClusterIdentifier string
    The identifier of the cluster that you want to limit usage.
    FeatureType UsageLimitFeatureType
    The Amazon Redshift feature that you want to limit.
    LimitType UsageLimitLimitType
    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.
    BreachAction UsageLimitBreachAction
    The action that Amazon Redshift takes when the limit is reached. The default is log.
    Period UsageLimitPeriod
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    Tags TagArgs
    A list of tag instances.
    amount number
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
    cluster_identifier string
    The identifier of the cluster that you want to limit usage.
    feature_type "spectrum" | "concurrency-scaling" | "cross-region-datasharing" | "extra-compute-for-automatic-optimization"
    The Amazon Redshift feature that you want to limit.
    limit_type "time" | "data-scanned"
    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.
    breach_action "log" | "emit-metric" | "disable"
    The action that Amazon Redshift takes when the limit is reached. The default is log.
    period "daily" | "weekly" | "monthly"
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    tags list(object)
    A list of tag instances.
    amount Double
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
    clusterIdentifier String
    The identifier of the cluster that you want to limit usage.
    featureType UsageLimitFeatureType
    The Amazon Redshift feature that you want to limit.
    limitType UsageLimitLimitType
    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.
    breachAction UsageLimitBreachAction
    The action that Amazon Redshift takes when the limit is reached. The default is log.
    period UsageLimitPeriod
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    tags List<Tag>
    A list of tag instances.
    amount number
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
    clusterIdentifier string
    The identifier of the cluster that you want to limit usage.
    featureType UsageLimitFeatureType
    The Amazon Redshift feature that you want to limit.
    limitType UsageLimitLimitType
    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.
    breachAction UsageLimitBreachAction
    The action that Amazon Redshift takes when the limit is reached. The default is log.
    period UsageLimitPeriod
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    tags Tag[]
    A list of tag instances.
    amount float
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
    cluster_identifier str
    The identifier of the cluster that you want to limit usage.
    feature_type UsageLimitFeatureType
    The Amazon Redshift feature that you want to limit.
    limit_type UsageLimitLimitType
    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.
    breach_action UsageLimitBreachAction
    The action that Amazon Redshift takes when the limit is reached. The default is log.
    period UsageLimitPeriod
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    tags Sequence[TagArgs]
    A list of tag instances.
    amount Number
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
    clusterIdentifier String
    The identifier of the cluster that you want to limit usage.
    featureType "spectrum" | "concurrency-scaling" | "cross-region-datasharing" | "extra-compute-for-automatic-optimization"
    The Amazon Redshift feature that you want to limit.
    limitType "time" | "data-scanned"
    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.
    breachAction "log" | "emit-metric" | "disable"
    The action that Amazon Redshift takes when the limit is reached. The default is log.
    period "daily" | "weekly" | "monthly"
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    tags List<Property Map>
    A list of tag instances.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UsageLimit resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the usage limit.
    Id string
    The provider-assigned unique ID for this managed resource.
    UsageLimitId string
    The identifier of the usage limit.
    Arn string
    The Amazon Resource Name (ARN) of the usage limit.
    Id string
    The provider-assigned unique ID for this managed resource.
    UsageLimitId string
    The identifier of the usage limit.
    arn string
    The Amazon Resource Name (ARN) of the usage limit.
    id string
    The provider-assigned unique ID for this managed resource.
    usage_limit_id string
    The identifier of the usage limit.
    arn String
    The Amazon Resource Name (ARN) of the usage limit.
    id String
    The provider-assigned unique ID for this managed resource.
    usageLimitId String
    The identifier of the usage limit.
    arn string
    The Amazon Resource Name (ARN) of the usage limit.
    id string
    The provider-assigned unique ID for this managed resource.
    usageLimitId string
    The identifier of the usage limit.
    arn str
    The Amazon Resource Name (ARN) of the usage limit.
    id str
    The provider-assigned unique ID for this managed resource.
    usage_limit_id str
    The identifier of the usage limit.
    arn String
    The Amazon Resource Name (ARN) of the usage limit.
    id String
    The provider-assigned unique ID for this managed resource.
    usageLimitId String
    The identifier of the usage limit.

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    UsageLimitBreachAction, UsageLimitBreachActionArgs

    Log
    log
    EmitMetric
    emit-metric
    Disable
    disable
    UsageLimitBreachActionLog
    log
    UsageLimitBreachActionEmitMetric
    emit-metric
    UsageLimitBreachActionDisable
    disable
    "log"
    log
    "emit-metric"
    emit-metric
    "disable"
    disable
    Log
    log
    EmitMetric
    emit-metric
    Disable
    disable
    Log
    log
    EmitMetric
    emit-metric
    Disable
    disable
    LOG
    log
    EMIT_METRIC
    emit-metric
    DISABLE
    disable
    "log"
    log
    "emit-metric"
    emit-metric
    "disable"
    disable

    UsageLimitFeatureType, UsageLimitFeatureTypeArgs

    Spectrum
    spectrum
    ConcurrencyScaling
    concurrency-scaling
    CrossRegionDatasharing
    cross-region-datasharing
    ExtraComputeForAutomaticOptimization
    extra-compute-for-automatic-optimization
    UsageLimitFeatureTypeSpectrum
    spectrum
    UsageLimitFeatureTypeConcurrencyScaling
    concurrency-scaling
    UsageLimitFeatureTypeCrossRegionDatasharing
    cross-region-datasharing
    UsageLimitFeatureTypeExtraComputeForAutomaticOptimization
    extra-compute-for-automatic-optimization
    "spectrum"
    spectrum
    "concurrency-scaling"
    concurrency-scaling
    "cross-region-datasharing"
    cross-region-datasharing
    "extra-compute-for-automatic-optimization"
    extra-compute-for-automatic-optimization
    Spectrum
    spectrum
    ConcurrencyScaling
    concurrency-scaling
    CrossRegionDatasharing
    cross-region-datasharing
    ExtraComputeForAutomaticOptimization
    extra-compute-for-automatic-optimization
    Spectrum
    spectrum
    ConcurrencyScaling
    concurrency-scaling
    CrossRegionDatasharing
    cross-region-datasharing
    ExtraComputeForAutomaticOptimization
    extra-compute-for-automatic-optimization
    SPECTRUM
    spectrum
    CONCURRENCY_SCALING
    concurrency-scaling
    CROSS_REGION_DATASHARING
    cross-region-datasharing
    EXTRA_COMPUTE_FOR_AUTOMATIC_OPTIMIZATION
    extra-compute-for-automatic-optimization
    "spectrum"
    spectrum
    "concurrency-scaling"
    concurrency-scaling
    "cross-region-datasharing"
    cross-region-datasharing
    "extra-compute-for-automatic-optimization"
    extra-compute-for-automatic-optimization

    UsageLimitLimitType, UsageLimitLimitTypeArgs

    Time
    time
    DataScanned
    data-scanned
    UsageLimitLimitTypeTime
    time
    UsageLimitLimitTypeDataScanned
    data-scanned
    "time"
    time
    "data-scanned"
    data-scanned
    Time
    time
    DataScanned
    data-scanned
    Time
    time
    DataScanned
    data-scanned
    TIME
    time
    DATA_SCANNED
    data-scanned
    "time"
    time
    "data-scanned"
    data-scanned

    UsageLimitPeriod, UsageLimitPeriodArgs

    Daily
    daily
    Weekly
    weekly
    Monthly
    monthly
    UsageLimitPeriodDaily
    daily
    UsageLimitPeriodWeekly
    weekly
    UsageLimitPeriodMonthly
    monthly
    "daily"
    daily
    "weekly"
    weekly
    "monthly"
    monthly
    Daily
    daily
    Weekly
    weekly
    Monthly
    monthly
    Daily
    daily
    Weekly
    weekly
    Monthly
    monthly
    DAILY
    daily
    WEEKLY
    weekly
    MONTHLY
    monthly
    "daily"
    daily
    "weekly"
    weekly
    "monthly"
    monthly

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial