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.Kafka.UpdateStorage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

Synopsis

data UpdateStorage = UpdateStorage' {
- provisionedThroughput :: Maybe ProvisionedThroughput
- storageMode :: Maybe StorageMode
- volumeSizeGB :: Maybe Int
- clusterArn :: Text
- currentVersion :: Text
}
newUpdateStorage :: Text -> Text -> UpdateStorage
updateStorage_provisionedThroughput :: Lens' UpdateStorage (Maybe ProvisionedThroughput)
updateStorage_storageMode :: Lens' UpdateStorage (Maybe StorageMode)
updateStorage_volumeSizeGB :: Lens' UpdateStorage (Maybe Int)
updateStorage_clusterArn :: Lens' UpdateStorage Text
updateStorage_currentVersion :: Lens' UpdateStorage Text
data UpdateStorageResponse = UpdateStorageResponse' {
- clusterArn :: Maybe Text
- clusterOperationArn :: Maybe Text
- httpStatus :: Int
}
newUpdateStorageResponse :: Int -> UpdateStorageResponse
updateStorageResponse_clusterArn :: Lens' UpdateStorageResponse (Maybe Text)
updateStorageResponse_clusterOperationArn :: Lens' UpdateStorageResponse (Maybe Text)
updateStorageResponse_httpStatus :: Lens' UpdateStorageResponse Int

Creating a Request

data UpdateStorage Source #

Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.

See: newUpdateStorage smart constructor.

Constructors

UpdateStorage'

Fields

provisionedThroughput :: Maybe ProvisionedThroughput
EBS volume provisioned throughput information.
storageMode :: Maybe StorageMode
Controls storage mode for supported storage tiers.
volumeSizeGB :: Maybe Int
size of the EBS volume to update.
clusterArn :: Text
The Amazon Resource Name (ARN) of the cluster to be updated.
currentVersion :: Text
The version of cluster to update from. A successful operation will then generate a new version.

Instances

Instances details

ToJSON UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods toJSON :: UpdateStorage -> Value # toEncoding :: UpdateStorage -> Encoding # toJSONList :: [UpdateStorage] -> Value # toEncodingList :: [UpdateStorage] -> Encoding #
ToHeaders UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods toHeaders :: UpdateStorage -> [Header] #
ToPath UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods toPath :: UpdateStorage -> ByteString #
ToQuery UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods toQuery :: UpdateStorage -> QueryString #
AWSRequest UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Associated Types type AWSResponse UpdateStorage # Methods request :: (Service -> Service) -> UpdateStorage -> Request UpdateStorage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateStorage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateStorage))) #
Generic UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Associated Types type Rep UpdateStorage :: Type -> Type # Methods from :: UpdateStorage -> Rep UpdateStorage x # to :: Rep UpdateStorage x -> UpdateStorage #
Read UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods readsPrec :: Int -> ReadS UpdateStorage # readList :: ReadS [UpdateStorage] # readPrec :: ReadPrec UpdateStorage # readListPrec :: ReadPrec [UpdateStorage] #
Show UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods showsPrec :: Int -> UpdateStorage -> ShowS # show :: UpdateStorage -> String # showList :: [UpdateStorage] -> ShowS #
NFData UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods rnf :: UpdateStorage -> () #
Eq UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods (==) :: UpdateStorage -> UpdateStorage -> Bool # (/=) :: UpdateStorage -> UpdateStorage -> Bool #
Hashable UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods hashWithSalt :: Int -> UpdateStorage -> Int # hash :: UpdateStorage -> Int #
type AWSResponse UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage type AWSResponse UpdateStorage = UpdateStorageResponse
type Rep UpdateStorage Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage type Rep UpdateStorage = D1 ('MetaData "UpdateStorage" "Amazonka.Kafka.UpdateStorage" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "UpdateStorage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "provisionedThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisionedThroughput)) :: S1 ('MetaSel ('Just "storageMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageMode))) :: (S1 ('MetaSel ('Just "volumeSizeGB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "currentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateStorage Source #

Arguments

:: Text	`UpdateStorage`
-> Text	`UpdateStorage`
-> UpdateStorage

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

UpdateStorage, updateStorage_provisionedThroughput - EBS volume provisioned throughput information.

UpdateStorage, updateStorage_storageMode - Controls storage mode for supported storage tiers.

UpdateStorage, updateStorage_volumeSizeGB - size of the EBS volume to update.

UpdateStorage, updateStorage_clusterArn - The Amazon Resource Name (ARN) of the cluster to be updated.

UpdateStorage, updateStorage_currentVersion - The version of cluster to update from. A successful operation will then generate a new version.

Request Lenses

updateStorage_provisionedThroughput :: Lens' UpdateStorage (Maybe ProvisionedThroughput) Source #

EBS volume provisioned throughput information.

updateStorage_storageMode :: Lens' UpdateStorage (Maybe StorageMode) Source #

Controls storage mode for supported storage tiers.

updateStorage_volumeSizeGB :: Lens' UpdateStorage (Maybe Int) Source #

size of the EBS volume to update.

updateStorage_clusterArn :: Lens' UpdateStorage Text Source #

The Amazon Resource Name (ARN) of the cluster to be updated.

updateStorage_currentVersion :: Lens' UpdateStorage Text Source #

The version of cluster to update from. A successful operation will then generate a new version.

Destructuring the Response

data UpdateStorageResponse Source #

See: newUpdateStorageResponse smart constructor.

Constructors

UpdateStorageResponse'
Fields clusterArn :: Maybe Text The Amazon Resource Name (ARN) of the cluster. clusterOperationArn :: Maybe Text The Amazon Resource Name (ARN) of the cluster operation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateStorageResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Associated Types type Rep UpdateStorageResponse :: Type -> Type # Methods from :: UpdateStorageResponse -> Rep UpdateStorageResponse x # to :: Rep UpdateStorageResponse x -> UpdateStorageResponse #
Read UpdateStorageResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods readsPrec :: Int -> ReadS UpdateStorageResponse # readList :: ReadS [UpdateStorageResponse] # readPrec :: ReadPrec UpdateStorageResponse # readListPrec :: ReadPrec [UpdateStorageResponse] #
Show UpdateStorageResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods showsPrec :: Int -> UpdateStorageResponse -> ShowS # show :: UpdateStorageResponse -> String # showList :: [UpdateStorageResponse] -> ShowS #
NFData UpdateStorageResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods rnf :: UpdateStorageResponse -> () #
Eq UpdateStorageResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage Methods (==) :: UpdateStorageResponse -> UpdateStorageResponse -> Bool # (/=) :: UpdateStorageResponse -> UpdateStorageResponse -> Bool #
type Rep UpdateStorageResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateStorage type Rep UpdateStorageResponse = D1 ('MetaData "UpdateStorageResponse" "Amazonka.Kafka.UpdateStorage" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "UpdateStorageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clusterOperationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateStorageResponse Source #

Arguments

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

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

UpdateStorage, updateStorageResponse_clusterArn - The Amazon Resource Name (ARN) of the cluster.

$sel:clusterOperationArn:UpdateStorageResponse', updateStorageResponse_clusterOperationArn - The Amazon Resource Name (ARN) of the cluster operation.

$sel:httpStatus:UpdateStorageResponse', updateStorageResponse_httpStatus - The response's http status code.

Response Lenses

updateStorageResponse_clusterArn :: Lens' UpdateStorageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateStorageResponse_clusterOperationArn :: Lens' UpdateStorageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster operation.

updateStorageResponse_httpStatus :: Lens' UpdateStorageResponse Int Source #

The response's http status code.