We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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.
- Cluster
Identifier string - The identifier of the cluster that you want to limit usage.
- Feature
Type Pulumi.Aws Native. Redshift. Usage Limit Feature Type - The Amazon Redshift feature that you want to limit.
- Limit
Type Pulumi.Aws Native. Redshift. Usage Limit Limit Type - 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 Pulumi.Aws Native. Redshift. Usage Limit Breach Action - The action that Amazon Redshift takes when the limit is reached. The default is log.
- Period
Pulumi.
Aws Native. Redshift. Usage Limit Period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
-
List<Pulumi.
Aws Native. 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.
- Cluster
Identifier string - The identifier of the cluster that you want to limit usage.
- Feature
Type UsageLimit Feature Type - The Amazon Redshift feature that you want to limit.
- Limit
Type UsageLimit Limit Type - 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 UsageLimit Breach Action - The action that Amazon Redshift takes when the limit is reached. The default is log.
- Period
Usage
Limit Period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
-
Tag
Args - 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.
- 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.
- cluster
Identifier String - The identifier of the cluster that you want to limit usage.
- feature
Type UsageLimit Feature Type - The Amazon Redshift feature that you want to limit.
- limit
Type UsageLimit Limit Type - 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 UsageLimit Breach Action - The action that Amazon Redshift takes when the limit is reached. The default is log.
- period
Usage
Limit Period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
- 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.
- cluster
Identifier string - The identifier of the cluster that you want to limit usage.
- feature
Type UsageLimit Feature Type - The Amazon Redshift feature that you want to limit.
- limit
Type UsageLimit Limit Type - 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 UsageLimit Breach Action - The action that Amazon Redshift takes when the limit is reached. The default is log.
- period
Usage
Limit Period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
- 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 UsageLimit Feature Type - The Amazon Redshift feature that you want to limit.
- limit_
type UsageLimit Limit Type - 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 UsageLimit Breach Action - The action that Amazon Redshift takes when the limit is reached. The default is log.
- period
Usage
Limit Period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
-
Sequence[Tag
Args] - 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.
- 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.
- Usage
Limit stringId - 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 stringId - 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_ stringid - 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 StringId - 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 stringId - 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_ strid - 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 StringId - The identifier of the usage limit.
Supporting Types
Tag, TagArgs
A set of tags to apply to the resource.UsageLimitBreachAction, UsageLimitBreachActionArgs
- Log
log- Emit
Metric emit-metric- Disable
disable
- Usage
Limit Breach Action Log log- Usage
Limit Breach Action Emit Metric emit-metric- Usage
Limit Breach Action Disable disable
- "log"
log- "emit-metric"
emit-metric- "disable"
disable
- Log
log- Emit
Metric emit-metric- Disable
disable
- Log
log- Emit
Metric emit-metric- Disable
disable
- LOG
log- EMIT_METRIC
emit-metric- DISABLE
disable
- "log"
log- "emit-metric"
emit-metric- "disable"
disable
UsageLimitFeatureType, UsageLimitFeatureTypeArgs
- Spectrum
spectrum- Concurrency
Scaling concurrency-scaling- Cross
Region Datasharing cross-region-datasharing- Extra
Compute For Automatic Optimization extra-compute-for-automatic-optimization
- Usage
Limit Feature Type Spectrum spectrum- Usage
Limit Feature Type Concurrency Scaling concurrency-scaling- Usage
Limit Feature Type Cross Region Datasharing cross-region-datasharing- Usage
Limit Feature Type 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
- 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
- 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- Data
Scanned data-scanned
- Usage
Limit Limit Type Time time- Usage
Limit Limit Type Data Scanned data-scanned
- "time"
time- "data-scanned"
data-scanned
- Time
time- Data
Scanned data-scanned
- Time
time- Data
Scanned data-scanned
- TIME
time- DATA_SCANNED
data-scanned
- "time"
time- "data-scanned"
data-scanned
UsageLimitPeriod, UsageLimitPeriodArgs
- Daily
daily- Weekly
weekly- Monthly
monthly
- Usage
Limit Period Daily daily- Usage
Limit Period Weekly weekly- Usage
Limit Period 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
- "daily"
daily- "weekly"
weekly- "monthly"
monthly
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi