software.amazon.awssdk.services.redshiftserverless.model

Interface Workgroup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Workgroup.Builder,Workgroup>, SdkBuilder<Workgroup.Builder,Workgroup>, SdkPojo

Enclosing class:

Workgroup

public static interface Workgroup.Builder
extends SdkPojo, CopyableBuilder<Workgroup.Builder,Workgroup>

Method Summary

Modifier and Type	Method and Description
Workgroup.Builder	baseCapacity(Integer baseCapacity) The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
Workgroup.Builder	configParameters(Collection<ConfigParameter> configParameters) An array of parameters to set for advanced control over a database.
Workgroup.Builder	configParameters(ConfigParameter... configParameters) An array of parameters to set for advanced control over a database.
Workgroup.Builder	configParameters(Consumer<ConfigParameter.Builder>... configParameters) An array of parameters to set for advanced control over a database.
Workgroup.Builder	creationDate(Instant creationDate) The creation date of the workgroup.
default Workgroup.Builder	endpoint(Consumer<Endpoint.Builder> endpoint) The endpoint that is created from the workgroup.
Workgroup.Builder	endpoint(Endpoint endpoint) The endpoint that is created from the workgroup.
Workgroup.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.
Workgroup.Builder	namespaceName(String namespaceName) The namespace the workgroup is associated with.
Workgroup.Builder	port(Integer port) The custom port to use when connecting to a workgroup.
Workgroup.Builder	publiclyAccessible(Boolean publiclyAccessible) A value that specifies whether the workgroup can be accessible from a public network
Workgroup.Builder	securityGroupIds(Collection<String> securityGroupIds) An array of security group IDs to associate with the workgroup.
Workgroup.Builder	securityGroupIds(String... securityGroupIds) An array of security group IDs to associate with the workgroup.
Workgroup.Builder	status(String status) The status of the workgroup.
Workgroup.Builder	status(WorkgroupStatus status) The status of the workgroup.
Workgroup.Builder	subnetIds(Collection<String> subnetIds) An array of subnet IDs the workgroup is associated with.
Workgroup.Builder	subnetIds(String... subnetIds) An array of subnet IDs the workgroup is associated with.
Workgroup.Builder	workgroupArn(String workgroupArn) The Amazon Resource Name (ARN) that links to the workgroup.
Workgroup.Builder	workgroupId(String workgroupId) The unique identifier of the workgroup.
Workgroup.Builder	workgroupName(String workgroupName) The name of the workgroup.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

baseCapacity

Workgroup.Builder baseCapacity(Integer baseCapacity)

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

Parameters:

baseCapacity - The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

Returns:

Returns a reference to this object so that method calls can be chained together.

configParameters

Workgroup.Builder configParameters(Collection<ConfigParameter> configParameters)

An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitivity_identifier, enable_user_activity_logging, query_group, , search_path, 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 - An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitivity_identifier, enable_user_activity_logging, query_group, , search_path, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

configParameters

Workgroup.Builder configParameters(ConfigParameter... configParameters)

An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitivity_identifier, enable_user_activity_logging, query_group, , search_path, 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 - An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitivity_identifier, enable_user_activity_logging, query_group, , search_path, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

configParameters

Workgroup.Builder configParameters(Consumer<ConfigParameter.Builder>... configParameters)

An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitivity_identifier, enable_user_activity_logging, query_group, , search_path, 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.

This is a convenience method that creates an instance of the ConfigParameter.Builder avoiding the need to create one manually via ConfigParameter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #configParameters(List).

Parameters:

configParameters - a consumer that will call methods on ConfigParameter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#configParameters(java.util.Collection)

creationDate

Workgroup.Builder creationDate(Instant creationDate)

The creation date of the workgroup.

Parameters:

creationDate - The creation date of the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpoint

Workgroup.Builder endpoint(Endpoint endpoint)

The endpoint that is created from the workgroup.

Parameters:

endpoint - The endpoint that is created from the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpoint

default Workgroup.Builder endpoint(Consumer<Endpoint.Builder> endpoint)

The endpoint that is created from the workgroup.

This is a convenience method that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpoint(Endpoint).

Parameters:

endpoint - a consumer that will call methods on Endpoint.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

endpoint(Endpoint)

enhancedVpcRouting

Workgroup.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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

namespaceName

Workgroup.Builder namespaceName(String namespaceName)

The namespace the workgroup is associated with.

Parameters:

namespaceName - The namespace the workgroup is associated with.

Returns:

Returns a reference to this object so that method calls can be chained together.

port

Workgroup.Builder port(Integer 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. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

Returns:

Returns a reference to this object so that method calls can be chained together.

publiclyAccessible

Workgroup.Builder publiclyAccessible(Boolean publiclyAccessible)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

Workgroup.Builder securityGroupIds(Collection<String> securityGroupIds)

An array of security group IDs to associate with the workgroup.

Parameters:

securityGroupIds - An array of security group IDs to associate with the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

Workgroup.Builder securityGroupIds(String... securityGroupIds)

An array of security group IDs to associate with the workgroup.

Parameters:

securityGroupIds - An array of security group IDs to associate with the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

Workgroup.Builder status(String status)

The status of the workgroup.

Parameters:

status - The status of the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WorkgroupStatus, WorkgroupStatus

status

Workgroup.Builder status(WorkgroupStatus status)

The status of the workgroup.

Parameters:

status - The status of the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WorkgroupStatus, WorkgroupStatus

subnetIds

Workgroup.Builder subnetIds(Collection<String> subnetIds)

An array of subnet IDs the workgroup is associated with.

Parameters:

subnetIds - An array of subnet IDs the workgroup is associated with.

Returns:

Returns a reference to this object so that method calls can be chained together.

subnetIds

Workgroup.Builder subnetIds(String... subnetIds)

An array of subnet IDs the workgroup is associated with.

Parameters:

subnetIds - An array of subnet IDs the workgroup is associated with.

Returns:

Returns a reference to this object so that method calls can be chained together.

workgroupArn

Workgroup.Builder workgroupArn(String workgroupArn)

The Amazon Resource Name (ARN) that links to the workgroup.

Parameters:

workgroupArn - The Amazon Resource Name (ARN) that links to the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

workgroupId

Workgroup.Builder workgroupId(String workgroupId)

The unique identifier of the workgroup.

Parameters:

workgroupId - The unique identifier of the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

workgroupName

Workgroup.Builder workgroupName(String workgroupName)

The name of the workgroup.

Parameters:

workgroupName - The name of the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.