Interface Workgroup.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Workgroup.Builder,Workgroup>, SdkBuilder<Workgroup.Builder,Workgroup>, SdkPojo
Enclosing class:
Workgroup
@Mutable @NotThreadSafe public static interface Workgroup.Builder extends SdkPojo, CopyableBuilder<Workgroup.Builder,Workgroup>

  • Method Details

    • 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_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.

    • 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_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.

    • 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_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.

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

      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:

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

    • crossAccountVpcs

      Workgroup.Builder crossAccountVpcs(Collection<String> crossAccountVpcs)

      A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

      Parameters:
      crossAccountVpcs - A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • crossAccountVpcs

      Workgroup.Builder crossAccountVpcs(String... crossAccountVpcs)

      A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

      Parameters:
      crossAccountVpcs - A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDomainCertificateArn

      Workgroup.Builder customDomainCertificateArn(String customDomainCertificateArn)

      The custom domain name’s certificate Amazon resource name (ARN).

      Parameters:
      customDomainCertificateArn - The custom domain name’s certificate Amazon resource name (ARN).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDomainCertificateExpiryTime

      Workgroup.Builder customDomainCertificateExpiryTime(Instant customDomainCertificateExpiryTime)

      The expiration time for the certificate.

      Parameters:
      customDomainCertificateExpiryTime - The expiration time for the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDomainName

      Workgroup.Builder customDomainName(String customDomainName)

      The custom domain name associated with the workgroup.

      Parameters:
      customDomainName - The custom domain name associated with 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:

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

    • ipAddressType

      Workgroup.Builder ipAddressType(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.

    • maxCapacity

      Workgroup.Builder maxCapacity(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.

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

    • patchVersion

      Workgroup.Builder patchVersion(String patchVersion)

      The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

      Parameters:
      patchVersion - The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingTrackName

      Workgroup.Builder pendingTrackName(String pendingTrackName)

      The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied.

      Parameters:
      pendingTrackName - The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied.
      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.

    • pricePerformanceTarget

      Workgroup.Builder pricePerformanceTarget(PerformanceTarget 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pricePerformanceTarget

      default Workgroup.Builder pricePerformanceTarget(Consumer<PerformanceTarget.Builder> pricePerformanceTarget)

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

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

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

      Parameters:
      pricePerformanceTarget - a consumer that will call methods on PerformanceTarget.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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:

    • 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:

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

    • trackName

      Workgroup.Builder trackName(String trackName)

      The name of the track for the workgroup.

      Parameters:
      trackName - The name of the track for the workgroup.
      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.

    • workgroupVersion

      Workgroup.Builder workgroupVersion(String workgroupVersion)

      The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.

      Parameters:
      workgroupVersion - The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.
      Returns:
      Returns a reference to this object so that method calls can be chained together.