1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package keyspaces
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/keyspaces/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// The CreateTable operation adds a new table to the specified keyspace. Within a
// keyspace, table names must be unique.
//
// CreateTable is an asynchronous operation. When the request is received, the
// status of the table is set to CREATING . You can monitor the creation status of
// the new table by using the GetTable operation, which returns the current status
// of the table. You can start using a table when the status is ACTIVE .
//
// For more information, see [Creating tables] in the Amazon Keyspaces Developer Guide.
//
// [Creating tables]: https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-tables.html#tables-create
func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error) {
if params == nil {
params = &CreateTableInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateTable", params, optFns, c.addOperationCreateTableMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateTableOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateTableInput struct {
// The name of the keyspace that the table is going to be created in.
//
// This member is required.
KeyspaceName *string
// 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.
//
// [Data types]: https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types
//
// This member is required.
SchemaDefinition *types.SchemaDefinition
// The name of the table.
//
// This member is required.
TableName *string
// The optional auto scaling settings for a table in provisioned capacity mode.
// Specifies if the service can manage throughput capacity automatically on your
// behalf.
//
// Auto scaling helps you provision throughput capacity for variable workloads
// efficiently by increasing and decreasing your table's read and write capacity
// automatically in response to application traffic. For more information, see [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]in
// the Amazon Keyspaces Developer Guide.
//
// By default, auto scaling is disabled for a table.
//
// [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]: https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html
AutoScalingSpecification *types.AutoScalingSpecification
// 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.
//
// [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html
CapacitySpecification *types.CapacitySpecification
// Enables client-side timestamps for the table. By default, the setting is
// disabled. You can enable client-side timestamps with the following option:
//
// - status: "enabled"
//
// Once client-side timestamps are enabled for a table, this setting cannot be
// disabled.
ClientSideTimestamps *types.ClientSideTimestamps
// This parameter allows to enter a description of the table.
Comment *types.Comment
// 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.
//
// [Setting the default TTL value for a table]: https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl
DefaultTimeToLive *int32
// 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.
//
// [Encryption at rest]: https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html
EncryptionSpecification *types.EncryptionSpecification
// Specifies if pointInTimeRecovery is enabled or disabled for the table. The
// options are:
//
// - status=ENABLED
//
// - status=DISABLED
//
// If it's not specified, the default is status=DISABLED .
//
// For more information, see [Point-in-time recovery] in the Amazon Keyspaces Developer Guide.
//
// [Point-in-time recovery]: https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html
PointInTimeRecovery *types.PointInTimeRecovery
// The optional Amazon Web Services Region specific settings of a multi-Region
// table. These settings overwrite the general settings of the table for the
// specified Region.
//
// For a multi-Region table in provisioned capacity mode, you can configure the
// table's read capacity differently for each Region's replica. The write capacity,
// however, remains synchronized between all replicas to ensure that there's enough
// capacity to replicate writes across all Regions. To define the read capacity for
// a table replica in a specific Region, you can do so 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)
ReplicaSpecifications []types.ReplicaSpecification
// 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.
//
// [Adding tags and labels to Amazon Keyspaces resources]: https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html
Tags []types.Tag
// 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.
//
// [Expiring data by using Amazon Keyspaces Time to Live (TTL)]: https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html
Ttl *types.TimeToLive
noSmithyDocumentSerde
}
type CreateTableOutput struct {
// The unique identifier of the table in the format of an Amazon Resource Name
// (ARN).
//
// This member is required.
ResourceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateTableMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpCreateTable{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpCreateTable{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateTable"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpCreateTableValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateTable(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateTable(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateTable",
}
}
|