Package software.amazon.awscdk.services.redshift

Class CfnUsageLimit.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.CfnUsageLimit.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUsageLimit>

Enclosing class:

CfnUsageLimit

@Stability(Stable)
public static final class CfnUsageLimit.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUsageLimit>

A fluent builder for CfnUsageLimit.

Method Summary

Modifier and Type	Method	Description
CfnUsageLimit.Builder	amount(Number amount)	The limit amount.
CfnUsageLimit.Builder	breachAction(String breachAction)	The action that Amazon Redshift takes when the limit is reached.
CfnUsageLimit	build()
CfnUsageLimit.Builder	clusterIdentifier(String clusterIdentifier)	The identifier of the cluster that you want to limit usage.
static CfnUsageLimit.Builder	create(software.constructs.Construct scope, String id)
CfnUsageLimit.Builder	featureType(String featureType)	The Amazon Redshift feature that you want to limit.
CfnUsageLimit.Builder	limitType(String limitType)	The type of limit.
CfnUsageLimit.Builder	period(String period)	The time period that the amount applies to.
CfnUsageLimit.Builder	tags(List<? extends CfnTag> tags)	A list of tag instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnUsageLimit.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnUsageLimit.Builder.

amount

@Stability(Stable)
public CfnUsageLimit.Builder amount(Number amount)

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.

Parameters:

amount - The limit amount. This parameter is required.

Returns:

this

See Also:

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

clusterIdentifier

@Stability(Stable)
public CfnUsageLimit.Builder clusterIdentifier(String clusterIdentifier)

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

Parameters:

clusterIdentifier - The identifier of the cluster that you want to limit usage. This parameter is required.

Returns:

this

See Also:

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

featureType

@Stability(Stable)
public CfnUsageLimit.Builder featureType(String featureType)

The Amazon Redshift feature that you want to limit.

Parameters:

featureType - The Amazon Redshift feature that you want to limit. This parameter is required.

Returns:

this

See Also:

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

limitType

@Stability(Stable)
public CfnUsageLimit.Builder limitType(String limitType)

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.

Parameters:

limitType - The type of limit. This parameter is required.

Returns:

this

See Also:

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

breachAction

@Stability(Stable)
public CfnUsageLimit.Builder breachAction(String breachAction)

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

The default is log.

Parameters:

breachAction - The action that Amazon Redshift takes when the limit is reached. This parameter is required.

Returns:

this

See Also:

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

period

@Stability(Stable)
public CfnUsageLimit.Builder period(String period)

The time period that the amount applies to.

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

Parameters:

period - The time period that the amount applies to. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnUsageLimit.Builder tags(List<? extends CfnTag> tags)

A list of tag instances.

Parameters:

tags - A list of tag instances. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUsageLimit build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUsageLimit>

Returns:

a newly built instance of CfnUsageLimit.