Class: Aws::RedshiftServerless::Types::Workgroup

Inherits:

Struct

Object
Struct
Aws::RedshiftServerless::Types::Workgroup

show all

Defined in:: gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb

Overview

The collection of computing resources from which an endpoint is created.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#base_capacity ⇒ Integer
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
#config_parameters ⇒ Array<Types::ConfigParameter>
An array of parameters to set for advanced control over a database.
#creation_date ⇒ Time
The creation date of the workgroup.
#cross_account_vpcs ⇒ Array<String>
A list of VPCs.
#custom_domain_certificate_arn ⇒ String
The custom domain name’s certificate Amazon resource name (ARN).
#custom_domain_certificate_expiry_time ⇒ Time
The expiration time for the certificate.
#custom_domain_name ⇒ String
The custom domain name associated with the workgroup.
#endpoint ⇒ Types::Endpoint
The endpoint that is created from the workgroup.
#enhanced_vpc_routing ⇒ Boolean
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
#ip_address_type ⇒ String
The IP address type that the workgroup supports.
#max_capacity ⇒ Integer
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
#namespace_name ⇒ String
The namespace the workgroup is associated with.
#patch_version ⇒ String
The patch version of your Amazon Redshift Serverless workgroup.
#port ⇒ Integer
The custom port to use when connecting to a workgroup.
#publicly_accessible ⇒ Boolean
A value that specifies whether the workgroup can be accessible from a public network.
#security_group_ids ⇒ Array<String>
An array of security group IDs to associate with the workgroup.
#status ⇒ String
The status of the workgroup.
#subnet_ids ⇒ Array<String>
An array of subnet IDs the workgroup is associated with.
#workgroup_arn ⇒ String
The Amazon Resource Name (ARN) that links to the workgroup.
#workgroup_id ⇒ String
The unique identifier of the workgroup.
#workgroup_name ⇒ String
The name of the workgroup.
#workgroup_version ⇒ String
The Amazon Redshift Serverless version of your workgroup.

Instance Attribute Details

#base_capacity ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#config_parameters ⇒ `Array<Types::ConfigParameter>`

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:

(Array<Types::ConfigParameter>)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ `Time`

The creation date of the workgroup.

Returns:

(Time)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#cross_account_vpcs ⇒ `Array<String>`

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:

(Array<String>)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#custom_domain_certificate_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#custom_domain_certificate_expiry_time ⇒ `Time`

The expiration time for the certificate.

Returns:

(Time)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#custom_domain_name ⇒ `String`

The custom domain name associated with the workgroup.

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ `Types::Endpoint`

The endpoint that is created from the workgroup.

Returns:

(Types::Endpoint)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_vpc_routing ⇒ `Boolean`

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:

(Boolean)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_name ⇒ `String`

The namespace the workgroup is associated with.

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#patch_version ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the workgroup.

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ `Array<String>`

An array of subnet IDs the workgroup is associated with.

Returns:

(Array<String>)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_id ⇒ `String`

The unique identifier of the workgroup.

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_name ⇒ `String`

The name of the workgroup.

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_version ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 3729

class Workgroup < Struct.new(
  :base_capacity,
  :config_parameters,
  :creation_date,
  :cross_account_vpcs,
  :custom_domain_certificate_arn,
  :custom_domain_certificate_expiry_time,
  :custom_domain_name,
  :endpoint,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :patch_version,
  :port,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :subnet_ids,
  :workgroup_arn,
  :workgroup_id,
  :workgroup_name,
  :workgroup_version)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RedshiftServerless::Types::Workgroup

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#base_capacity ⇒ Integer

#config_parameters ⇒ Array<Types::ConfigParameter>

#creation_date ⇒ Time

#cross_account_vpcs ⇒ Array<String>

#custom_domain_certificate_arn ⇒ String

#custom_domain_certificate_expiry_time ⇒ Time

#custom_domain_name ⇒ String

#endpoint ⇒ Types::Endpoint

#enhanced_vpc_routing ⇒ Boolean

#ip_address_type ⇒ String

#max_capacity ⇒ Integer

#namespace_name ⇒ String

#patch_version ⇒ String

#port ⇒ Integer

#publicly_accessible ⇒ Boolean

#security_group_ids ⇒ Array<String>

#status ⇒ String

#subnet_ids ⇒ Array<String>

#workgroup_arn ⇒ String

#workgroup_id ⇒ String

#workgroup_name ⇒ String

#workgroup_version ⇒ String

#base_capacity ⇒ `Integer`

#config_parameters ⇒ `Array<Types::ConfigParameter>`

#creation_date ⇒ `Time`

#cross_account_vpcs ⇒ `Array<String>`

#custom_domain_certificate_arn ⇒ `String`

#custom_domain_certificate_expiry_time ⇒ `Time`

#custom_domain_name ⇒ `String`

#endpoint ⇒ `Types::Endpoint`

#enhanced_vpc_routing ⇒ `Boolean`

#ip_address_type ⇒ `String`

#max_capacity ⇒ `Integer`

#namespace_name ⇒ `String`

#patch_version ⇒ `String`

#port ⇒ `Integer`

#publicly_accessible ⇒ `Boolean`

#security_group_ids ⇒ `Array<String>`

#status ⇒ `String`

#subnet_ids ⇒ `Array<String>`

#workgroup_arn ⇒ `String`

#workgroup_id ⇒ `String`

#workgroup_name ⇒ `String`

#workgroup_version ⇒ `String`