Package software.amazon.awscdk.cfnpropertymixins.services.redshiftserverless

Class CfnWorkgroupPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.redshiftserverless.CfnWorkgroupPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWorkgroupPropsMixin>

Enclosing class:

CfnWorkgroupPropsMixin

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

A fluent builder for CfnWorkgroupPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnWorkgroupPropsMixin.Builder	baseCapacity(Number baseCapacity)	The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
CfnWorkgroupPropsMixin	build()
CfnWorkgroupPropsMixin.Builder	configParameters(List<? extends Object> configParameters)	The key of the parameter.
CfnWorkgroupPropsMixin.Builder	configParameters(IResolvable configParameters)	The key of the parameter.
static CfnWorkgroupPropsMixin.Builder	create()
static CfnWorkgroupPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnWorkgroupPropsMixin.Builder	enhancedVpcRouting(Boolean enhancedVpcRouting)	The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
CfnWorkgroupPropsMixin.Builder	enhancedVpcRouting(IResolvable enhancedVpcRouting)	The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
CfnWorkgroupPropsMixin.Builder	maxCapacity(Number maxCapacity)	The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
CfnWorkgroupPropsMixin.Builder	namespaceName(String namespaceName)	The namespace the workgroup is associated with.
CfnWorkgroupPropsMixin.Builder	port(Number port)	The custom port to use when connecting to a workgroup.
CfnWorkgroupPropsMixin.Builder	pricePerformanceTarget(CfnWorkgroupPropsMixin.PerformanceTargetProperty pricePerformanceTarget)	An object that represents the price performance target settings for the workgroup.
CfnWorkgroupPropsMixin.Builder	pricePerformanceTarget(IResolvable pricePerformanceTarget)	An object that represents the price performance target settings for the workgroup.
CfnWorkgroupPropsMixin.Builder	publiclyAccessible(Boolean publiclyAccessible)	A value that specifies whether the workgroup can be accessible from a public network.
CfnWorkgroupPropsMixin.Builder	publiclyAccessible(IResolvable publiclyAccessible)	A value that specifies whether the workgroup can be accessible from a public network.
CfnWorkgroupPropsMixin.Builder	recoveryPointId(String recoveryPointId)	The recovery point id to restore from.
CfnWorkgroupPropsMixin.Builder	securityGroupIds(List<? extends Object> securityGroupIds)	A list of security group IDs to associate with the workgroup.
CfnWorkgroupPropsMixin.Builder	snapshotArn(String snapshotArn)	The Amazon Resource Name (ARN) of the snapshot to restore from.
CfnWorkgroupPropsMixin.Builder	snapshotName(String snapshotName)	The snapshot name to restore from.
CfnWorkgroupPropsMixin.Builder	snapshotOwnerAccount(String snapshotOwnerAccount)	The Amazon Web Services account that owns the snapshot.
CfnWorkgroupPropsMixin.Builder	subnetIds(List<? extends Object> subnetIds)	A list of subnet IDs the workgroup is associated with.
CfnWorkgroupPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The map of the key-value pairs used to tag the workgroup.
CfnWorkgroupPropsMixin.Builder	trackName(String trackName)	An optional parameter for the name of the track for the workgroup.
CfnWorkgroupPropsMixin.Builder	workgroup(CfnWorkgroupPropsMixin.WorkgroupProperty workgroup)	The collection of computing resources from which an endpoint is created.
CfnWorkgroupPropsMixin.Builder	workgroup(IResolvable workgroup)	The collection of computing resources from which an endpoint is created.
CfnWorkgroupPropsMixin.Builder	workgroupName(String workgroupName)	The name of the workgroup.

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 CfnWorkgroupPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnWorkgroupPropsMixin.Builder.

create

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

Returns:

a new instance of CfnWorkgroupPropsMixin.Builder.

baseCapacity

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder baseCapacity(Number baseCapacity)

The base compute capacity of the workgroup in Redshift Processing Units (RPUs).

Parameters:

baseCapacity - The base compute capacity of the workgroup in Redshift Processing Units (RPUs). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-basecapacity

configParameters

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder configParameters(IResolvable configParameters)

The key of the parameter.

The options are auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl , and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless .

Parameters:

configParameters - The key of the parameter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters

configParameters

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder configParameters(List<? extends Object> configParameters)

The key of the parameter.

The options are auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl , and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless .

Parameters:

configParameters - The key of the parameter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters

enhancedVpcRouting

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder enhancedVpcRouting(Boolean enhancedVpcRouting)

The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

Default: - false

Parameters:

enhancedVpcRouting - The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-enhancedvpcrouting

enhancedVpcRouting

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder enhancedVpcRouting(IResolvable enhancedVpcRouting)

The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

Default: - false

Parameters:

enhancedVpcRouting - The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-enhancedvpcrouting

maxCapacity

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder maxCapacity(Number maxCapacity)

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.

The max capacity is specified in RPUs.

Parameters:

maxCapacity - The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-maxcapacity

namespaceName

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder namespaceName(String namespaceName)

The namespace the workgroup is associated with.

Parameters:

namespaceName - The namespace the workgroup is associated with. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-namespacename

port

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder port(Number port)

The custom port to use when connecting to a workgroup.

Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

Parameters:

port - The custom port to use when connecting to a workgroup. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-port

pricePerformanceTarget

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder pricePerformanceTarget(IResolvable pricePerformanceTarget)

An object that represents the price performance target settings for the workgroup.

Parameters:

pricePerformanceTarget - An object that represents the price performance target settings for the workgroup. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-priceperformancetarget

pricePerformanceTarget

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder pricePerformanceTarget(CfnWorkgroupPropsMixin.PerformanceTargetProperty pricePerformanceTarget)

An object that represents the price performance target settings for the workgroup.

Parameters:

pricePerformanceTarget - An object that represents the price performance target settings for the workgroup. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-priceperformancetarget

publiclyAccessible

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder publiclyAccessible(Boolean publiclyAccessible)

A value that specifies whether the workgroup can be accessible from a public network.

Default: - false

Parameters:

publiclyAccessible - A value that specifies whether the workgroup can be accessible from a public network. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-publiclyaccessible

publiclyAccessible

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder publiclyAccessible(IResolvable publiclyAccessible)

A value that specifies whether the workgroup can be accessible from a public network.

Default: - false

Parameters:

publiclyAccessible - A value that specifies whether the workgroup can be accessible from a public network. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-publiclyaccessible

recoveryPointId

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder recoveryPointId(String recoveryPointId)

The recovery point id to restore from.

Parameters:

recoveryPointId - The recovery point id to restore from. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-recoverypointid

securityGroupIds

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder securityGroupIds(List<? extends Object> securityGroupIds)

A list of security group IDs to associate with the workgroup.

Parameters:

securityGroupIds - A list of security group IDs to associate with the workgroup. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-securitygroupids

snapshotArn

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder snapshotArn(String snapshotArn)

The Amazon Resource Name (ARN) of the snapshot to restore from.

Parameters:

snapshotArn - The Amazon Resource Name (ARN) of the snapshot to restore from. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-snapshotarn

snapshotName

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder snapshotName(String snapshotName)

The snapshot name to restore from.

Parameters:

snapshotName - The snapshot name to restore from. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-snapshotname

snapshotOwnerAccount

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder snapshotOwnerAccount(String snapshotOwnerAccount)

The Amazon Web Services account that owns the snapshot.

Parameters:

snapshotOwnerAccount - The Amazon Web Services account that owns the snapshot. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-snapshotowneraccount

subnetIds

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder subnetIds(List<? extends Object> subnetIds)

A list of subnet IDs the workgroup is associated with.

Parameters:

subnetIds - A list of subnet IDs the workgroup is associated with. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-subnetids

tags

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

The map of the key-value pairs used to tag the workgroup.

Parameters:

tags - The map of the key-value pairs used to tag the workgroup. This parameter is required.

Returns:

this

See Also:

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

trackName

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder trackName(String trackName)

An optional parameter for the name of the track for the workgroup.

If you don't provide a track name, the workgroup is assigned to the current track.

Parameters:

trackName - An optional parameter for the name of the track for the workgroup. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-trackname

workgroup

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder workgroup(IResolvable workgroup)

The collection of computing resources from which an endpoint is created.

Parameters:

workgroup - The collection of computing resources from which an endpoint is created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-workgroup

workgroup

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder workgroup(CfnWorkgroupPropsMixin.WorkgroupProperty workgroup)

The collection of computing resources from which an endpoint is created.

Parameters:

workgroup - The collection of computing resources from which an endpoint is created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-workgroup

workgroupName

@Stability(Stable)
public CfnWorkgroupPropsMixin.Builder workgroupName(String workgroupName)

The name of the workgroup.

Parameters:

workgroupName - The name of the workgroup. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-workgroupname

build

@Stability(Stable)
public CfnWorkgroupPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnWorkgroupPropsMixin.