Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RedshiftServerLess.CreateWorkgroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an workgroup in Amazon Redshift Serverless.

Synopsis

data CreateWorkgroup = CreateWorkgroup' {
- baseCapacity :: Maybe Int
- configParameters :: Maybe [ConfigParameter]
- enhancedVpcRouting :: Maybe Bool
- port :: Maybe Int
- publiclyAccessible :: Maybe Bool
- securityGroupIds :: Maybe [Text]
- subnetIds :: Maybe [Text]
- tags :: Maybe [Tag]
- namespaceName :: Text
- workgroupName :: Text
}
newCreateWorkgroup :: Text -> Text -> CreateWorkgroup
createWorkgroup_baseCapacity :: Lens' CreateWorkgroup (Maybe Int)
createWorkgroup_configParameters :: Lens' CreateWorkgroup (Maybe [ConfigParameter])
createWorkgroup_enhancedVpcRouting :: Lens' CreateWorkgroup (Maybe Bool)
createWorkgroup_port :: Lens' CreateWorkgroup (Maybe Int)
createWorkgroup_publiclyAccessible :: Lens' CreateWorkgroup (Maybe Bool)
createWorkgroup_securityGroupIds :: Lens' CreateWorkgroup (Maybe [Text])
createWorkgroup_subnetIds :: Lens' CreateWorkgroup (Maybe [Text])
createWorkgroup_tags :: Lens' CreateWorkgroup (Maybe [Tag])
createWorkgroup_namespaceName :: Lens' CreateWorkgroup Text
createWorkgroup_workgroupName :: Lens' CreateWorkgroup Text
data CreateWorkgroupResponse = CreateWorkgroupResponse' {
- workgroup :: Maybe Workgroup
- httpStatus :: Int
}
newCreateWorkgroupResponse :: Int -> CreateWorkgroupResponse
createWorkgroupResponse_workgroup :: Lens' CreateWorkgroupResponse (Maybe Workgroup)
createWorkgroupResponse_httpStatus :: Lens' CreateWorkgroupResponse Int

Creating a Request

data CreateWorkgroup Source #

See: newCreateWorkgroup smart constructor.

Constructors

CreateWorkgroup'

Fields

baseCapacity :: Maybe Int
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters :: Maybe [ConfigParameter]
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.
enhancedVpcRouting :: Maybe Bool
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.
port :: Maybe Int
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible :: Maybe Bool
A value that specifies whether the workgroup can be accessed from a public network.
securityGroupIds :: Maybe [Text]
An array of security group IDs to associate with the workgroup.
subnetIds :: Maybe [Text]
An array of VPC subnet IDs to associate with the workgroup.
tags :: Maybe [Tag]
A array of tag instances.
namespaceName :: Text
The name of the namespace to associate with the workgroup.
workgroupName :: Text
The name of the created workgroup.

Instances

Instances details

ToJSON CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods toJSON :: CreateWorkgroup -> Value # toEncoding :: CreateWorkgroup -> Encoding # toJSONList :: [CreateWorkgroup] -> Value # toEncodingList :: [CreateWorkgroup] -> Encoding #
ToHeaders CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods toHeaders :: CreateWorkgroup -> [Header] #
ToPath CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods toPath :: CreateWorkgroup -> ByteString #
ToQuery CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods toQuery :: CreateWorkgroup -> QueryString #
AWSRequest CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Associated Types type AWSResponse CreateWorkgroup # Methods request :: (Service -> Service) -> CreateWorkgroup -> Request CreateWorkgroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWorkgroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkgroup))) #
Generic CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Associated Types type Rep CreateWorkgroup :: Type -> Type # Methods from :: CreateWorkgroup -> Rep CreateWorkgroup x # to :: Rep CreateWorkgroup x -> CreateWorkgroup #
Read CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods readsPrec :: Int -> ReadS CreateWorkgroup # readList :: ReadS [CreateWorkgroup] # readPrec :: ReadPrec CreateWorkgroup # readListPrec :: ReadPrec [CreateWorkgroup] #
Show CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods showsPrec :: Int -> CreateWorkgroup -> ShowS # show :: CreateWorkgroup -> String # showList :: [CreateWorkgroup] -> ShowS #
NFData CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods rnf :: CreateWorkgroup -> () #
Eq CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods (==) :: CreateWorkgroup -> CreateWorkgroup -> Bool # (/=) :: CreateWorkgroup -> CreateWorkgroup -> Bool #
Hashable CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods hashWithSalt :: Int -> CreateWorkgroup -> Int # hash :: CreateWorkgroup -> Int #
type AWSResponse CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup type AWSResponse CreateWorkgroup = CreateWorkgroupResponse
type Rep CreateWorkgroup Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup type Rep CreateWorkgroup = D1 ('MetaData "CreateWorkgroup" "Amazonka.RedshiftServerLess.CreateWorkgroup" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "CreateWorkgroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "baseCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "configParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigParameter]))) :: (S1 ('MetaSel ('Just "enhancedVpcRouting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "namespaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workgroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateWorkgroup Source #

Arguments

:: Text	`CreateWorkgroup`
-> Text	`CreateWorkgroup`
-> CreateWorkgroup

Create a value of CreateWorkgroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

CreateWorkgroup, createWorkgroup_configParameters - 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.

CreateWorkgroup, createWorkgroup_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.

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

CreateWorkgroup, createWorkgroup_publiclyAccessible - A value that specifies whether the workgroup can be accessed from a public network.

CreateWorkgroup, createWorkgroup_securityGroupIds - An array of security group IDs to associate with the workgroup.

CreateWorkgroup, createWorkgroup_subnetIds - An array of VPC subnet IDs to associate with the workgroup.

$sel:tags:CreateWorkgroup', createWorkgroup_tags - A array of tag instances.

CreateWorkgroup, createWorkgroup_namespaceName - The name of the namespace to associate with the workgroup.

CreateWorkgroup, createWorkgroup_workgroupName - The name of the created workgroup.

Request Lenses

createWorkgroup_baseCapacity :: Lens' CreateWorkgroup (Maybe Int) Source #

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

createWorkgroup_configParameters :: Lens' CreateWorkgroup (Maybe [ConfigParameter]) Source #

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.

createWorkgroup_enhancedVpcRouting :: Lens' CreateWorkgroup (Maybe Bool) Source #

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.

createWorkgroup_port :: Lens' CreateWorkgroup (Maybe Int) Source #

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

createWorkgroup_publiclyAccessible :: Lens' CreateWorkgroup (Maybe Bool) Source #

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

createWorkgroup_securityGroupIds :: Lens' CreateWorkgroup (Maybe [Text]) Source #

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

createWorkgroup_subnetIds :: Lens' CreateWorkgroup (Maybe [Text]) Source #

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

createWorkgroup_tags :: Lens' CreateWorkgroup (Maybe [Tag]) Source #

A array of tag instances.

createWorkgroup_namespaceName :: Lens' CreateWorkgroup Text Source #

The name of the namespace to associate with the workgroup.

createWorkgroup_workgroupName :: Lens' CreateWorkgroup Text Source #

The name of the created workgroup.

Destructuring the Response

data CreateWorkgroupResponse Source #

See: newCreateWorkgroupResponse smart constructor.

Constructors

CreateWorkgroupResponse'
Fields workgroup :: Maybe Workgroup The created workgroup object. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateWorkgroupResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Associated Types type Rep CreateWorkgroupResponse :: Type -> Type # Methods from :: CreateWorkgroupResponse -> Rep CreateWorkgroupResponse x # to :: Rep CreateWorkgroupResponse x -> CreateWorkgroupResponse #
Read CreateWorkgroupResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods readsPrec :: Int -> ReadS CreateWorkgroupResponse # readList :: ReadS [CreateWorkgroupResponse] # readPrec :: ReadPrec CreateWorkgroupResponse # readListPrec :: ReadPrec [CreateWorkgroupResponse] #
Show CreateWorkgroupResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods showsPrec :: Int -> CreateWorkgroupResponse -> ShowS # show :: CreateWorkgroupResponse -> String # showList :: [CreateWorkgroupResponse] -> ShowS #
NFData CreateWorkgroupResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods rnf :: CreateWorkgroupResponse -> () #
Eq CreateWorkgroupResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup Methods (==) :: CreateWorkgroupResponse -> CreateWorkgroupResponse -> Bool # (/=) :: CreateWorkgroupResponse -> CreateWorkgroupResponse -> Bool #
type Rep CreateWorkgroupResponse Source #
Instance details Defined in Amazonka.RedshiftServerLess.CreateWorkgroup type Rep CreateWorkgroupResponse = D1 ('MetaData "CreateWorkgroupResponse" "Amazonka.RedshiftServerLess.CreateWorkgroup" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "CreateWorkgroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workgroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Workgroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateWorkgroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateWorkgroupResponse'`
-> CreateWorkgroupResponse

Create a value of CreateWorkgroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:workgroup:CreateWorkgroupResponse', createWorkgroupResponse_workgroup - The created workgroup object.

$sel:httpStatus:CreateWorkgroupResponse', createWorkgroupResponse_httpStatus - The response's http status code.

Response Lenses

createWorkgroupResponse_workgroup :: Lens' CreateWorkgroupResponse (Maybe Workgroup) Source #

The created workgroup object.

createWorkgroupResponse_httpStatus :: Lens' CreateWorkgroupResponse Int Source #

The response's http status code.