Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. redshift
  5. UsageLimit

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

aws.redshift.UsageLimit

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

    Creates a new Amazon Redshift Usage Limit.

    Example Usage

    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 = aws_redshift_cluster.Example.Id,
        FeatureType = "concurrency-scaling",
        LimitType = "time",
        Amount = 60,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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(aws_redshift_cluster.Example.Id),
			FeatureType:       pulumi.String("concurrency-scaling"),
			LimitType:         pulumi.String("time"),
			Amount:            pulumi.Int(60),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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(aws_redshift_cluster.example().id())
            .featureType("concurrency-scaling")
            .limitType("time")
            .amount(60)
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.redshift.UsageLimit("example",
    cluster_identifier=aws_redshift_cluster["example"]["id"],
    feature_type="concurrency-scaling",
    limit_type="time",
    amount=60)

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshift.UsageLimit("example", {
    clusterIdentifier: aws_redshift_cluster.example.id,
    featureType: "concurrency-scaling",
    limitType: "time",
    amount: 60,
});

    resources:
  example:
    type: aws:redshift:UsageLimit
    properties:
      clusterIdentifier: ${aws_redshift_cluster.example.id}
      featureType: concurrency-scaling
      limitType: time
      amount: 60

    Create UsageLimit Resource

    new UsageLimit(name: string, args: UsageLimitArgs, opts?: CustomResourceOptions);
    @overload
def UsageLimit(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               amount: Optional[int] = 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)
@overload
def UsageLimit(resource_name: str,
               args: UsageLimitArgs,
               opts: Optional[ResourceOptions] = 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.
    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

    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.

    ClusterIdentifier string

    The identifier of the cluster that you want to limit usage.

    FeatureType string

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    LimitType 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 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. Valid values are data-scanned, and time.

    BreachAction string

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    Period string

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

    ClusterIdentifier string

    The identifier of the cluster that you want to limit usage.

    FeatureType string

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    LimitType 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 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. Valid values are data-scanned, and time.

    BreachAction string

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    Period string

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

    clusterIdentifier String

    The identifier of the cluster that you want to limit usage.

    featureType String

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    limitType 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 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. Valid values are data-scanned, and time.

    breachAction String

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    period String

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

    clusterIdentifier string

    The identifier of the cluster that you want to limit usage.

    featureType string

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    limitType 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 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. Valid values are data-scanned, and time.

    breachAction string

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    period string

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

    tags {[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, and cross-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 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. Valid values are data-scanned, and time.

    breach_action str

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    period str

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

    clusterIdentifier String

    The identifier of the cluster that you want to limit usage.

    featureType String

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    limitType 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 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. Valid values are data-scanned, and time.

    breachAction String

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    period String

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

    tags 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:

    Arn string

    Amazon Resource Name (ARN) of the Redshift Usage Limit.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Arn string

    Amazon Resource Name (ARN) of the Redshift Usage Limit.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    Amazon Resource Name (ARN) of the Redshift Usage Limit.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn string

    Amazon Resource Name (ARN) of the Redshift Usage Limit.

    id string

    The provider-assigned unique ID for this managed resource.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn str

    Amazon Resource Name (ARN) of the Redshift Usage Limit.

    id str

    The provider-assigned unique ID for this managed resource.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    Amazon Resource Name (ARN) of the Redshift Usage Limit.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    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.
    The following state arguments are supported:
    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.

    BreachAction string

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    ClusterIdentifier string

    The identifier of the cluster that you want to limit usage.

    FeatureType string

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    LimitType 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 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. Valid values are data-scanned, and time.

    Period string

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

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

    BreachAction string

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    ClusterIdentifier string

    The identifier of the cluster that you want to limit usage.

    FeatureType string

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    LimitType 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 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. Valid values are data-scanned, and time.

    Period string

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

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

    breachAction String

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    clusterIdentifier String

    The identifier of the cluster that you want to limit usage.

    featureType String

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    limitType 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 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. Valid values are data-scanned, and time.

    period String

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

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

    breachAction string

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    clusterIdentifier string

    The identifier of the cluster that you want to limit usage.

    featureType string

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    limitType 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 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. Valid values are data-scanned, and time.

    period string

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

    tags {[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.

    tagsAll {[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 are log, emit-metric, and disable.

    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, and cross-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 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. Valid values are data-scanned, and time.

    period str

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

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

    breachAction String

    The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.

    clusterIdentifier String

    The identifier of the cluster that you want to limit usage.

    featureType String

    The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.

    limitType 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 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. Valid values are data-scanned, and time.

    period String

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. Valid values are daily, weekly, and monthly.

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

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Import

    Redshift usage limits can be imported using the id, e.g.,

     $ pulumi import aws:redshift/usageLimit:UsageLimit example example-id

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
    pulumi/pulumi-aws