Workgroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.redshiftserverless.model.Workgroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Workgroup
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The collection of computing resources from which an endpoint is created.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Workgroup()

Constructors
Constructor and Description
`Workgroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Workgroup`	`clone()`
`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 finer control over a database.
`Date`	`getCreationDate()` The creation date of the workgroup.
`Endpoint`	`getEndpoint()` The endpoint that is created from the workgroup.
`Boolean`	`getEnhancedVpcRouting()` The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
`String`	`getNamespaceName()` The namespace the workgroup is associated with.
`Boolean`	`getPubliclyAccessible()` A value that specifies whether the workgroup can be accessible from a public network
`List<String>`	`getSecurityGroupIds()` An array of security group IDs to associate with the workgroup.
`String`	`getStatus()` The status of the workgroup.
`List<String>`	`getSubnetIds()` An array of subnet IDs the workgroup is associated with.
`String`	`getWorkgroupArn()` The Amazon Resource Name (ARN) that links to the workgroup.
`String`	`getWorkgroupId()` The unique identifier of the workgroup.
`String`	`getWorkgroupName()` The name of the workgroup.
`int`	`hashCode()`
`Boolean`	`isEnhancedVpcRouting()` The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
`Boolean`	`isPubliclyAccessible()` A value that specifies whether the workgroup can be accessible from a public network
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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 finer control over a database.
`void`	`setCreationDate(Date creationDate)` The creation date of the workgroup.
`void`	`setEndpoint(Endpoint endpoint)` The endpoint that is created from the workgroup.
`void`	`setEnhancedVpcRouting(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.
`void`	`setNamespaceName(String namespaceName)` The namespace the workgroup is associated with.
`void`	`setPubliclyAccessible(Boolean publiclyAccessible)` A value that specifies whether the workgroup can be accessible from a public network
`void`	`setSecurityGroupIds(Collection<String> securityGroupIds)` An array of security group IDs to associate with the workgroup.
`void`	`setStatus(String status)` The status of the workgroup.
`void`	`setSubnetIds(Collection<String> subnetIds)` An array of subnet IDs the workgroup is associated with.
`void`	`setWorkgroupArn(String workgroupArn)` The Amazon Resource Name (ARN) that links to the workgroup.
`void`	`setWorkgroupId(String workgroupId)` The unique identifier of the workgroup.
`void`	`setWorkgroupName(String workgroupName)` The name of the workgroup.
`String`	`toString()` Returns a string representation of this object.
`Workgroup`	`withBaseCapacity(Integer baseCapacity)` The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
`Workgroup`	`withConfigParameters(Collection<ConfigParameter> configParameters)` An array of parameters to set for finer control over a database.
`Workgroup`	`withConfigParameters(ConfigParameter... configParameters)` An array of parameters to set for finer control over a database.
`Workgroup`	`withCreationDate(Date creationDate)` The creation date of the workgroup.
`Workgroup`	`withEndpoint(Endpoint endpoint)` The endpoint that is created from the workgroup.
`Workgroup`	`withEnhancedVpcRouting(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`	`withNamespaceName(String namespaceName)` The namespace the workgroup is associated with.
`Workgroup`	`withPubliclyAccessible(Boolean publiclyAccessible)` A value that specifies whether the workgroup can be accessible from a public network
`Workgroup`	`withSecurityGroupIds(Collection<String> securityGroupIds)` An array of security group IDs to associate with the workgroup.
`Workgroup`	`withSecurityGroupIds(String... securityGroupIds)` An array of security group IDs to associate with the workgroup.
`Workgroup`	`withStatus(String status)` The status of the workgroup.
`Workgroup`	`withStatus(WorkgroupStatus status)` The status of the workgroup.
`Workgroup`	`withSubnetIds(Collection<String> subnetIds)` An array of subnet IDs the workgroup is associated with.
`Workgroup`	`withSubnetIds(String... subnetIds)` An array of subnet IDs the workgroup is associated with.
`Workgroup`	`withWorkgroupArn(String workgroupArn)` The Amazon Resource Name (ARN) that links to the workgroup.
`Workgroup`	`withWorkgroupId(String workgroupId)` The unique identifier of the workgroup.
`Workgroup`	`withWorkgroupName(String workgroupName)` The name of the workgroup.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Workgroup
```
public Workgroup()
```
- 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 Workgroup 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 finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
    
    Returns:
    
    An array of parameters to set for finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
  - setConfigParameters
```
public void setConfigParameters(Collection<ConfigParameter> configParameters)
```
    An array of parameters to set for finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
    
    Parameters:
    
    configParameters - An array of parameters to set for finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
  - withConfigParameters
```
public Workgroup withConfigParameters(ConfigParameter... configParameters)
```
    An array of parameters to set for finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
    
    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 finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withConfigParameters
```
public Workgroup withConfigParameters(Collection<ConfigParameter> configParameters)
```
    An array of parameters to set for finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
    
    Parameters:
    
    configParameters - An array of parameters to set for finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The creation date of the workgroup.
    
    Parameters:
    
    creationDate - The creation date of the workgroup.
  - getCreationDate
```
public Date getCreationDate()
```
    The creation date of the workgroup.
    
    Returns:
    
    The creation date of the workgroup.
  - withCreationDate
```
public Workgroup withCreationDate(Date 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.
  - setEndpoint
```
public void setEndpoint(Endpoint endpoint)
```
    The endpoint that is created from the workgroup.
    
    Parameters:
    
    endpoint - The endpoint that is created from the workgroup.
  - getEndpoint
```
public Endpoint getEndpoint()
```
    The endpoint that is created from the workgroup.
    
    Returns:
    
    The endpoint that is created from the workgroup.
  - withEndpoint
```
public Workgroup withEndpoint(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.
  - setEnhancedVpcRouting
```
public void setEnhancedVpcRouting(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.
  - getEnhancedVpcRouting
```
public Boolean getEnhancedVpcRouting()
```
    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:
    
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
  - withEnhancedVpcRouting
```
public Workgroup withEnhancedVpcRouting(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.
  - isEnhancedVpcRouting
```
public Boolean isEnhancedVpcRouting()
```
    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:
    
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
  - setNamespaceName
```
public void setNamespaceName(String namespaceName)
```
    The namespace the workgroup is associated with.
    
    Parameters:
    
    namespaceName - The namespace the workgroup is associated with.
  - getNamespaceName
```
public String getNamespaceName()
```
    The namespace the workgroup is associated with.
    
    Returns:
    
    The namespace the workgroup is associated with.
  - withNamespaceName
```
public Workgroup withNamespaceName(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.
  - setPubliclyAccessible
```
public void setPubliclyAccessible(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
  - getPubliclyAccessible
```
public Boolean getPubliclyAccessible()
```
    A value that specifies whether the workgroup can be accessible from a public network
    
    Returns:
    
    A value that specifies whether the workgroup can be accessible from a public network
  - withPubliclyAccessible
```
public Workgroup withPubliclyAccessible(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.
  - isPubliclyAccessible
```
public Boolean isPubliclyAccessible()
```
    A value that specifies whether the workgroup can be accessible from a public network
    
    Returns:
    
    A value that specifies whether the workgroup can be accessible 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 Workgroup 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 Workgroup 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.
  - setStatus
```
public void setStatus(String status)
```
    The status of the workgroup.
    
    Parameters:
    
    status - The status of the workgroup.
    
    See Also:
    
    WorkgroupStatus
  - getStatus
```
public String getStatus()
```
    The status of the workgroup.
    
    Returns:
    
    The status of the workgroup.
    
    See Also:
    
    WorkgroupStatus
  - withStatus
```
public Workgroup withStatus(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
  - withStatus
```
public Workgroup withStatus(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
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    An array of subnet IDs the workgroup is associated with.
    
    Returns:
    
    An array of subnet IDs the workgroup is associated with.
  - setSubnetIds
```
public void setSubnetIds(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.
  - withSubnetIds
```
public Workgroup withSubnetIds(String... subnetIds)
```
    An array of subnet IDs the workgroup is associated with.
    
    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 subnet IDs the workgroup is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public Workgroup withSubnetIds(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.
  - setWorkgroupArn
```
public void setWorkgroupArn(String workgroupArn)
```
    The Amazon Resource Name (ARN) that links to the workgroup.
    
    Parameters:
    
    workgroupArn - The Amazon Resource Name (ARN) that links to the workgroup.
  - getWorkgroupArn
```
public String getWorkgroupArn()
```
    The Amazon Resource Name (ARN) that links to the workgroup.
    
    Returns:
    
    The Amazon Resource Name (ARN) that links to the workgroup.
  - withWorkgroupArn
```
public Workgroup withWorkgroupArn(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.
  - setWorkgroupId
```
public void setWorkgroupId(String workgroupId)
```
    The unique identifier of the workgroup.
    
    Parameters:
    
    workgroupId - The unique identifier of the workgroup.
  - getWorkgroupId
```
public String getWorkgroupId()
```
    The unique identifier of the workgroup.
    
    Returns:
    
    The unique identifier of the workgroup.
  - withWorkgroupId
```
public Workgroup withWorkgroupId(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.
  - setWorkgroupName
```
public void setWorkgroupName(String workgroupName)
```
    The name of the workgroup.
    
    Parameters:
    
    workgroupName - The name of the workgroup.
  - getWorkgroupName
```
public String getWorkgroupName()
```
    The name of the workgroup.
    
    Returns:
    
    The name of the workgroup.
  - withWorkgroupName
```
public Workgroup withWorkgroupName(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.
  - 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 Workgroup clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Workgroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Workgroup

Method Detail

setBaseCapacity

getBaseCapacity

withBaseCapacity

getConfigParameters

setConfigParameters

withConfigParameters

withConfigParameters

setCreationDate

getCreationDate

withCreationDate

setEndpoint

getEndpoint

withEndpoint

setEnhancedVpcRouting

getEnhancedVpcRouting

withEnhancedVpcRouting

isEnhancedVpcRouting

setNamespaceName

getNamespaceName

withNamespaceName

setPubliclyAccessible

getPubliclyAccessible

withPubliclyAccessible

isPubliclyAccessible

getSecurityGroupIds

setSecurityGroupIds

withSecurityGroupIds

withSecurityGroupIds

setStatus

getStatus

withStatus

withStatus

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

setWorkgroupArn

getWorkgroupArn

withWorkgroupArn

setWorkgroupId

getWorkgroupId

withWorkgroupId

setWorkgroupName

getWorkgroupName

withWorkgroupName

toString

equals

hashCode

clone

marshall