Class: Aws::RedshiftServerless::Types::CreateWorkgroupRequest

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftServerless::Types::CreateWorkgroupRequest

Defined in:

gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #enhanced_vpc_routing ⇒ Boolean

  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.

• #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 name of the namespace to associate with the workgroup.

• #port ⇒ Integer

  The custom port to use when connecting to a workgroup.

• #price_performance_target ⇒ Types::PerformanceTarget

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

• #publicly_accessible ⇒ Boolean

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

• #security_group_ids ⇒ Array<String>

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

• #subnet_ids ⇒ Array<String>

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

• #tags ⇒ Array<Types::Tag>

  A array of tag instances.

• #track_name ⇒ String

  An optional parameter for the name of the track for the workgroup.

• #workgroup_name ⇒ String

  The name of the created 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 747

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  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 747

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_vpc_routing ⇒ Boolean

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:

• (Boolean)

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

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  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 747

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  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 747

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_name ⇒ String

The name of the namespace to associate with the workgroup.

Returns:

• (String)

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

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  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 747

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#price_performance_target ⇒ Types::PerformanceTarget

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

Returns:

• (Types::PerformanceTarget)

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

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

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

Returns:

• (Boolean)

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

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  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 747

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

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

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A array of tag instances.

Returns:

• (Array<Types::Tag>)

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

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#track_name ⇒ String

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:

• (String)

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

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_name ⇒ String

The name of the created workgroup.

Returns:

• (String)

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

class CreateWorkgroupRequest < Struct.new(
  :base_capacity,
  :config_parameters,
  :enhanced_vpc_routing,
  :ip_address_type,
  :max_capacity,
  :namespace_name,
  :port,
  :price_performance_target,
  :publicly_accessible,
  :security_group_ids,
  :subnet_ids,
  :tags,
  :track_name,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end