UsageLimit class
Creates a new Amazon Redshift Serverless Usage Limit.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.redshiftserverless.Workgroup("example", {
namespaceName: exampleAwsRedshiftserverlessNamespace.namespaceName,
workgroupName: "example",
});
const exampleUsageLimit = new aws.redshiftserverless.UsageLimit("example", {
resourceArn: example.arn,
usageType: "serverless-compute",
amount: 60,
});
import pulumi
import pulumi_aws as aws
example = aws.redshiftserverless.Workgroup("example",
namespace_name=example_aws_redshiftserverless_namespace["namespaceName"],
workgroup_name="example")
example_usage_limit = aws.redshiftserverless.UsageLimit("example",
resource_arn=example.arn,
usage_type="serverless-compute",
amount=60)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.RedshiftServerless.Workgroup("example", new()
{
NamespaceName = exampleAwsRedshiftserverlessNamespace.NamespaceName,
WorkgroupName = "example",
});
var exampleUsageLimit = new Aws.RedshiftServerless.UsageLimit("example", new()
{
ResourceArn = example.Arn,
UsageType = "serverless-compute",
Amount = 60,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/redshiftserverless"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := redshiftserverless.NewWorkgroup(ctx, "example", &redshiftserverless.WorkgroupArgs{
NamespaceName: pulumi.Any(exampleAwsRedshiftserverlessNamespace.NamespaceName),
WorkgroupName: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = redshiftserverless.NewUsageLimit(ctx, "example", &redshiftserverless.UsageLimitArgs{
ResourceArn: example.Arn,
UsageType: pulumi.String("serverless-compute"),
Amount: pulumi.Int(60),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_redshiftserverless_workgroup" "example" {
namespace_name = exampleAwsRedshiftserverlessNamespace.namespaceName
workgroup_name = "example"
}
resource "aws_redshiftserverless_usagelimit" "example" {
resource_arn = aws_redshiftserverless_workgroup.example.arn
usage_type = "serverless-compute"
amount = 60
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshiftserverless.Workgroup;
import com.pulumi.aws.redshiftserverless.WorkgroupArgs;
import com.pulumi.aws.redshiftserverless.UsageLimit;
import com.pulumi.aws.redshiftserverless.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 Workgroup("example", WorkgroupArgs.builder()
.namespaceName(exampleAwsRedshiftserverlessNamespace.namespaceName())
.workgroupName("example")
.build());
var exampleUsageLimit = new UsageLimit("exampleUsageLimit", UsageLimitArgs.builder()
.resourceArn(example.arn())
.usageType("serverless-compute")
.amount(60)
.build());
}
}
resources:
example:
type: aws:redshiftserverless:Workgroup
properties:
namespaceName: ${exampleAwsRedshiftserverlessNamespace.namespaceName}
workgroupName: example
exampleUsageLimit:
type: aws:redshiftserverless:UsageLimit
name: example
properties:
resourceArn: ${example.arn}
usageType: serverless-compute
amount: 60
Import
Using pulumi import, import Redshift Serverless Usage Limits using the id. For example:
$ pulumi import aws:redshiftserverless/usageLimit:UsageLimit example example-id
Constructors
- UsageLimit(String name, {UsageLimitArgs? args, CustomResourceOptions? options})
-
Creates a new UsageLimit.
nameThe Pulumi resource name.argsArguments used to configure this UsageLimit. The set of arguments for UsageLimit.optionsResource 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 Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.
latefinal
-
arn
↔ Output<
String> -
ARN of the Redshift Serverless Usage Limit.
latefinal
-
breachAction
↔ Output<
String?> -
The action that Amazon Redshift Serverless takes when the limit is reached. Valid values are
log,emit-metric, anddeactivate. The default islog.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
period
↔ Output<
String?> -
The time period that the amount applies to. A weekly period begins on Sunday. Valid values are
daily,weekly, andmonthly. The default ismonthly.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceArn
↔ Output<
String> -
ARN of the Amazon Redshift Serverless resource to create the usage limit for.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
usageType
↔ Output<
String> -
The type of Amazon Redshift Serverless usage to create a usage limit for. Valid values are
serverless-computeorcross-region-datasharing.latefinal
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
nameandid.