Package software.amazon.awscdk.cfnpropertymixins.services.redshift

Class CfnUsageLimitPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.redshift.CfnUsageLimitPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUsageLimitPropsMixin>

Enclosing class:

CfnUsageLimitPropsMixin

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

A fluent builder for CfnUsageLimitPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnUsageLimitPropsMixin.Builder	amount(Number amount)	The limit amount.
CfnUsageLimitPropsMixin.Builder	breachAction(String breachAction)	The action that Amazon Redshift takes when the limit is reached.
CfnUsageLimitPropsMixin	build()
CfnUsageLimitPropsMixin.Builder	clusterIdentifier(String clusterIdentifier)	The identifier of the cluster that you want to limit usage.
static CfnUsageLimitPropsMixin.Builder	create()
static CfnUsageLimitPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnUsageLimitPropsMixin.Builder	featureType(String featureType)	The Amazon Redshift feature that you want to limit.
CfnUsageLimitPropsMixin.Builder	limitType(String limitType)	The type of limit.
CfnUsageLimitPropsMixin.Builder	period(String period)	The time period that the amount applies to.
CfnUsageLimitPropsMixin.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 CfnUsageLimitPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnUsageLimitPropsMixin.Builder.

create

@Stability(Stable)
public static CfnUsageLimitPropsMixin.Builder create()

Returns:

a new instance of CfnUsageLimitPropsMixin.Builder.

amount

@Stability(Stable)
public CfnUsageLimitPropsMixin.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

breachAction

@Stability(Stable)
public CfnUsageLimitPropsMixin.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

clusterIdentifier

@Stability(Stable)
public CfnUsageLimitPropsMixin.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 CfnUsageLimitPropsMixin.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 CfnUsageLimitPropsMixin.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

period

@Stability(Stable)
public CfnUsageLimitPropsMixin.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 CfnUsageLimitPropsMixin.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 CfnUsageLimitPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnUsageLimitPropsMixin.