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 |
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
Synopsis
- data UpdateTable = UpdateTable' {}
- newUpdateTable :: Text -> Text -> UpdateTable
- updateTable_addColumns :: Lens' UpdateTable (Maybe (NonEmpty ColumnDefinition))
- updateTable_capacitySpecification :: Lens' UpdateTable (Maybe CapacitySpecification)
- updateTable_defaultTimeToLive :: Lens' UpdateTable (Maybe Natural)
- updateTable_encryptionSpecification :: Lens' UpdateTable (Maybe EncryptionSpecification)
- updateTable_pointInTimeRecovery :: Lens' UpdateTable (Maybe PointInTimeRecovery)
- updateTable_ttl :: Lens' UpdateTable (Maybe TimeToLive)
- updateTable_keyspaceName :: Lens' UpdateTable Text
- updateTable_tableName :: Lens' UpdateTable Text
- data UpdateTableResponse = UpdateTableResponse' {
- httpStatus :: Int
- resourceArn :: Text
- newUpdateTableResponse :: Int -> Text -> UpdateTableResponse
- updateTableResponse_httpStatus :: Lens' UpdateTableResponse Int
- updateTableResponse_resourceArn :: Lens' UpdateTableResponse Text
Creating a Request
data UpdateTable Source #
See: newUpdateTable
smart constructor.
UpdateTable' | |
|
Instances
Create a value of UpdateTable
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:addColumns:UpdateTable'
, updateTable_addColumns
- For each column to be added to the specified table:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type. For more information, see
Data types
in the Amazon Keyspaces Developer Guide.
$sel:capacitySpecification:UpdateTable'
, updateTable_capacitySpecification
- Modifies the read/write throughput capacity mode for the table. The
options are:
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
- Provisioned capacity mode requires
readCapacityUnits
and writeCapacityUnits
as input.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
$sel:defaultTimeToLive:UpdateTable'
, updateTable_defaultTimeToLive
- The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
$sel:encryptionSpecification:UpdateTable'
, updateTable_encryptionSpecification
- Modifies the encryption settings of the table. You can choose one of the
following KMS key (KMS key):
• type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account
and is created, owned, and managed by you. This option requires the
kms_key_identifier
of the KMS key in Amazon Resource Name (ARN) format
as input.
The default is AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
$sel:pointInTimeRecovery:UpdateTable'
, updateTable_pointInTimeRecovery
- Modifies the pointInTimeRecovery
settings of the table. The options
are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
$sel:ttl:UpdateTable'
, updateTable_ttl
- Modifies Time to Live custom settings for the table. The options are:
• status:enabled
• status:disabled
The default is status:disabled
. After ttl
is enabled, you can't
disable it for the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
UpdateTable
, updateTable_keyspaceName
- The name of the keyspace the specified table is stored in.
UpdateTable
, updateTable_tableName
- The name of the table.
Request Lenses
updateTable_addColumns :: Lens' UpdateTable (Maybe (NonEmpty ColumnDefinition)) Source #
For each column to be added to the specified table:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type. For more information, see
Data types
in the Amazon Keyspaces Developer Guide.
updateTable_capacitySpecification :: Lens' UpdateTable (Maybe CapacitySpecification) Source #
Modifies the read/write throughput capacity mode for the table. The options are:
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
- Provisioned capacity mode requires
readCapacityUnits
and writeCapacityUnits
as input.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
updateTable_defaultTimeToLive :: Lens' UpdateTable (Maybe Natural) Source #
The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
updateTable_encryptionSpecification :: Lens' UpdateTable (Maybe EncryptionSpecification) Source #
Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):
• type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account
and is created, owned, and managed by you. This option requires the
kms_key_identifier
of the KMS key in Amazon Resource Name (ARN) format
as input.
The default is AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
updateTable_pointInTimeRecovery :: Lens' UpdateTable (Maybe PointInTimeRecovery) Source #
Modifies the pointInTimeRecovery
settings of the table. The options
are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
updateTable_ttl :: Lens' UpdateTable (Maybe TimeToLive) Source #
Modifies Time to Live custom settings for the table. The options are:
• status:enabled
• status:disabled
The default is status:disabled
. After ttl
is enabled, you can't
disable it for the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
updateTable_keyspaceName :: Lens' UpdateTable Text Source #
The name of the keyspace the specified table is stored in.
updateTable_tableName :: Lens' UpdateTable Text Source #
The name of the table.
Destructuring the Response
data UpdateTableResponse Source #
See: newUpdateTableResponse
smart constructor.
UpdateTableResponse' | |
|
Instances
newUpdateTableResponse Source #
Create a value of UpdateTableResponse
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:UpdateTableResponse'
, updateTableResponse_httpStatus
- The response's http status code.
UpdateTableResponse
, updateTableResponse_resourceArn
- The Amazon Resource Name (ARN) of the modified table.
Response Lenses
updateTableResponse_httpStatus :: Lens' UpdateTableResponse Int Source #
The response's http status code.
updateTableResponse_resourceArn :: Lens' UpdateTableResponse Text Source #
The Amazon Resource Name (ARN) of the modified table.