com.amazonaws.services.redshiftserverless.model

Class CreateWorkgroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshiftserverless.model.CreateWorkgroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateWorkgroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateWorkgroupRequest()

Method Summary

Modifier and Type	Method and Description
CreateWorkgroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getBaseCapacity() The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
List<ConfigParameter>	getConfigParameters() An array of parameters to set for advanced control over a database.
Boolean	getEnhancedVpcRouting() The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
String	getIpAddressType() The IP address type that the workgroup supports.
Integer	getMaxCapacity() The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
String	getNamespaceName() The name of the namespace to associate with the workgroup.
Integer	getPort() The custom port to use when connecting to a workgroup.
Boolean	getPubliclyAccessible() A value that specifies whether the workgroup can be accessed from a public network.
List<String>	getSecurityGroupIds() An array of security group IDs to associate with the workgroup.
List<String>	getSubnetIds() An array of VPC subnet IDs to associate with the workgroup.
List<Tag>	getTags() A array of tag instances.
String	getWorkgroupName() The name of the created workgroup.
int	hashCode()
Boolean	isEnhancedVpcRouting() The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
Boolean	isPubliclyAccessible() A value that specifies whether the workgroup can be accessed from a public network.
void	setBaseCapacity(Integer baseCapacity) The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
void	setConfigParameters(Collection<ConfigParameter> configParameters) An array of parameters to set for advanced control over a database.
void	setEnhancedVpcRouting(Boolean enhancedVpcRouting) The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
void	setIpAddressType(String ipAddressType) The IP address type that the workgroup supports.
void	setMaxCapacity(Integer maxCapacity) The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
void	setNamespaceName(String namespaceName) The name of the namespace to associate with the workgroup.
void	setPort(Integer port) The custom port to use when connecting to a workgroup.
void	setPubliclyAccessible(Boolean publiclyAccessible) A value that specifies whether the workgroup can be accessed from a public network.
void	setSecurityGroupIds(Collection<String> securityGroupIds) An array of security group IDs to associate with the workgroup.
void	setSubnetIds(Collection<String> subnetIds) An array of VPC subnet IDs to associate with the workgroup.
void	setTags(Collection<Tag> tags) A array of tag instances.
void	setWorkgroupName(String workgroupName) The name of the created workgroup.
String	toString() Returns a string representation of this object.
CreateWorkgroupRequest	withBaseCapacity(Integer baseCapacity) The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
CreateWorkgroupRequest	withConfigParameters(Collection<ConfigParameter> configParameters) An array of parameters to set for advanced control over a database.
CreateWorkgroupRequest	withConfigParameters(ConfigParameter... configParameters) An array of parameters to set for advanced control over a database.
CreateWorkgroupRequest	withEnhancedVpcRouting(Boolean enhancedVpcRouting) The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
CreateWorkgroupRequest	withIpAddressType(String ipAddressType) The IP address type that the workgroup supports.
CreateWorkgroupRequest	withMaxCapacity(Integer maxCapacity) The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
CreateWorkgroupRequest	withNamespaceName(String namespaceName) The name of the namespace to associate with the workgroup.
CreateWorkgroupRequest	withPort(Integer port) The custom port to use when connecting to a workgroup.
CreateWorkgroupRequest	withPubliclyAccessible(Boolean publiclyAccessible) A value that specifies whether the workgroup can be accessed from a public network.
CreateWorkgroupRequest	withSecurityGroupIds(Collection<String> securityGroupIds) An array of security group IDs to associate with the workgroup.
CreateWorkgroupRequest	withSecurityGroupIds(String... securityGroupIds) An array of security group IDs to associate with the workgroup.
CreateWorkgroupRequest	withSubnetIds(Collection<String> subnetIds) An array of VPC subnet IDs to associate with the workgroup.
CreateWorkgroupRequest	withSubnetIds(String... subnetIds) An array of VPC subnet IDs to associate with the workgroup.
CreateWorkgroupRequest	withTags(Collection<Tag> tags) A array of tag instances.
CreateWorkgroupRequest	withTags(Tag... tags) A array of tag instances.
CreateWorkgroupRequest	withWorkgroupName(String workgroupName) The name of the created workgroup.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateWorkgroupRequest

public CreateWorkgroupRequest()

Method Detail

setBaseCapacity

public void setBaseCapacity(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).

getBaseCapacity

public Integer getBaseCapacity()

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

Returns:

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

withBaseCapacity

public CreateWorkgroupRequest withBaseCapacity(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.

getConfigParameters

public List<ConfigParameter> getConfigParameters()

An array of parameters to set for advanced control over a database. 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.

Returns:

An array of parameters to set for advanced control over a database. 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.

setConfigParameters

public void setConfigParameters(Collection<ConfigParameter> configParameters)

An array of parameters to set for advanced control over a database. 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 - An array of parameters to set for advanced control over a database. 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.

withConfigParameters

public CreateWorkgroupRequest withConfigParameters(ConfigParameter... configParameters)

An array of parameters to set for advanced control over a database. 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.

NOTE: This method appends the values to the existing list (if any). Use setConfigParameters(java.util.Collection) or withConfigParameters(java.util.Collection) if you want to override the existing values.

Parameters:

configParameters - An array of parameters to set for advanced control over a database. 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.

Returns:

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

withConfigParameters

public CreateWorkgroupRequest withConfigParameters(Collection<ConfigParameter> configParameters)

An array of parameters to set for advanced control over a database. 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 - An array of parameters to set for advanced control over a database. 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.

Returns:

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

setEnhancedVpcRouting

public void setEnhancedVpcRouting(Boolean enhancedVpcRouting)

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

Parameters:

enhancedVpcRouting - The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

getEnhancedVpcRouting

public Boolean getEnhancedVpcRouting()

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

Returns:

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

withEnhancedVpcRouting

public CreateWorkgroupRequest withEnhancedVpcRouting(Boolean enhancedVpcRouting)

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

Parameters:

enhancedVpcRouting - The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

Returns:

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

isEnhancedVpcRouting

public Boolean isEnhancedVpcRouting()

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

Returns:

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

setIpAddressType

public void setIpAddressType(String ipAddressType)

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack .

Parameters:

ipAddressType - The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

getIpAddressType

public String getIpAddressType()

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack .

Returns:

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

withIpAddressType

public CreateWorkgroupRequest withIpAddressType(String ipAddressType)

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack .

Parameters:

ipAddressType - The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

Returns:

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

setMaxCapacity

public void setMaxCapacity(Integer 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. The max capacity is specified in RPUs.

getMaxCapacity

public Integer getMaxCapacity()

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

Returns:

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

withMaxCapacity

public CreateWorkgroupRequest withMaxCapacity(Integer 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. The max capacity is specified in RPUs.

Returns:

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

setNamespaceName

public void setNamespaceName(String namespaceName)

The name of the namespace to associate with the workgroup.

Parameters:

namespaceName - The name of the namespace to associate with the workgroup.

getNamespaceName

public String getNamespaceName()

The name of the namespace to associate with the workgroup.

Returns:

The name of the namespace to associate with the workgroup.

withNamespaceName

public CreateWorkgroupRequest withNamespaceName(String namespaceName)

The name of the namespace to associate with the workgroup.

Parameters:

namespaceName - The name of the namespace to associate with the workgroup.

Returns:

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

setPort

public void setPort(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.

getPort

public Integer getPort()

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

Returns:

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

withPort

public CreateWorkgroupRequest withPort(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.

setPubliclyAccessible

public void setPubliclyAccessible(Boolean publiclyAccessible)

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

Parameters:

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

getPubliclyAccessible

public Boolean getPubliclyAccessible()

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

Returns:

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

withPubliclyAccessible

public CreateWorkgroupRequest withPubliclyAccessible(Boolean publiclyAccessible)

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

Parameters:

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

Returns:

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

isPubliclyAccessible

public Boolean isPubliclyAccessible()

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

Returns:

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

getSecurityGroupIds

public List<String> getSecurityGroupIds()

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

Returns:

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

setSecurityGroupIds

public void setSecurityGroupIds(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.

withSecurityGroupIds

public CreateWorkgroupRequest withSecurityGroupIds(String... securityGroupIds)

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

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

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.

withSecurityGroupIds

public CreateWorkgroupRequest withSecurityGroupIds(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.

getSubnetIds

public List<String> getSubnetIds()

An array of VPC subnet IDs to associate with the workgroup.

Returns:

An array of VPC subnet IDs to associate with the workgroup.

setSubnetIds

public void setSubnetIds(Collection<String> subnetIds)

An array of VPC subnet IDs to associate with the workgroup.

Parameters:

subnetIds - An array of VPC subnet IDs to associate with the workgroup.

withSubnetIds

public CreateWorkgroupRequest withSubnetIds(String... subnetIds)

An array of VPC subnet IDs to associate with the workgroup.

NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

Parameters:

subnetIds - An array of VPC subnet IDs to associate with the workgroup.

Returns:

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

withSubnetIds

public CreateWorkgroupRequest withSubnetIds(Collection<String> subnetIds)

An array of VPC subnet IDs to associate with the workgroup.

Parameters:

subnetIds - An array of VPC subnet IDs to associate with the workgroup.

Returns:

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

getTags

public List<Tag> getTags()

A array of tag instances.

Returns:

A array of tag instances.

setTags

public void setTags(Collection<Tag> tags)

A array of tag instances.

Parameters:

tags - A array of tag instances.

withTags

public CreateWorkgroupRequest withTags(Tag... tags)

A array of tag instances.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A array of tag instances.

Returns:

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

withTags

public CreateWorkgroupRequest withTags(Collection<Tag> tags)

A array of tag instances.

Parameters:

tags - A array of tag instances.

Returns:

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

setWorkgroupName

public void setWorkgroupName(String workgroupName)

The name of the created workgroup.

Parameters:

workgroupName - The name of the created workgroup.

getWorkgroupName

public String getWorkgroupName()

The name of the created workgroup.

Returns:

The name of the created workgroup.

withWorkgroupName

public CreateWorkgroupRequest withWorkgroupName(String workgroupName)

The name of the created workgroup.

Parameters:

workgroupName - The name of the created workgroup.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateWorkgroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()