types

package
v1.16.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 4 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have sufficient access permissions to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AutoScalingPolicy added in v1.8.0 

type AutoScalingPolicy struct {

	// Auto scaling scales up capacity automatically when traffic exceeds this target
	// utilization rate, and then back down when it falls below the target. A double
	// between 20 and 90.
	TargetTrackingScalingPolicyConfiguration *TargetTrackingScalingPolicyConfiguration
	// contains filtered or unexported fields
}

Amazon Keyspaces supports the target tracking auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.

type AutoScalingSettings added in v1.8.0 

type AutoScalingSettings struct {

	// This optional parameter enables auto scaling for the table if set to false .
	AutoScalingDisabled bool

	// Manage costs by specifying the maximum amount of throughput to provision. The
	// value must be between 1 and the max throughput per second quota for your account
	// (40,000 by default).
	MaximumUnits *int64

	// The minimum level of throughput the table should always be ready to support.
	// The value must be between 1 and the max throughput per second quota for your
	// account (40,000 by default).
	MinimumUnits *int64

	// Amazon Keyspaces supports the target tracking auto scaling policy. With this
	// policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed
	// to provisioned capacity stays at or near the target value that you specify. You
	// define the target value as a percentage between 20 and 90.
	ScalingPolicy *AutoScalingPolicy
	// contains filtered or unexported fields
}

The optional auto scaling settings for a table with provisioned throughput capacity.

To turn on auto scaling for a table in throughputMode:PROVISIONED , you must specify the following parameters.

Configure the minimum and maximum capacity units. The auto scaling policy ensures that capacity never goes below the minimum or above the maximum range.

  • minimumUnits : The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

  • maximumUnits : The maximum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).

  • scalingPolicy : Amazon Keyspaces supports the target tracking scaling policy. The auto scaling target is the provisioned capacity of the table.

  • targetTrackingScalingPolicyConfiguration : To define the target tracking policy, you must define the target value.

  • targetValue : The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90. (Required)

  • disableScaleIn : A boolean that specifies if scale-in is disabled or enabled for the table. This parameter is disabled by default. To turn on scale-in , set the boolean value to FALSE . This means that capacity for a table can be automatically scaled down on your behalf. (Optional)

  • scaleInCooldown : A cooldown period in seconds between scaling activities that lets the table stabilize before another scale in activity starts. If no value is provided, the default is 0. (Optional)

  • scaleOutCooldown : A cooldown period in seconds between scaling activities that lets the table stabilize before another scale out activity starts. If no value is provided, the default is 0. (Optional)

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

type AutoScalingSpecification added in v1.8.0 

type AutoScalingSpecification struct {

	// The auto scaling settings for the table's read capacity.
	ReadCapacityAutoScaling *AutoScalingSettings

	// The auto scaling settings for the table's write capacity.
	WriteCapacityAutoScaling *AutoScalingSettings
	// contains filtered or unexported fields
}

The optional auto scaling capacity settings for a table in provisioned capacity mode.

type CapacitySpecification 

type CapacitySpecification struct {

	// 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.
	//
	// [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html
	//
	// This member is required.
	ThroughputMode ThroughputMode

	// The throughput capacity specified for read operations defined in read capacity
	// units (RCUs) .
	ReadCapacityUnits *int64

	// The throughput capacity specified for write operations defined in write
	// capacity units (WCUs) .
	WriteCapacityUnits *int64
	// contains filtered or unexported fields
}

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.

type CapacitySpecificationSummary 

type CapacitySpecificationSummary struct {

	// 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.
	//
	// [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html
	//
	// This member is required.
	ThroughputMode ThroughputMode

	// The timestamp of the last operation that changed the provisioned throughput
	// capacity of a table.
	LastUpdateToPayPerRequestTimestamp *time.Time

	// The throughput capacity specified for read operations defined in read capacity
	// units (RCUs) .
	ReadCapacityUnits *int64

	// The throughput capacity specified for write operations defined in write
	// capacity units (WCUs) .
	WriteCapacityUnits *int64
	// contains filtered or unexported fields
}

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.

type ClientSideTimestamps added in v1.2.0 

type ClientSideTimestamps struct {

	// Shows how to enable client-side timestamps settings for the specified table.
	//
	// This member is required.
	Status ClientSideTimestampsStatus
	// contains filtered or unexported fields
}

The client-side timestamp setting of the table.

For more information, see How it works: Amazon Keyspaces client-side timestamps in the Amazon Keyspaces Developer Guide.

type ClientSideTimestampsStatus added in v1.2.0 

type ClientSideTimestampsStatus string
const (
	ClientSideTimestampsStatusEnabled ClientSideTimestampsStatus = "ENABLED"
)

Enum values for ClientSideTimestampsStatus

func (ClientSideTimestampsStatus) Values added in v1.2.0 

func (ClientSideTimestampsStatus) Values() []ClientSideTimestampsStatus

Values returns all known values for ClientSideTimestampsStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ClusteringKey 

type ClusteringKey struct {

	// The name(s) of the clustering column(s).
	//
	// This member is required.
	Name *string

	// Sets the ascendant ( ASC ) or descendant ( DESC ) order modifier.
	//
	// This member is required.
	OrderBy SortOrder
	// contains filtered or unexported fields
}

The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

type ColumnDefinition 

type ColumnDefinition struct {

	// The name of the column.
	//
	// This member is required.
	Name *string

	// The data type of the column. For a list of available data types, see [Data types] in the
	// Amazon Keyspaces Developer Guide.
	//
	// [Data types]: https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

The names and data types of regular columns.

type Comment 

type Comment struct {

	// An optional description of the table.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

An optional comment that describes the table.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Amazon Keyspaces couldn't 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.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type EncryptionSpecification 

type EncryptionSpecification struct {

	// 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.
	//
	// [Encryption at rest]: https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html
	//
	// This member is required.
	Type EncryptionType

	// The Amazon Resource Name (ARN) of the customer managed KMS key, for example
	// kms_key_identifier:ARN .
	KmsKeyIdentifier *string
	// contains filtered or unexported fields
}

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.

type EncryptionType 

type EncryptionType string
const (
	EncryptionTypeCustomerManagedKmsKey EncryptionType = "CUSTOMER_MANAGED_KMS_KEY"
	EncryptionTypeAwsOwnedKmsKey        EncryptionType = "AWS_OWNED_KMS_KEY"
)

Enum values for EncryptionType

func (EncryptionType) Values 

func (EncryptionType) Values() []EncryptionType

Values returns all known values for EncryptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FieldDefinition added in v1.15.0 

type FieldDefinition struct {

	//  The identifier.
	//
	// This member is required.
	Name *string

	//  Any supported Cassandra data type, including collections and other
	// user-defined types that are contained in the same keyspace.
	//
	// For more information, see [Cassandra data type support] in the Amazon Keyspaces Developer Guide.
	//
	// [Cassandra data type support]: https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html#cassandra-data-type
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

A field definition consists out of a name and a type.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Amazon Keyspaces was unable to fully process this request because of an internal server error.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type KeyspaceStatus added in v1.16.0 

type KeyspaceStatus string
const (
	KeyspaceStatusActive   KeyspaceStatus = "ACTIVE"
	KeyspaceStatusCreating KeyspaceStatus = "CREATING"
	KeyspaceStatusUpdating KeyspaceStatus = "UPDATING"
	KeyspaceStatusDeleting KeyspaceStatus = "DELETING"
)

Enum values for KeyspaceStatus

func (KeyspaceStatus) Values added in v1.16.0 

func (KeyspaceStatus) Values() []KeyspaceStatus

Values returns all known values for KeyspaceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KeyspaceSummary 

type KeyspaceSummary struct {

	// The name of the keyspace.
	//
	// This member is required.
	KeyspaceName *string

	//  This property specifies if a keyspace is a single Region keyspace or a
	// multi-Region keyspace. The available values are SINGLE_REGION or MULTI_REGION .
	//
	// This member is required.
	ReplicationStrategy Rs

	// The unique identifier of the keyspace in the format of an Amazon Resource Name
	// (ARN).
	//
	// This member is required.
	ResourceArn *string

	//  If the replicationStrategy of the keyspace is MULTI_REGION , a list of
	// replication Regions is returned.
	ReplicationRegions []string
	// contains filtered or unexported fields
}

Represents the properties of a keyspace.

type PartitionKey 

type PartitionKey struct {

	// The name(s) of the partition key column(s).
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

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.

type PointInTimeRecovery 

type PointInTimeRecovery struct {

	// The options are:
	//
	//   - status=ENABLED
	//
	//   - status=DISABLED
	//
	// This member is required.
	Status PointInTimeRecoveryStatus
	// contains filtered or unexported fields
}

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.

type PointInTimeRecoveryStatus 

type PointInTimeRecoveryStatus string
const (
	PointInTimeRecoveryStatusEnabled  PointInTimeRecoveryStatus = "ENABLED"
	PointInTimeRecoveryStatusDisabled PointInTimeRecoveryStatus = "DISABLED"
)

Enum values for PointInTimeRecoveryStatus

func (PointInTimeRecoveryStatus) Values 

func (PointInTimeRecoveryStatus) Values() []PointInTimeRecoveryStatus

Values returns all known values for PointInTimeRecoveryStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PointInTimeRecoverySummary 

type PointInTimeRecoverySummary struct {

	// Shows if point-in-time recovery is enabled or disabled for the specified table.
	//
	// This member is required.
	Status PointInTimeRecoveryStatus

	// Specifies the earliest possible restore point of the table in ISO 8601 format.
	EarliestRestorableTimestamp *time.Time
	// contains filtered or unexported fields
}

The point-in-time recovery status of the specified table.

type ReplicaAutoScalingSpecification added in v1.8.0 

type ReplicaAutoScalingSpecification struct {

	// The auto scaling settings for a multi-Region table in the specified Amazon Web
	// Services Region.
	AutoScalingSpecification *AutoScalingSpecification

	// The Amazon Web Services Region.
	Region *string
	// contains filtered or unexported fields
}

The auto scaling settings of a multi-Region table in the specified Amazon Web Services Region.

type ReplicaSpecification added in v1.8.0 

type ReplicaSpecification struct {

	// The Amazon Web Services Region.
	//
	// This member is required.
	Region *string

	// The read capacity auto scaling settings for the multi-Region table in the
	// specified Amazon Web Services Region.
	ReadCapacityAutoScaling *AutoScalingSettings

	// The provisioned read capacity units for the multi-Region table in the specified
	// Amazon Web Services Region.
	ReadCapacityUnits *int64
	// contains filtered or unexported fields
}

The Amazon Web Services Region specific settings of a multi-Region table.

For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters.

  • region : The Region where these settings are applied. (Required)

  • readCapacityUnits : The provisioned read capacity units. (Optional)

  • readCapacityAutoScaling : The read capacity auto scaling settings for the table. (Optional)

type ReplicaSpecificationSummary added in v1.8.0 

type ReplicaSpecificationSummary struct {

	// 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.
	//
	// [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html
	CapacitySpecification *CapacitySpecificationSummary

	// The Amazon Web Services Region.
	Region *string

	// The status of the multi-Region table in the specified Amazon Web Services
	// Region.
	Status TableStatus
	// contains filtered or unexported fields
}

The Region-specific settings of a multi-Region table in the specified Amazon Web Services Region.

If the multi-Region table is using provisioned capacity and has optional auto scaling policies configured, note that the Region specific summary returns both read and write capacity settings. But only Region specific read capacity settings can be configured for a multi-Region table. In a multi-Region table, your write capacity units will be synced across all Amazon Web Services Regions to ensure that there is enough capacity to replicate write events across Regions.

type ReplicationGroupStatus added in v1.16.0 

type ReplicationGroupStatus struct {

	//  The status of the keyspace.
	//
	// This member is required.
	KeyspaceStatus KeyspaceStatus

	//  The name of the Region that was added to the keyspace.
	//
	// This member is required.
	Region *string

	//  This shows the replication progress of tables in the keyspace. The value is
	// expressed as a percentage of the newly replicated tables with status Active
	// compared to the total number of tables in the keyspace.
	TablesReplicationProgress *string
	// contains filtered or unexported fields
}
This shows the summary status of the keyspace after a new Amazon Web Services

Region was added.

type ReplicationSpecification added in v1.3.0 

type ReplicationSpecification struct {

	//  The replicationStrategy of a keyspace, the required value is SINGLE_REGION or
	// MULTI_REGION .
	//
	// This member is required.
	ReplicationStrategy Rs

	//  The regionList can contain up to six Amazon Web Services Regions where the
	// keyspace is replicated in.
	RegionList []string
	// contains filtered or unexported fields
}

The replication specification of the keyspace includes:

  • regionList - up to six Amazon Web Services Regions where the keyspace is replicated in.

  • replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION .

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceArn *string
	// contains filtered or unexported fields
}

The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE .

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type Rs added in v1.3.0 

type Rs string
const (
	RsSingleRegion Rs = "SINGLE_REGION"
	RsMultiRegion  Rs = "MULTI_REGION"
)

Enum values for Rs

func (Rs) Values added in v1.3.0 

func (Rs) Values() []Rs

Values returns all known values for Rs. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SchemaDefinition 

type SchemaDefinition struct {

	// The regular columns of the table.
	//
	// This member is required.
	AllColumns []ColumnDefinition

	// The columns that are part of the partition key of the table .
	//
	// This member is required.
	PartitionKeys []PartitionKey

	// The columns that are part of the clustering key of the table.
	ClusteringKeys []ClusteringKey

	// The columns that have been defined as STATIC . Static columns store values that
	// are shared by all rows in the same partition.
	StaticColumns []StaticColumn
	// contains filtered or unexported fields
}

Describes the schema of the table.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation exceeded the service quota for this resource. For more information on service quotas, see Quotasin the Amazon Keyspaces Developer Guide.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SortOrder 

type SortOrder string
const (
	SortOrderAsc  SortOrder = "ASC"
	SortOrderDesc SortOrder = "DESC"
)

Enum values for SortOrder

func (SortOrder) Values 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StaticColumn 

type StaticColumn struct {

	// The name of the static column.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The static columns of the table. Static columns store values that are shared by all rows in the same partition.

type TableStatus 

type TableStatus string
const (
	TableStatusActive                            TableStatus = "ACTIVE"
	TableStatusCreating                          TableStatus = "CREATING"
	TableStatusUpdating                          TableStatus = "UPDATING"
	TableStatusDeleting                          TableStatus = "DELETING"
	TableStatusDeleted                           TableStatus = "DELETED"
	TableStatusRestoring                         TableStatus = "RESTORING"
	TableStatusInaccessibleEncryptionCredentials TableStatus = "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
)

Enum values for TableStatus

func (TableStatus) Values 

func (TableStatus) Values() []TableStatus

Values returns all known values for TableStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TableSummary 

type TableSummary struct {

	// The name of the keyspace that the table is stored in.
	//
	// This member is required.
	KeyspaceName *string

	// The unique identifier of the table in the format of an Amazon Resource Name
	// (ARN).
	//
	// This member is required.
	ResourceArn *string

	// The name of the table.
	//
	// This member is required.
	TableName *string
	// contains filtered or unexported fields
}

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).

type Tag 

type Tag struct {

	// 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.
	//
	// This member is required.
	Key *string

	// The value of the tag. Tag values are case-sensitive and can be null.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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.

type TargetTrackingScalingPolicyConfiguration added in v1.8.0 

type TargetTrackingScalingPolicyConfiguration struct {

	// Specifies the target value for the target tracking auto scaling policy.
	//
	// Amazon Keyspaces auto scaling scales up capacity automatically when traffic
	// exceeds this target utilization rate, and then back down when it falls below the
	// target. This ensures that the ratio of consumed capacity to provisioned capacity
	// stays at or near this value. You define targetValue as a percentage. A double
	// between 20 and 90.
	//
	// This member is required.
	TargetValue float64

	// Specifies if scale-in is enabled.
	//
	// When auto scaling automatically decreases capacity for a table, the table
	// scales in. When scaling policies are set, they can't scale in the table lower
	// than its minimum capacity.
	DisableScaleIn bool

	// Specifies a scale-in cool down period.
	//
	// A cooldown period in seconds between scaling activities that lets the table
	// stabilize before another scaling activity starts.
	ScaleInCooldown int32

	// Specifies a scale out cool down period.
	//
	// A cooldown period in seconds between scaling activities that lets the table
	// stabilize before another scaling activity starts.
	ScaleOutCooldown int32
	// contains filtered or unexported fields
}

The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.

type ThroughputMode 

type ThroughputMode string
const (
	ThroughputModePayPerRequest ThroughputMode = "PAY_PER_REQUEST"
	ThroughputModeProvisioned   ThroughputMode = "PROVISIONED"
)

Enum values for ThroughputMode

func (ThroughputMode) Values 

func (ThroughputMode) Values() []ThroughputMode

Values returns all known values for ThroughputMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TimeToLive 

type TimeToLive struct {

	// Shows how to enable custom Time to Live (TTL) settings for the specified table.
	//
	// This member is required.
	Status TimeToLiveStatus
	// contains filtered or unexported fields
}

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.

type TimeToLiveStatus 

type TimeToLiveStatus string
const (
	TimeToLiveStatusEnabled TimeToLiveStatus = "ENABLED"
)

Enum values for TimeToLiveStatus

func (TimeToLiveStatus) Values 

func (TimeToLiveStatus) Values() []TimeToLiveStatus

Values returns all known values for TimeToLiveStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TypeStatus added in v1.15.0 

type TypeStatus string
const (
	TypeStatusActive    TypeStatus = "ACTIVE"
	TypeStatusCreating  TypeStatus = "CREATING"
	TypeStatusDeleting  TypeStatus = "DELETING"
	TypeStatusRestoring TypeStatus = "RESTORING"
)

Enum values for TypeStatus

func (TypeStatus) Values added in v1.15.0 

func (TypeStatus) Values() []TypeStatus

Values returns all known values for TypeStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed due to an invalid or malformed request.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.