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 |
- Service Configuration
- Errors
- EncryptionType
- PointInTimeRecoveryStatus
- SortOrder
- TableStatus
- ThroughputMode
- TimeToLiveStatus
- CapacitySpecification
- CapacitySpecificationSummary
- ClusteringKey
- ColumnDefinition
- Comment
- EncryptionSpecification
- KeyspaceSummary
- PartitionKey
- PointInTimeRecovery
- PointInTimeRecoverySummary
- SchemaDefinition
- StaticColumn
- TableSummary
- Tag
- TimeToLive
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype EncryptionType where
- newtype PointInTimeRecoveryStatus where
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASC :: SortOrder
- pattern SortOrder_DESC :: SortOrder
- newtype TableStatus where
- TableStatus' { }
- pattern TableStatus_ACTIVE :: TableStatus
- pattern TableStatus_CREATING :: TableStatus
- pattern TableStatus_DELETED :: TableStatus
- pattern TableStatus_DELETING :: TableStatus
- pattern TableStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: TableStatus
- pattern TableStatus_RESTORING :: TableStatus
- pattern TableStatus_UPDATING :: TableStatus
- newtype ThroughputMode where
- ThroughputMode' { }
- pattern ThroughputMode_PAY_PER_REQUEST :: ThroughputMode
- pattern ThroughputMode_PROVISIONED :: ThroughputMode
- newtype TimeToLiveStatus where
- TimeToLiveStatus' { }
- pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus
- data CapacitySpecification = CapacitySpecification' {}
- newCapacitySpecification :: ThroughputMode -> CapacitySpecification
- capacitySpecification_readCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
- capacitySpecification_writeCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
- capacitySpecification_throughputMode :: Lens' CapacitySpecification ThroughputMode
- data CapacitySpecificationSummary = CapacitySpecificationSummary' {}
- newCapacitySpecificationSummary :: ThroughputMode -> CapacitySpecificationSummary
- capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp :: Lens' CapacitySpecificationSummary (Maybe UTCTime)
- capacitySpecificationSummary_readCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
- capacitySpecificationSummary_writeCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
- capacitySpecificationSummary_throughputMode :: Lens' CapacitySpecificationSummary ThroughputMode
- data ClusteringKey = ClusteringKey' {}
- newClusteringKey :: Text -> SortOrder -> ClusteringKey
- clusteringKey_name :: Lens' ClusteringKey Text
- clusteringKey_orderBy :: Lens' ClusteringKey SortOrder
- data ColumnDefinition = ColumnDefinition' {}
- newColumnDefinition :: Text -> Text -> ColumnDefinition
- columnDefinition_name :: Lens' ColumnDefinition Text
- columnDefinition_type :: Lens' ColumnDefinition Text
- data Comment = Comment' {}
- newComment :: Text -> Comment
- comment_message :: Lens' Comment Text
- data EncryptionSpecification = EncryptionSpecification' {}
- newEncryptionSpecification :: EncryptionType -> EncryptionSpecification
- encryptionSpecification_kmsKeyIdentifier :: Lens' EncryptionSpecification (Maybe Text)
- encryptionSpecification_type :: Lens' EncryptionSpecification EncryptionType
- data KeyspaceSummary = KeyspaceSummary' {
- keyspaceName :: Text
- resourceArn :: Text
- newKeyspaceSummary :: Text -> Text -> KeyspaceSummary
- keyspaceSummary_keyspaceName :: Lens' KeyspaceSummary Text
- keyspaceSummary_resourceArn :: Lens' KeyspaceSummary Text
- data PartitionKey = PartitionKey' {}
- newPartitionKey :: Text -> PartitionKey
- partitionKey_name :: Lens' PartitionKey Text
- data PointInTimeRecovery = PointInTimeRecovery' {}
- newPointInTimeRecovery :: PointInTimeRecoveryStatus -> PointInTimeRecovery
- pointInTimeRecovery_status :: Lens' PointInTimeRecovery PointInTimeRecoveryStatus
- data PointInTimeRecoverySummary = PointInTimeRecoverySummary' {}
- newPointInTimeRecoverySummary :: PointInTimeRecoveryStatus -> PointInTimeRecoverySummary
- pointInTimeRecoverySummary_earliestRestorableTimestamp :: Lens' PointInTimeRecoverySummary (Maybe UTCTime)
- pointInTimeRecoverySummary_status :: Lens' PointInTimeRecoverySummary PointInTimeRecoveryStatus
- data SchemaDefinition = SchemaDefinition' {}
- newSchemaDefinition :: NonEmpty ColumnDefinition -> NonEmpty PartitionKey -> SchemaDefinition
- schemaDefinition_clusteringKeys :: Lens' SchemaDefinition (Maybe [ClusteringKey])
- schemaDefinition_staticColumns :: Lens' SchemaDefinition (Maybe [StaticColumn])
- schemaDefinition_allColumns :: Lens' SchemaDefinition (NonEmpty ColumnDefinition)
- schemaDefinition_partitionKeys :: Lens' SchemaDefinition (NonEmpty PartitionKey)
- data StaticColumn = StaticColumn' {}
- newStaticColumn :: Text -> StaticColumn
- staticColumn_name :: Lens' StaticColumn Text
- data TableSummary = TableSummary' {
- keyspaceName :: Text
- tableName :: Text
- resourceArn :: Text
- newTableSummary :: Text -> Text -> Text -> TableSummary
- tableSummary_keyspaceName :: Lens' TableSummary Text
- tableSummary_tableName :: Lens' TableSummary Text
- tableSummary_resourceArn :: Lens' TableSummary Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TimeToLive = TimeToLive' {}
- newTimeToLive :: TimeToLiveStatus -> TimeToLive
- timeToLive_status :: Lens' TimeToLive TimeToLiveStatus
Service Configuration
defaultService :: Service Source #
API version 2022-02-10
of the Amazon Keyspaces SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
Amazon Keyspaces could not complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Amazon Keyspaces was unable to fully process this request because of an internal server error.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The operation tried to access a keyspace or table that doesn't exist.
The resource might not be specified correctly, or its status might not
be ACTIVE
.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
_ValidationException :: AsError a => Fold a ServiceError Source #
The operation failed due to an invalid or malformed request.
EncryptionType
newtype EncryptionType Source #
pattern EncryptionType_AWS_OWNED_KMS_KEY :: EncryptionType | |
pattern EncryptionType_CUSTOMER_MANAGED_KMS_KEY :: EncryptionType |
Instances
PointInTimeRecoveryStatus
newtype PointInTimeRecoveryStatus Source #
pattern PointInTimeRecoveryStatus_DISABLED :: PointInTimeRecoveryStatus | |
pattern PointInTimeRecoveryStatus_ENABLED :: PointInTimeRecoveryStatus |
Instances
SortOrder
pattern SortOrder_ASC :: SortOrder | |
pattern SortOrder_DESC :: SortOrder |
Instances
TableStatus
newtype TableStatus Source #
pattern TableStatus_ACTIVE :: TableStatus | |
pattern TableStatus_CREATING :: TableStatus | |
pattern TableStatus_DELETED :: TableStatus | |
pattern TableStatus_DELETING :: TableStatus | |
pattern TableStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: TableStatus | |
pattern TableStatus_RESTORING :: TableStatus | |
pattern TableStatus_UPDATING :: TableStatus |
Instances
ThroughputMode
newtype ThroughputMode Source #
pattern ThroughputMode_PAY_PER_REQUEST :: ThroughputMode | |
pattern ThroughputMode_PROVISIONED :: ThroughputMode |
Instances
TimeToLiveStatus
newtype TimeToLiveStatus Source #
pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus |
Instances
CapacitySpecification
data CapacitySpecification Source #
Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables:
• On-demand (default)
• Provisioned
The read/write capacity mode that you choose controls how you are charged for read and write throughput and how table throughput capacity is managed.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
See: newCapacitySpecification
smart constructor.
CapacitySpecification' | |
|
Instances
newCapacitySpecification Source #
Create a value of CapacitySpecification
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:readCapacityUnits:CapacitySpecification'
, capacitySpecification_readCapacityUnits
- The throughput capacity specified for read
operations defined in
read capacity units
(RCUs)
.
$sel:writeCapacityUnits:CapacitySpecification'
, capacitySpecification_writeCapacityUnits
- The throughput capacity specified for write
operations defined in
write capacity units
(WCUs)
.
$sel:throughputMode:CapacitySpecification'
, capacitySpecification_throughputMode
- 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.
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
data CapacitySpecificationSummary Source #
The read/write throughput capacity mode for a table. The options are:
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
See: newCapacitySpecificationSummary
smart constructor.
CapacitySpecificationSummary' | |
|
Instances
newCapacitySpecificationSummary Source #
Create a value of CapacitySpecificationSummary
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:lastUpdateToPayPerRequestTimestamp:CapacitySpecificationSummary'
, capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp
- The timestamp of the last operation that changed the provisioned
throughput capacity of a table.
$sel:readCapacityUnits:CapacitySpecificationSummary'
, capacitySpecificationSummary_readCapacityUnits
- The throughput capacity specified for read
operations defined in
read capacity units
(RCUs)
.
$sel:writeCapacityUnits:CapacitySpecificationSummary'
, capacitySpecificationSummary_writeCapacityUnits
- The throughput capacity specified for write
operations defined in
write capacity units
(WCUs)
.
$sel:throughputMode:CapacitySpecificationSummary'
, capacitySpecificationSummary_throughputMode
- 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_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
data ClusteringKey Source #
The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.
See: newClusteringKey
smart constructor.
Instances
Create a value of ClusteringKey
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:name:ClusteringKey'
, clusteringKey_name
- The name(s) of the clustering column(s).
$sel:orderBy:ClusteringKey'
, clusteringKey_orderBy
- Sets the ascendant (ASC
) or descendant (DESC
) order modifier.
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
data ColumnDefinition Source #
The names and data types of regular columns.
See: newColumnDefinition
smart constructor.
ColumnDefinition' | |
|
Instances
Create a value of ColumnDefinition
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:name:ColumnDefinition'
, columnDefinition_name
- The name of the column.
$sel:type':ColumnDefinition'
, columnDefinition_type
- The data type of the column. For a list of available data types, see
Data types
in the Amazon Keyspaces Developer Guide.
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
An optional comment that describes the table.
See: newComment
smart constructor.
Instances
FromJSON Comment Source # | |
ToJSON Comment Source # | |
Defined in Amazonka.KeySpaces.Types.Comment | |
Generic Comment Source # | |
Read Comment Source # | |
Show Comment Source # | |
NFData Comment Source # | |
Defined in Amazonka.KeySpaces.Types.Comment | |
Eq Comment Source # | |
Hashable Comment Source # | |
Defined in Amazonka.KeySpaces.Types.Comment | |
type Rep Comment Source # | |
Defined in Amazonka.KeySpaces.Types.Comment |
Create a value of Comment
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:message:Comment'
, comment_message
- An optional description of the table.
EncryptionSpecification
data EncryptionSpecification Source #
Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):
• Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge).
• Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).
For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest in the Amazon Keyspaces Developer Guide.
For more information about KMS, see KMS management service concepts in the Key Management Service Developer Guide.
See: newEncryptionSpecification
smart constructor.
EncryptionSpecification' | |
|
Instances
newEncryptionSpecification Source #
Create a value of EncryptionSpecification
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:kmsKeyIdentifier:EncryptionSpecification'
, encryptionSpecification_kmsKeyIdentifier
- The Amazon Resource Name (ARN) of the customer managed KMS key, for
example kms_key_identifier:ARN
.
$sel:type':EncryptionSpecification'
, encryptionSpecification_type
- 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.
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
data KeyspaceSummary Source #
Represents the properties of a keyspace.
See: newKeyspaceSummary
smart constructor.
KeyspaceSummary' | |
|
Instances
Create a value of KeyspaceSummary
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:keyspaceName:KeyspaceSummary'
, keyspaceSummary_keyspaceName
- The name of the keyspace.
$sel:resourceArn:KeyspaceSummary'
, keyspaceSummary_resourceArn
- The unique identifier of the keyspace in the format of an Amazon
Resource Name (ARN).
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
data PartitionKey Source #
The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns.
See: newPartitionKey
smart constructor.
Instances
Create a value of PartitionKey
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:name:PartitionKey'
, partitionKey_name
- The name(s) of the partition key column(s).
partitionKey_name :: Lens' PartitionKey Text Source #
The name(s) of the partition key column(s).
PointInTimeRecovery
data PointInTimeRecovery Source #
Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
See: newPointInTimeRecovery
smart constructor.
PointInTimeRecovery' | |
|
Instances
newPointInTimeRecovery Source #
Create a value of PointInTimeRecovery
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:status:PointInTimeRecovery'
, pointInTimeRecovery_status
- The options are:
• ENABLED
• DISABLED
pointInTimeRecovery_status :: Lens' PointInTimeRecovery PointInTimeRecoveryStatus Source #
The options are:
• ENABLED
• DISABLED
PointInTimeRecoverySummary
data PointInTimeRecoverySummary Source #
The point-in-time recovery status of the specified table.
See: newPointInTimeRecoverySummary
smart constructor.
PointInTimeRecoverySummary' | |
|
Instances
newPointInTimeRecoverySummary Source #
Create a value of PointInTimeRecoverySummary
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:earliestRestorableTimestamp:PointInTimeRecoverySummary'
, pointInTimeRecoverySummary_earliestRestorableTimestamp
- Specifies the earliest possible restore point of the table in ISO 8601
format.
$sel:status:PointInTimeRecoverySummary'
, pointInTimeRecoverySummary_status
- Shows if point-in-time recovery is enabled or disabled for the specified
table.
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
data SchemaDefinition Source #
Describes the schema of the table.
See: newSchemaDefinition
smart constructor.
SchemaDefinition' | |
|
Instances
Create a value of SchemaDefinition
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:clusteringKeys:SchemaDefinition'
, schemaDefinition_clusteringKeys
- The columns that are part of the clustering key of the table.
$sel:staticColumns:SchemaDefinition'
, schemaDefinition_staticColumns
- The columns that have been defined as STATIC
. Static columns store
values that are shared by all rows in the same partition.
$sel:allColumns:SchemaDefinition'
, schemaDefinition_allColumns
- The regular columns of the table.
$sel:partitionKeys:SchemaDefinition'
, schemaDefinition_partitionKeys
- The columns that are part of the partition key of the table .
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
data StaticColumn Source #
The static columns of the table. Static columns store values that are shared by all rows in the same partition.
See: newStaticColumn
smart constructor.
Instances
Create a value of StaticColumn
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:name:StaticColumn'
, staticColumn_name
- The name of the static column.
staticColumn_name :: Lens' StaticColumn Text Source #
The name of the static column.
TableSummary
data TableSummary Source #
Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).
See: newTableSummary
smart constructor.
TableSummary' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> TableSummary |
Create a value of TableSummary
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:keyspaceName:TableSummary'
, tableSummary_keyspaceName
- The name of the keyspace that the table is stored in.
$sel:tableName:TableSummary'
, tableSummary_tableName
- The name of the table.
$sel:resourceArn:TableSummary'
, tableSummary_resourceArn
- The unique identifier of the table in the format of an Amazon Resource
Name (ARN).
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
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.
Amazon Web Services-assigned tag names and values are automatically
assigned the aws:
prefix, which the user cannot assign. Amazon Web
Services-assigned tag names do not count towards the tag limit of 50.
User-assigned tag names have the prefix user:
in the Cost Allocation
Report. You cannot backdate the application of a tag.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
See: newTag
smart constructor.
Tag' | |
|
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.KeySpaces.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.KeySpaces.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.KeySpaces.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.KeySpaces.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.KeySpaces.Types.Tag" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
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:key:Tag'
, tag_key
- 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.
$sel:value:Tag'
, tag_value
- The value of the tag. Tag values are case-sensitive and can be null.
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
data TimeToLive Source #
Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.
For more information, see Enabling TTL on tables in the Amazon Keyspaces Developer Guide.
See: newTimeToLive
smart constructor.
TimeToLive' | |
|
Instances
Create a value of TimeToLive
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:status:TimeToLive'
, timeToLive_status
- Shows how to enable custom Time to Live (TTL) settings for the specified
table.
timeToLive_status :: Lens' TimeToLive TimeToLiveStatus Source #
Shows how to enable custom Time to Live (TTL) settings for the specified table.