aws.redshift.UsageLimit
Explore with Pulumi AI
Creates a new Amazon Redshift Usage Limit.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.redshift.UsageLimit("example", {
clusterIdentifier: exampleAwsRedshiftCluster.id,
featureType: "concurrency-scaling",
limitType: "time",
amount: 60,
});
import pulumi
import pulumi_aws as aws
example = aws.redshift.UsageLimit("example",
cluster_identifier=example_aws_redshift_cluster["id"],
feature_type="concurrency-scaling",
limit_type="time",
amount=60)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshift"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := redshift.NewUsageLimit(ctx, "example", &redshift.UsageLimitArgs{
ClusterIdentifier: pulumi.Any(exampleAwsRedshiftCluster.Id),
FeatureType: pulumi.String("concurrency-scaling"),
LimitType: pulumi.String("time"),
Amount: pulumi.Int(60),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.RedShift.UsageLimit("example", new()
{
ClusterIdentifier = exampleAwsRedshiftCluster.Id,
FeatureType = "concurrency-scaling",
LimitType = "time",
Amount = 60,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.UsageLimit;
import com.pulumi.aws.redshift.UsageLimitArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new UsageLimit("example", UsageLimitArgs.builder()
.clusterIdentifier(exampleAwsRedshiftCluster.id())
.featureType("concurrency-scaling")
.limitType("time")
.amount(60)
.build());
}
}
resources:
example:
type: aws:redshift:UsageLimit
properties:
clusterIdentifier: ${exampleAwsRedshiftCluster.id}
featureType: concurrency-scaling
limitType: time
amount: 60
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[int] = None,
cluster_identifier: Optional[str] = None,
feature_type: Optional[str] = None,
limit_type: Optional[str] = None,
breach_action: Optional[str] = None,
period: Optional[str] = None,
tags: Optional[Mapping[str, str]] = 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:redshift:UsageLimit
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
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.
Constructor example
The following reference example uses placeholder values for all input properties.
var usageLimitResource = new Aws.RedShift.UsageLimit("usageLimitResource", new()
{
Amount = 0,
ClusterIdentifier = "string",
FeatureType = "string",
LimitType = "string",
BreachAction = "string",
Period = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := redshift.NewUsageLimit(ctx, "usageLimitResource", &redshift.UsageLimitArgs{
Amount: pulumi.Int(0),
ClusterIdentifier: pulumi.String("string"),
FeatureType: pulumi.String("string"),
LimitType: pulumi.String("string"),
BreachAction: pulumi.String("string"),
Period: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var usageLimitResource = new UsageLimit("usageLimitResource", UsageLimitArgs.builder()
.amount(0)
.clusterIdentifier("string")
.featureType("string")
.limitType("string")
.breachAction("string")
.period("string")
.tags(Map.of("string", "string"))
.build());
usage_limit_resource = aws.redshift.UsageLimit("usageLimitResource",
amount=0,
cluster_identifier="string",
feature_type="string",
limit_type="string",
breach_action="string",
period="string",
tags={
"string": "string",
})
const usageLimitResource = new aws.redshift.UsageLimit("usageLimitResource", {
amount: 0,
clusterIdentifier: "string",
featureType: "string",
limitType: "string",
breachAction: "string",
period: "string",
tags: {
string: "string",
},
});
type: aws:redshift:UsageLimit
properties:
amount: 0
breachAction: string
clusterIdentifier: string
featureType: string
limitType: string
period: string
tags:
string: string
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
The UsageLimit resource accepts the following input properties:
- Amount int
- 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 string - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - Limit
Type string - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - Breach
Action string - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - Period string
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Amount int
- 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 string - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - Limit
Type string - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - Breach
Action string - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - Period string
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - map[string]string
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- amount Integer
- 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 String - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - limit
Type String - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - breach
Action String - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - period String
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - Map<String,String>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- 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 string - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - limit
Type string - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - breach
Action string - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - period string
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- amount int
- 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 str - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - limit_
type str - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - breach_
action str - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - period str
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- 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 String - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - limit
Type String - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - breach
Action String - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - period String
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - Map<String>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the UsageLimit resource produces the following output properties:
Look up Existing UsageLimit Resource
Get an existing UsageLimit resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: UsageLimitState, opts?: CustomResourceOptions): UsageLimit
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
amount: Optional[int] = None,
arn: Optional[str] = None,
breach_action: Optional[str] = None,
cluster_identifier: Optional[str] = None,
feature_type: Optional[str] = None,
limit_type: Optional[str] = None,
period: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> UsageLimit
func GetUsageLimit(ctx *Context, name string, id IDInput, state *UsageLimitState, opts ...ResourceOption) (*UsageLimit, error)
public static UsageLimit Get(string name, Input<string> id, UsageLimitState? state, CustomResourceOptions? opts = null)
public static UsageLimit get(String name, Output<String> id, UsageLimitState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Amount int
- 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.
- Arn string
- Amazon Resource Name (ARN) of the Redshift Usage Limit.
- Breach
Action string - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - Cluster
Identifier string - The identifier of the cluster that you want to limit usage.
- Feature
Type string - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - Limit
Type string - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - Period string
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Amount int
- 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.
- Arn string
- Amazon Resource Name (ARN) of the Redshift Usage Limit.
- Breach
Action string - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - Cluster
Identifier string - The identifier of the cluster that you want to limit usage.
- Feature
Type string - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - Limit
Type string - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - Period string
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - map[string]string
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- amount Integer
- 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.
- arn String
- Amazon Resource Name (ARN) of the Redshift Usage Limit.
- breach
Action String - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - cluster
Identifier String - The identifier of the cluster that you want to limit usage.
- feature
Type String - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - limit
Type String - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - period String
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - Map<String,String>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- arn string
- Amazon Resource Name (ARN) of the Redshift Usage Limit.
- breach
Action string - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - cluster
Identifier string - The identifier of the cluster that you want to limit usage.
- feature
Type string - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - limit
Type string - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - period string
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- amount int
- 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.
- arn str
- Amazon Resource Name (ARN) of the Redshift Usage Limit.
- breach_
action str - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - cluster_
identifier str - The identifier of the cluster that you want to limit usage.
- feature_
type str - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - limit_
type str - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - period str
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- arn String
- Amazon Resource Name (ARN) of the Redshift Usage Limit.
- breach
Action String - The action that Amazon Redshift takes when the limit is reached. The default is
log
. Valid values arelog
,emit-metric
, anddisable
. - cluster
Identifier String - The identifier of the cluster that you want to limit usage.
- feature
Type String - The Amazon Redshift feature that you want to limit. Valid values are
spectrum
,concurrency-scaling
, andcross-region-datasharing
. - limit
Type String - 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 bedata-scanned
. If FeatureType isconcurrency-scaling
, then LimitType must betime
. If FeatureType iscross-region-datasharing
, then LimitType must bedata-scanned
. Valid values aredata-scanned
, andtime
. - period String
- The time period that the amount applies to. A weekly period begins on Sunday. The default is
monthly
. Valid values aredaily
,weekly
, andmonthly
. - Map<String>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Import
Using pulumi import
, import Redshift usage limits using the id
. For example:
$ pulumi import aws:redshift/usageLimit:UsageLimit example example-id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.