UsageLimit class

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)
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_redshift_usagelimit" "example" {
  cluster_identifier = exampleAwsRedshiftCluster.id
  feature_type       = "concurrency-scaling"
  limit_type         = "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.ArrayList;
import java.util.Arrays;
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

Import

Using pulumi import, import Redshift usage limits using the id. For example:

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

Constructors

UsageLimit(String name, {UsageLimitArgs? args, CustomResourceOptions? options})
Creates a new UsageLimit. name The Pulumi resource name. args Arguments used to configure this UsageLimit. The set of arguments for UsageLimit. options Resource options controlling this resource's behavior.
UsageLimit.reference(String urn)
Creates a typed reference to an existing UsageLimit resource.

Properties

amount ↔ Output<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.
latefinal
arn ↔ Output<String>
ARN of the Redshift Usage Limit.
latefinal
breachAction ↔ Output<String?>
The action that Amazon Redshift takes when the limit is reached. The default is log. Valid values are log, emit-metric, and disable.
latefinal
childResources → Set<Resource>
finalinherited
clusterIdentifier ↔ Output<String>
The identifier of the cluster that you want to limit usage.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
featureType ↔ Output<String>
The Amazon Redshift feature that you want to limit. Valid values are spectrum, concurrency-scaling, and cross-region-datasharing.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
limitType ↔ Output<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.
latefinal
period ↔ Output<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.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {UsageLimitState? state, CustomResourceOptions? options}) → UsageLimit
Gets an existing UsageLimit resource's state with the given name and id.