Create Workgroup
redshiftserverless_create_workgroup | R Documentation |
Creates an workgroup in Amazon Redshift Serverless¶
Description¶
Creates an workgroup in Amazon Redshift Serverless.
Usage¶
redshiftserverless_create_workgroup(baseCapacity, configParameters,
enhancedVpcRouting, ipAddressType, maxCapacity, namespaceName, port,
publiclyAccessible, securityGroupIds, subnetIds, tags, workgroupName)
Arguments¶
baseCapacity
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
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.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.
ipAddressType
The IP address type that the workgroup supports. Possible values are
ipv4
anddualstack
.maxCapacity
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
namespaceName
[required] The name of the namespace to associate with the workgroup.
port
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible
A value that specifies whether the workgroup can be accessed from a public network.
securityGroupIds
An array of security group IDs to associate with the workgroup.
subnetIds
An array of VPC subnet IDs to associate with the workgroup.
tags
A array of tag instances.
workgroupName
[required] The name of the created workgroup.
Value¶
A list with the following syntax:
list(
workgroup = list(
baseCapacity = 123,
configParameters = list(
list(
parameterKey = "string",
parameterValue = "string"
)
),
creationDate = as.POSIXct(
"2015-01-01"
),
crossAccountVpcs = list(
"string"
),
customDomainCertificateArn = "string",
customDomainCertificateExpiryTime = as.POSIXct(
"2015-01-01"
),
customDomainName = "string",
endpoint = list(
address = "string",
port = 123,
vpcEndpoints = list(
list(
networkInterfaces = list(
list(
availabilityZone = "string",
ipv6Address = "string",
networkInterfaceId = "string",
privateIpAddress = "string",
subnetId = "string"
)
),
vpcEndpointId = "string",
vpcId = "string"
)
)
),
enhancedVpcRouting = TRUE|FALSE,
ipAddressType = "string",
maxCapacity = 123,
namespaceName = "string",
patchVersion = "string",
port = 123,
publiclyAccessible = TRUE|FALSE,
securityGroupIds = list(
"string"
),
status = "CREATING"|"AVAILABLE"|"MODIFYING"|"DELETING",
subnetIds = list(
"string"
),
workgroupArn = "string",
workgroupId = "string",
workgroupName = "string",
workgroupVersion = "string"
)
)
Request syntax¶
svc$create_workgroup(
baseCapacity = 123,
configParameters = list(
list(
parameterKey = "string",
parameterValue = "string"
)
),
enhancedVpcRouting = TRUE|FALSE,
ipAddressType = "string",
maxCapacity = 123,
namespaceName = "string",
port = 123,
publiclyAccessible = TRUE|FALSE,
securityGroupIds = list(
"string"
),
subnetIds = list(
"string"
),
tags = list(
list(
key = "string",
value = "string"
)
),
workgroupName = "string"
)