| 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.KeySpaces.Lens
Contents
Description
Synopsis
- createKeyspace_tags :: Lens' CreateKeyspace (Maybe (NonEmpty Tag))
- createKeyspace_keyspaceName :: Lens' CreateKeyspace Text
- createKeyspaceResponse_httpStatus :: Lens' CreateKeyspaceResponse Int
- createKeyspaceResponse_resourceArn :: Lens' CreateKeyspaceResponse Text
- createTable_capacitySpecification :: Lens' CreateTable (Maybe CapacitySpecification)
- createTable_comment :: Lens' CreateTable (Maybe Comment)
- createTable_defaultTimeToLive :: Lens' CreateTable (Maybe Natural)
- createTable_encryptionSpecification :: Lens' CreateTable (Maybe EncryptionSpecification)
- createTable_pointInTimeRecovery :: Lens' CreateTable (Maybe PointInTimeRecovery)
- createTable_tags :: Lens' CreateTable (Maybe (NonEmpty Tag))
- createTable_ttl :: Lens' CreateTable (Maybe TimeToLive)
- createTable_keyspaceName :: Lens' CreateTable Text
- createTable_tableName :: Lens' CreateTable Text
- createTable_schemaDefinition :: Lens' CreateTable SchemaDefinition
- createTableResponse_httpStatus :: Lens' CreateTableResponse Int
- createTableResponse_resourceArn :: Lens' CreateTableResponse Text
- deleteKeyspace_keyspaceName :: Lens' DeleteKeyspace Text
- deleteKeyspaceResponse_httpStatus :: Lens' DeleteKeyspaceResponse Int
- deleteTable_keyspaceName :: Lens' DeleteTable Text
- deleteTable_tableName :: Lens' DeleteTable Text
- deleteTableResponse_httpStatus :: Lens' DeleteTableResponse Int
- getKeyspace_keyspaceName :: Lens' GetKeyspace Text
- getKeyspaceResponse_httpStatus :: Lens' GetKeyspaceResponse Int
- getKeyspaceResponse_keyspaceName :: Lens' GetKeyspaceResponse Text
- getKeyspaceResponse_resourceArn :: Lens' GetKeyspaceResponse Text
- getTable_keyspaceName :: Lens' GetTable Text
- getTable_tableName :: Lens' GetTable Text
- getTableResponse_capacitySpecification :: Lens' GetTableResponse (Maybe CapacitySpecificationSummary)
- getTableResponse_comment :: Lens' GetTableResponse (Maybe Comment)
- getTableResponse_creationTimestamp :: Lens' GetTableResponse (Maybe UTCTime)
- getTableResponse_defaultTimeToLive :: Lens' GetTableResponse (Maybe Natural)
- getTableResponse_encryptionSpecification :: Lens' GetTableResponse (Maybe EncryptionSpecification)
- getTableResponse_pointInTimeRecovery :: Lens' GetTableResponse (Maybe PointInTimeRecoverySummary)
- getTableResponse_schemaDefinition :: Lens' GetTableResponse (Maybe SchemaDefinition)
- getTableResponse_status :: Lens' GetTableResponse (Maybe TableStatus)
- getTableResponse_ttl :: Lens' GetTableResponse (Maybe TimeToLive)
- getTableResponse_httpStatus :: Lens' GetTableResponse Int
- getTableResponse_keyspaceName :: Lens' GetTableResponse Text
- getTableResponse_tableName :: Lens' GetTableResponse Text
- getTableResponse_resourceArn :: Lens' GetTableResponse Text
- listKeyspaces_maxResults :: Lens' ListKeyspaces (Maybe Natural)
- listKeyspaces_nextToken :: Lens' ListKeyspaces (Maybe Text)
- listKeyspacesResponse_nextToken :: Lens' ListKeyspacesResponse (Maybe Text)
- listKeyspacesResponse_httpStatus :: Lens' ListKeyspacesResponse Int
- listKeyspacesResponse_keyspaces :: Lens' ListKeyspacesResponse [KeyspaceSummary]
- listTables_maxResults :: Lens' ListTables (Maybe Natural)
- listTables_nextToken :: Lens' ListTables (Maybe Text)
- listTables_keyspaceName :: Lens' ListTables Text
- listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text)
- listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [TableSummary])
- listTablesResponse_httpStatus :: Lens' ListTablesResponse Int
- listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)
- listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- restoreTable_capacitySpecificationOverride :: Lens' RestoreTable (Maybe CapacitySpecification)
- restoreTable_encryptionSpecificationOverride :: Lens' RestoreTable (Maybe EncryptionSpecification)
- restoreTable_pointInTimeRecoveryOverride :: Lens' RestoreTable (Maybe PointInTimeRecovery)
- restoreTable_restoreTimestamp :: Lens' RestoreTable (Maybe UTCTime)
- restoreTable_tagsOverride :: Lens' RestoreTable (Maybe (NonEmpty Tag))
- restoreTable_sourceKeyspaceName :: Lens' RestoreTable Text
- restoreTable_sourceTableName :: Lens' RestoreTable Text
- restoreTable_targetKeyspaceName :: Lens' RestoreTable Text
- restoreTable_targetTableName :: Lens' RestoreTable Text
- restoreTableResponse_httpStatus :: Lens' RestoreTableResponse Int
- restoreTableResponse_restoredTableARN :: Lens' RestoreTableResponse Text
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (NonEmpty Tag)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tags :: Lens' UntagResource (NonEmpty Tag)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- 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
- updateTableResponse_httpStatus :: Lens' UpdateTableResponse Int
- updateTableResponse_resourceArn :: Lens' UpdateTableResponse Text
- capacitySpecification_readCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
- capacitySpecification_writeCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
- capacitySpecification_throughputMode :: Lens' CapacitySpecification ThroughputMode
- capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp :: Lens' CapacitySpecificationSummary (Maybe UTCTime)
- capacitySpecificationSummary_readCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
- capacitySpecificationSummary_writeCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
- capacitySpecificationSummary_throughputMode :: Lens' CapacitySpecificationSummary ThroughputMode
- clusteringKey_name :: Lens' ClusteringKey Text
- clusteringKey_orderBy :: Lens' ClusteringKey SortOrder
- columnDefinition_name :: Lens' ColumnDefinition Text
- columnDefinition_type :: Lens' ColumnDefinition Text
- comment_message :: Lens' Comment Text
- encryptionSpecification_kmsKeyIdentifier :: Lens' EncryptionSpecification (Maybe Text)
- encryptionSpecification_type :: Lens' EncryptionSpecification EncryptionType
- keyspaceSummary_keyspaceName :: Lens' KeyspaceSummary Text
- keyspaceSummary_resourceArn :: Lens' KeyspaceSummary Text
- partitionKey_name :: Lens' PartitionKey Text
- pointInTimeRecovery_status :: Lens' PointInTimeRecovery PointInTimeRecoveryStatus
- pointInTimeRecoverySummary_earliestRestorableTimestamp :: Lens' PointInTimeRecoverySummary (Maybe UTCTime)
- pointInTimeRecoverySummary_status :: Lens' PointInTimeRecoverySummary PointInTimeRecoveryStatus
- schemaDefinition_clusteringKeys :: Lens' SchemaDefinition (Maybe [ClusteringKey])
- schemaDefinition_staticColumns :: Lens' SchemaDefinition (Maybe [StaticColumn])
- schemaDefinition_allColumns :: Lens' SchemaDefinition (NonEmpty ColumnDefinition)
- schemaDefinition_partitionKeys :: Lens' SchemaDefinition (NonEmpty PartitionKey)
- staticColumn_name :: Lens' StaticColumn Text
- tableSummary_keyspaceName :: Lens' TableSummary Text
- tableSummary_tableName :: Lens' TableSummary Text
- tableSummary_resourceArn :: Lens' TableSummary Text
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- timeToLive_status :: Lens' TimeToLive TimeToLiveStatus
Operations
CreateKeyspace
createKeyspace_tags :: Lens' CreateKeyspace (Maybe (NonEmpty Tag)) Source #
A list of key-value pair tags to be attached to the keyspace.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
createKeyspace_keyspaceName :: Lens' CreateKeyspace Text Source #
The name of the keyspace to be created.
createKeyspaceResponse_httpStatus :: Lens' CreateKeyspaceResponse Int Source #
The response's http status code.
createKeyspaceResponse_resourceArn :: Lens' CreateKeyspaceResponse Text Source #
The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
CreateTable
createTable_capacitySpecification :: Lens' CreateTable (Maybe CapacitySpecification) Source #
Specifies 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.
createTable_comment :: Lens' CreateTable (Maybe Comment) Source #
This parameter allows to enter a description of the table.
createTable_defaultTimeToLive :: Lens' CreateTable (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.
createTable_encryptionSpecification :: Lens' CreateTable (Maybe EncryptionSpecification) Source #
Specifies how the encryption key for encryption at rest is managed for 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 type:AWS_OWNED_KMS_KEY.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
createTable_pointInTimeRecovery :: Lens' CreateTable (Maybe PointInTimeRecovery) Source #
Specifies if pointInTimeRecovery is enabled or disabled for 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.
createTable_tags :: Lens' CreateTable (Maybe (NonEmpty Tag)) Source #
A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
createTable_ttl :: Lens' CreateTable (Maybe TimeToLive) Source #
Enables 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.
createTable_keyspaceName :: Lens' CreateTable Text Source #
The name of the keyspace that the table is going to be created in.
createTable_tableName :: Lens' CreateTable Text Source #
The name of the table.
createTable_schemaDefinition :: Lens' CreateTable SchemaDefinition Source #
The schemaDefinition consists of the following parameters.
For each column to be created:
• name - The name of the column.
• type - An Amazon Keyspaces data type. For more information, see
Data types
in the Amazon Keyspaces Developer Guide.
The primary key of the table consists of the following columns:
• partitionKeys - The partition key can be a single column, or it can
be a compound value composed of two or more columns. The partition key
portion of the primary key is required and determines how Amazon
Keyspaces stores your data.
• name - The name of each partition key column.
• clusteringKeys - The optional clustering column portion of your
primary key determines how the data is clustered and sorted within each
partition.
• name - The name of the clustering column.
• orderBy - Sets the ascendant (ASC) or descendant (DESC) order
modifier.
To define a column as static use staticColumns - Static columns store
values that are shared by all rows in the same partition:
• name - The name of the column.
• type - An Amazon Keyspaces data type.
createTableResponse_httpStatus :: Lens' CreateTableResponse Int Source #
The response's http status code.
createTableResponse_resourceArn :: Lens' CreateTableResponse Text Source #
The unique identifier of the table in the format of an Amazon Resource Name (ARN).
DeleteKeyspace
deleteKeyspace_keyspaceName :: Lens' DeleteKeyspace Text Source #
The name of the keyspace to be deleted.
deleteKeyspaceResponse_httpStatus :: Lens' DeleteKeyspaceResponse Int Source #
The response's http status code.
DeleteTable
deleteTable_keyspaceName :: Lens' DeleteTable Text Source #
The name of the keyspace of the to be deleted table.
deleteTable_tableName :: Lens' DeleteTable Text Source #
The name of the table to be deleted.
deleteTableResponse_httpStatus :: Lens' DeleteTableResponse Int Source #
The response's http status code.
GetKeyspace
getKeyspace_keyspaceName :: Lens' GetKeyspace Text Source #
The name of the keyspace.
getKeyspaceResponse_httpStatus :: Lens' GetKeyspaceResponse Int Source #
The response's http status code.
getKeyspaceResponse_keyspaceName :: Lens' GetKeyspaceResponse Text Source #
The name of the keyspace.
getKeyspaceResponse_resourceArn :: Lens' GetKeyspaceResponse Text Source #
The ARN of the keyspace.
GetTable
getTable_keyspaceName :: Lens' GetTable Text Source #
The name of the keyspace that the table is stored in.
getTableResponse_capacitySpecification :: Lens' GetTableResponse (Maybe CapacitySpecificationSummary) Source #
The read/write throughput capacity mode for a table. The options are:
• throughputMode:PAY_PER_REQUEST
• throughputMode:PROVISIONED
getTableResponse_comment :: Lens' GetTableResponse (Maybe Comment) Source #
The the description of the specified table.
getTableResponse_creationTimestamp :: Lens' GetTableResponse (Maybe UTCTime) Source #
The creation timestamp of the specified table.
getTableResponse_defaultTimeToLive :: Lens' GetTableResponse (Maybe Natural) Source #
The default Time to Live settings of the specified table.
getTableResponse_encryptionSpecification :: Lens' GetTableResponse (Maybe EncryptionSpecification) Source #
The encryption settings of the specified table.
getTableResponse_pointInTimeRecovery :: Lens' GetTableResponse (Maybe PointInTimeRecoverySummary) Source #
The point-in-time recovery status of the specified table.
getTableResponse_schemaDefinition :: Lens' GetTableResponse (Maybe SchemaDefinition) Source #
The schema definition of the specified table.
getTableResponse_status :: Lens' GetTableResponse (Maybe TableStatus) Source #
The current status of the specified table.
getTableResponse_ttl :: Lens' GetTableResponse (Maybe TimeToLive) Source #
The custom Time to Live settings of the specified table.
getTableResponse_httpStatus :: Lens' GetTableResponse Int Source #
The response's http status code.
getTableResponse_keyspaceName :: Lens' GetTableResponse Text Source #
The name of the keyspace that the specified table is stored in.
getTableResponse_tableName :: Lens' GetTableResponse Text Source #
The name of the specified table.
getTableResponse_resourceArn :: Lens' GetTableResponse Text Source #
The Amazon Resource Name (ARN) of the specified table.
ListKeyspaces
listKeyspaces_maxResults :: Lens' ListKeyspaces (Maybe Natural) Source #
The total number of keyspaces to return in the output. If the total
number of keyspaces available is more than the value specified, a
NextToken is provided in the output. To resume pagination, provide the
NextToken value as an argument of a subsequent API invocation.
listKeyspaces_nextToken :: Lens' ListKeyspaces (Maybe Text) Source #
The pagination token. To resume pagination, provide the NextToken
value as argument of a subsequent API invocation.
listKeyspacesResponse_nextToken :: Lens' ListKeyspacesResponse (Maybe Text) Source #
A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
listKeyspacesResponse_httpStatus :: Lens' ListKeyspacesResponse Int Source #
The response's http status code.
listKeyspacesResponse_keyspaces :: Lens' ListKeyspacesResponse [KeyspaceSummary] Source #
A list of keyspaces.
ListTables
listTables_maxResults :: Lens' ListTables (Maybe Natural) Source #
The total number of tables to return in the output. If the total number
of tables available is more than the value specified, a NextToken is
provided in the output. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
listTables_nextToken :: Lens' ListTables (Maybe Text) Source #
The pagination token. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
listTables_keyspaceName :: Lens' ListTables Text Source #
The name of the keyspace.
listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text) Source #
A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [TableSummary]) Source #
A list of tables.
listTablesResponse_httpStatus :: Lens' ListTablesResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #
The total number of tags to return in the output. If the total number of
tags available is more than the value specified, a NextToken is
provided in the output. To resume pagination, provide the NextToken
value as an argument of a subsequent API invocation.
listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #
The pagination token. To resume pagination, provide the NextToken
value as argument of a subsequent API invocation.
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
A token to specify where to start paginating. This is the NextToken
from a previously truncated response.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #
A list of tags.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
RestoreTable
restoreTable_capacitySpecificationOverride :: Lens' RestoreTable (Maybe CapacitySpecification) Source #
Specifies the read/write throughput capacity mode for the target table. The options are:
• throughputMode:PAY_PER_REQUEST
• 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.
restoreTable_encryptionSpecificationOverride :: Lens' RestoreTable (Maybe EncryptionSpecification) Source #
Specifies the encryption settings for the target 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 type:AWS_OWNED_KMS_KEY.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
restoreTable_pointInTimeRecoveryOverride :: Lens' RestoreTable (Maybe PointInTimeRecovery) Source #
Specifies the pointInTimeRecovery settings for the target 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.
restoreTable_restoreTimestamp :: Lens' RestoreTable (Maybe UTCTime) Source #
The restore timestamp in ISO 8601 format.
restoreTable_tagsOverride :: Lens' RestoreTable (Maybe (NonEmpty Tag)) Source #
A list of key-value pair tags to be attached to the restored table.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
restoreTable_sourceKeyspaceName :: Lens' RestoreTable Text Source #
The keyspace name of the source table.
restoreTable_sourceTableName :: Lens' RestoreTable Text Source #
The name of the source table.
restoreTable_targetKeyspaceName :: Lens' RestoreTable Text Source #
The name of the target keyspace.
restoreTable_targetTableName :: Lens' RestoreTable Text Source #
The name of the target table.
restoreTableResponse_httpStatus :: Lens' RestoreTableResponse Int Source #
The response's http status code.
restoreTableResponse_restoredTableARN :: Lens' RestoreTableResponse Text Source #
The Amazon Resource Name (ARN) of the restored table.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.
tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #
The tags to be assigned to the Amazon Keyspaces resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
untagResource_tags :: Lens' UntagResource (NonEmpty Tag) Source #
A list of existing tags to be removed from the Amazon Keyspaces resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateTable
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.
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.
Types
CapacitySpecification
capacitySpecification_readCapacityUnits :: Lens' CapacitySpecification (Maybe Natural) Source #
The throughput capacity specified for read operations defined in
read capacity units (RCUs).
capacitySpecification_writeCapacityUnits :: Lens' CapacitySpecification (Maybe Natural) Source #
The throughput capacity specified for write operations defined in
write capacity units (WCUs).
capacitySpecification_throughputMode :: Lens' CapacitySpecification ThroughputMode Source #
The read/write throughput capacity mode for a 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.
CapacitySpecificationSummary
capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp :: Lens' CapacitySpecificationSummary (Maybe UTCTime) Source #
The timestamp of the last operation that changed the provisioned throughput capacity of a table.
capacitySpecificationSummary_readCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural) Source #
The throughput capacity specified for read operations defined in
read capacity units (RCUs).
capacitySpecificationSummary_writeCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural) Source #
The throughput capacity specified for write operations defined in
write capacity units (WCUs).
capacitySpecificationSummary_throughputMode :: Lens' CapacitySpecificationSummary ThroughputMode Source #
The read/write throughput capacity mode for a 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.
ClusteringKey
clusteringKey_name :: Lens' ClusteringKey Text Source #
The name(s) of the clustering column(s).
clusteringKey_orderBy :: Lens' ClusteringKey SortOrder Source #
Sets the ascendant (ASC) or descendant (DESC) order modifier.
ColumnDefinition
columnDefinition_name :: Lens' ColumnDefinition Text Source #
The name of the column.
columnDefinition_type :: Lens' ColumnDefinition Text Source #
The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.
Comment
EncryptionSpecification
encryptionSpecification_kmsKeyIdentifier :: Lens' EncryptionSpecification (Maybe Text) Source #
The Amazon Resource Name (ARN) of the customer managed KMS key, for
example kms_key_identifier:ARN.
encryptionSpecification_type :: Lens' EncryptionSpecification EncryptionType Source #
The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):
• 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 type:AWS_OWNED_KMS_KEY.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
KeyspaceSummary
keyspaceSummary_keyspaceName :: Lens' KeyspaceSummary Text Source #
The name of the keyspace.
keyspaceSummary_resourceArn :: Lens' KeyspaceSummary Text Source #
The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
PartitionKey
partitionKey_name :: Lens' PartitionKey Text Source #
The name(s) of the partition key column(s).
PointInTimeRecovery
pointInTimeRecovery_status :: Lens' PointInTimeRecovery PointInTimeRecoveryStatus Source #
The options are:
• ENABLED
• DISABLED
PointInTimeRecoverySummary
pointInTimeRecoverySummary_earliestRestorableTimestamp :: Lens' PointInTimeRecoverySummary (Maybe UTCTime) Source #
Specifies the earliest possible restore point of the table in ISO 8601 format.
pointInTimeRecoverySummary_status :: Lens' PointInTimeRecoverySummary PointInTimeRecoveryStatus Source #
Shows if point-in-time recovery is enabled or disabled for the specified table.
SchemaDefinition
schemaDefinition_clusteringKeys :: Lens' SchemaDefinition (Maybe [ClusteringKey]) Source #
The columns that are part of the clustering key of the table.
schemaDefinition_staticColumns :: Lens' SchemaDefinition (Maybe [StaticColumn]) Source #
The columns that have been defined as STATIC. Static columns store
values that are shared by all rows in the same partition.
schemaDefinition_allColumns :: Lens' SchemaDefinition (NonEmpty ColumnDefinition) Source #
The regular columns of the table.
schemaDefinition_partitionKeys :: Lens' SchemaDefinition (NonEmpty PartitionKey) Source #
The columns that are part of the partition key of the table .
StaticColumn
staticColumn_name :: Lens' StaticColumn Text Source #
The name of the static column.
TableSummary
tableSummary_keyspaceName :: Lens' TableSummary Text Source #
The name of the keyspace that the table is stored in.
tableSummary_tableName :: Lens' TableSummary Text Source #
The name of the table.
tableSummary_resourceArn :: Lens' TableSummary Text Source #
The unique identifier of the table in the format of an Amazon Resource Name (ARN).
Tag
tag_key :: Lens' Tag Text Source #
The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
tag_value :: Lens' Tag Text Source #
The value of the tag. Tag values are case-sensitive and can be null.
TimeToLive
timeToLive_status :: Lens' TimeToLive TimeToLiveStatus Source #
Shows how to enable custom Time to Live (TTL) settings for the specified table.