amazonka-redshift-serverless-2.0: Amazon Redshift Serverless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RedshiftServerLess.UpdateWorkgroup

Description

Updates a workgroup with the specified configuration settings.

Synopsis

Creating a Request

data UpdateWorkgroup Source #

See: newUpdateWorkgroup smart constructor.

Constructors

UpdateWorkgroup' 

Fields

  • baseCapacity :: Maybe Int

    The new base data warehouse capacity in Redshift Processing Units (RPUs).

  • configParameters :: Maybe [ConfigParameter]

    An array of parameters to set for advanced control over a 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.

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

  • workgroupName :: Text

    The name of the workgroup to update.

Instances

Instances details
ToJSON UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

toJSON :: UpdateWorkgroup -> Value #

toEncoding :: UpdateWorkgroup -> Encoding #

toJSONList :: [UpdateWorkgroup] -> Value #

toEncodingList :: [UpdateWorkgroup] -> Encoding #

ToHeaders UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

toHeaders :: UpdateWorkgroup -> [Header] #

ToPath UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

toPath :: UpdateWorkgroup -> ByteString #

ToQuery UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

toQuery :: UpdateWorkgroup -> QueryString #

AWSRequest UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Associated Types

type AWSResponse UpdateWorkgroup #

Methods

request :: (Service -> Service) -> UpdateWorkgroup -> Request UpdateWorkgroup #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateWorkgroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateWorkgroup))) #

Generic UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Associated Types

type Rep UpdateWorkgroup :: Type -> Type #

Methods

from :: UpdateWorkgroup -> Rep UpdateWorkgroup x #

to :: Rep UpdateWorkgroup x -> UpdateWorkgroup #

Read UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

readsPrec :: Int -> ReadS UpdateWorkgroup #

readList :: ReadS [UpdateWorkgroup] #

readPrec :: ReadPrec UpdateWorkgroup #

readListPrec :: ReadPrec [UpdateWorkgroup] #

Show UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

showsPrec :: Int -> UpdateWorkgroup -> ShowS #

show :: UpdateWorkgroup -> String #

showList :: [UpdateWorkgroup] -> ShowS #

NFData UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

rnf :: UpdateWorkgroup -> () #

Eq UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

(==) :: UpdateWorkgroup -> UpdateWorkgroup -> Bool #

(/=) :: UpdateWorkgroup -> UpdateWorkgroup -> Bool #

Hashable UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

hashWithSalt :: Int -> UpdateWorkgroup -> Int #

hash :: UpdateWorkgroup -> Int #

type AWSResponse UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

type AWSResponse UpdateWorkgroup = UpdateWorkgroupResponse
type Rep UpdateWorkgroup Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

type Rep UpdateWorkgroup = D1 ('MetaData "UpdateWorkgroup" "Amazonka.RedshiftServerLess.UpdateWorkgroup" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "UpdateWorkgroup'" '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 "workgroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateWorkgroup Source #

Arguments

:: Text

UpdateWorkgroup

-> UpdateWorkgroup 

Create a value of UpdateWorkgroup 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:

UpdateWorkgroup, updateWorkgroup_baseCapacity - The new base data warehouse capacity in Redshift Processing Units (RPUs).

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

UpdateWorkgroup, updateWorkgroup_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.

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

UpdateWorkgroup, updateWorkgroup_publiclyAccessible - A value that specifies whether the workgroup can be accessible from a public network.

UpdateWorkgroup, updateWorkgroup_securityGroupIds - An array of security group IDs to associate with the workgroup.

UpdateWorkgroup, updateWorkgroup_subnetIds - An array of VPC subnet IDs to associate with the workgroup.

UpdateWorkgroup, updateWorkgroup_workgroupName - The name of the workgroup to update.

Request Lenses

updateWorkgroup_baseCapacity :: Lens' UpdateWorkgroup (Maybe Int) Source #

The new base data warehouse capacity in Redshift Processing Units (RPUs).

updateWorkgroup_configParameters :: Lens' UpdateWorkgroup (Maybe [ConfigParameter]) Source #

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

updateWorkgroup_enhancedVpcRouting :: Lens' UpdateWorkgroup (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.

updateWorkgroup_port :: Lens' UpdateWorkgroup (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.

updateWorkgroup_publiclyAccessible :: Lens' UpdateWorkgroup (Maybe Bool) Source #

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

updateWorkgroup_securityGroupIds :: Lens' UpdateWorkgroup (Maybe [Text]) Source #

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

updateWorkgroup_subnetIds :: Lens' UpdateWorkgroup (Maybe [Text]) Source #

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

updateWorkgroup_workgroupName :: Lens' UpdateWorkgroup Text Source #

The name of the workgroup to update.

Destructuring the Response

data UpdateWorkgroupResponse Source #

See: newUpdateWorkgroupResponse smart constructor.

Constructors

UpdateWorkgroupResponse' 

Fields

Instances

Instances details
Generic UpdateWorkgroupResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Associated Types

type Rep UpdateWorkgroupResponse :: Type -> Type #

Methods

from :: UpdateWorkgroupResponse -> Rep UpdateWorkgroupResponse x #

to :: Rep UpdateWorkgroupResponse x -> UpdateWorkgroupResponse #

Read UpdateWorkgroupResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

readsPrec :: Int -> ReadS UpdateWorkgroupResponse #

readList :: ReadS [UpdateWorkgroupResponse] #

readPrec :: ReadPrec UpdateWorkgroupResponse #

readListPrec :: ReadPrec [UpdateWorkgroupResponse] #

Show UpdateWorkgroupResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

showsPrec :: Int -> UpdateWorkgroupResponse -> ShowS #

show :: UpdateWorkgroupResponse -> String #

showList :: [UpdateWorkgroupResponse] -> ShowS #

NFData UpdateWorkgroupResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

rnf :: UpdateWorkgroupResponse -> () #

Eq UpdateWorkgroupResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

Methods

(==) :: UpdateWorkgroupResponse -> UpdateWorkgroupResponse -> Bool #

(/=) :: UpdateWorkgroupResponse -> UpdateWorkgroupResponse -> Bool #

type Rep UpdateWorkgroupResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.UpdateWorkgroup

type Rep UpdateWorkgroupResponse = D1 ('MetaData "UpdateWorkgroupResponse" "Amazonka.RedshiftServerLess.UpdateWorkgroup" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "UpdateWorkgroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workgroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Workgroup)))

newUpdateWorkgroupResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateWorkgroupResponse'

-> Workgroup

$sel:workgroup:UpdateWorkgroupResponse'

-> UpdateWorkgroupResponse 

Create a value of UpdateWorkgroupResponse 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:httpStatus:UpdateWorkgroupResponse', updateWorkgroupResponse_httpStatus - The response's http status code.

$sel:workgroup:UpdateWorkgroupResponse', updateWorkgroupResponse_workgroup - The updated workgroup object.

Response Lenses

updateWorkgroupResponse_httpStatus :: Lens' UpdateWorkgroupResponse Int Source #

The response's http status code.

updateWorkgroupResponse_workgroup :: Lens' UpdateWorkgroupResponse Workgroup Source #

The updated workgroup object.