Show / Hide Table of Contents

Class CfnUsageLimitProps

Properties for defining a CfnUsageLimit.

Inheritance
object
CfnUsageLimitProps
Implements
ICfnUsageLimitProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUsageLimitProps : ICfnUsageLimitProps
Syntax (vb)
Public Class CfnUsageLimitProps Implements ICfnUsageLimitProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Redshift;

             var cfnUsageLimitProps = new CfnUsageLimitProps {
                 Amount = 123,
                 ClusterIdentifier = "clusterIdentifier",
                 FeatureType = "featureType",
                 LimitType = "limitType",

                 // the properties below are optional
                 BreachAction = "breachAction",
                 Period = "period",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnUsageLimitProps()

Properties for defining a CfnUsageLimit.

Properties

Amount

The limit amount.

BreachAction

The action that Amazon Redshift takes when the limit is reached.

ClusterIdentifier

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

FeatureType

The Amazon Redshift feature that you want to limit.

LimitType

The type of limit.

Period

The time period that the amount applies to.

Tags

A list of tag instances.

Constructors

CfnUsageLimitProps()

Properties for defining a CfnUsageLimit.

public CfnUsageLimitProps()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Redshift;

             var cfnUsageLimitProps = new CfnUsageLimitProps {
                 Amount = 123,
                 ClusterIdentifier = "clusterIdentifier",
                 FeatureType = "featureType",
                 LimitType = "limitType",

                 // the properties below are optional
                 BreachAction = "breachAction",
                 Period = "period",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Amount

The limit amount.

public double Amount { get; set; }
Property Value

double

Remarks

If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-amount

BreachAction

The action that Amazon Redshift takes when the limit is reached.

public string? BreachAction { get; set; }
Property Value

string

Remarks

The default is log.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-breachaction

ClusterIdentifier

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

public string ClusterIdentifier { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-clusteridentifier

FeatureType

The Amazon Redshift feature that you want to limit.

public string FeatureType { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-featuretype

LimitType

The type of limit.

public string LimitType { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-limittype

Period

The time period that the amount applies to.

public string? Period { get; set; }
Property Value

string

Remarks

A weekly period begins on Sunday. The default is monthly.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-period

Tags

A list of tag instances.

public ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-usagelimit.html#cfn-redshift-usagelimit-tags

Implements

ICfnUsageLimitProps
Back to top Generated by DocFX