Class CreateWorkgroupRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.redshiftserverless.model.RedshiftServerlessRequest
software.amazon.awssdk.services.redshiftserverless.model.CreateWorkgroupRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateWorkgroupRequest.Builder,CreateWorkgroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateWorkgroupRequest extends RedshiftServerlessRequest implements ToCopyableBuilder<CreateWorkgroupRequest.Builder,CreateWorkgroupRequest>

  • Method Details

    • baseCapacity

      public final Integer baseCapacity()

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

    • hasConfigParameters

      public final boolean hasConfigParameters()
      For responses, this returns true if the service returned a value for the ConfigParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • configParameters

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConfigParameters() method.

      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.

    • enhancedVpcRouting

      public final 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.

      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.

    • ipAddressType

      public final String ipAddressType()

      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.

    • maxCapacity

      public final Integer maxCapacity()

      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.

    • namespaceName

      public final String namespaceName()

      The name of the namespace to associate with the workgroup.

      Returns:
      The name of the namespace to associate with the workgroup.

    • port

      public final 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.

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

    • pricePerformanceTarget

      public final PerformanceTarget pricePerformanceTarget()

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

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

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      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.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroupIds

      public final List<String> securityGroupIds()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

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

    • hasSubnetIds

      public final boolean hasSubnetIds()
      For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • subnetIds

      public final List<String> subnetIds()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A array of tag instances.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A array of tag instances.

    • trackName

      public final 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.

      Returns:
      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.

    • workgroupName

      public final String workgroupName()

      The name of the created workgroup.

      Returns:
      The name of the created workgroup.

    • toBuilder

      public CreateWorkgroupRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateWorkgroupRequest.Builder,CreateWorkgroupRequest>
      Specified by:
      toBuilder in class RedshiftServerlessRequest
      Returns:
      a builder for type T

    • builder

      public static CreateWorkgroupRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateWorkgroupRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.