create-workgroup¶

Description¶

Creates an workgroup in Amazon Redshift Serverless.

Synopsis¶

  create-workgroup
[--base-capacity <value>]
[--config-parameters <value>]
[--enhanced-vpc-routing | --no-enhanced-vpc-routing]
--namespace-name <value>
[--publicly-accessible | --no-publicly-accessible]
[--security-group-ids <value>]
[--subnet-ids <value>]
[--tags <value>]
--workgroup-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--base-capacity (integer)

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

--config-parameters (list)

An array of parameters to set for more control over a serverless database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

(structure)

An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

parameterKey -> (string)

The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

parameterValue -> (string)

The value of the parameter to set.

Shorthand Syntax:

parameterKey=string,parameterValue=string ...

JSON Syntax:

[
  {
    "parameterKey": "string",
    "parameterValue": "string"
  }
  ...
]

--enhanced-vpc-routing | --no-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.

--namespace-name (string)

The name of the namespace to associate with the workgroup.

--publicly-accessible | --no-publicly-accessible (boolean)

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

--security-group-ids (list)

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

(string)

Syntax:

"string" "string" ...

--subnet-ids (list)

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

(string)

Syntax:

"string" "string" ...

--tags (list)

A array of tag instances.

(structure)

A map of key-value pairs.

key -> (string)

The key to use in the tag.

value -> (string)

The value of the tag.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--workgroup-name (string)

The name of the created workgroup.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output¶

workgroup -> (structure)

The created workgroup object.

baseCapacity -> (integer)

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

configParameters -> (list)

An array of parameters to set for finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

(structure)

An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

parameterKey -> (string)

The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

parameterValue -> (string)

The value of the parameter to set.

creationDate -> (timestamp)

The creation date of the workgroup.

endpoint -> (structure)

The endpoint that is created from the workgroup.

address -> (string)

The DNS address of the VPC endpoint.

port -> (integer)

The port that Amazon Redshift Serverless listens on.

vpcEndpoints -> (list)

An array of VpcEndpoint objects.

(structure)

The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

networkInterfaces -> (list)

One or more network interfaces of the endpoint. Also known as an interface endpoint.

(structure)

Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

availabilityZone -> (string)

The availability Zone.

networkInterfaceId -> (string)

The unique identifier of the network interface.

privateIpAddress -> (string)

The IPv4 address of the network interface within the subnet.

subnetId -> (string)

The unique identifier of the subnet.

vpcEndpointId -> (string)

The connection endpoint ID for connecting to Amazon Redshift Serverless.

vpcId -> (string)

The VPC identifier that the endpoint is associated with.

enhancedVpcRouting -> (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.

namespaceName -> (string)

The namespace the workgroup is associated with.

publiclyAccessible -> (boolean)

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

securityGroupIds -> (list)

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

(string)

status -> (string)

The status of the workgroup.

subnetIds -> (list)

An array of subnet IDs the workgroup is associated with.

(string)

workgroupArn -> (string)

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

workgroupId -> (string)

The unique identifier of the workgroup.

workgroupName -> (string)

The name of the workgroup.

Table of Contents

Feedback

User Guide

create-workgroup¶

Description¶

Synopsis¶

Options¶

Output¶