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 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package finspace
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/finspace/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Creates a new kdb cluster.
func (c *Client) CreateKxCluster(ctx context.Context, params *CreateKxClusterInput, optFns ...func(*Options)) (*CreateKxClusterOutput, error) {
if params == nil {
params = &CreateKxClusterInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateKxCluster", params, optFns, c.addOperationCreateKxClusterMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateKxClusterOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateKxClusterInput struct {
// The number of availability zones you want to assign per cluster. This can be
// one of the following
// - SINGLE – Assigns one availability zone per cluster.
// - MULTI – Assigns all the availability zones per cluster.
//
// This member is required.
AzMode types.KxAzMode
// A unique name for the cluster that you want to create.
//
// This member is required.
ClusterName *string
// Specifies the type of KDB database that is being created. The following types
// are available:
// - HDB – A Historical Database. The data is only accessible with read-only
// permissions from one of the FinSpace managed kdb databases mounted to the
// cluster.
// - RDB – A Realtime Database. This type of database captures all the data from
// a ticker plant and stores it in memory until the end of day, after which it
// writes all of its data to a disk and reloads the HDB. This cluster type requires
// local storage for temporary storage of data during the savedown process. If you
// specify this field in your request, you must provide the
// savedownStorageConfiguration parameter.
// - GATEWAY – A gateway cluster allows you to access data across processes in
// kdb systems. It allows you to create your own routing logic using the
// initialization scripts and custom code. This type of cluster does not require a
// writable local storage.
// - GP – A general purpose cluster allows you to quickly iterate on code during
// development by granting greater access to system commands and enabling a fast
// reload of custom code. This cluster type can optionally mount databases
// including cache and savedown storage. For this cluster type, the node count is
// fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
// - Tickerplant – A tickerplant cluster allows you to subscribe to feed
// handlers based on IAM permissions. It can publish to RDBs, other Tickerplants,
// and real-time subscribers (RTS). Tickerplants can persist messages to log, which
// is readable by any RDB environment. It supports only single-node that is only
// one kdb process.
//
// This member is required.
ClusterType types.KxClusterType
// A unique identifier for the kdb environment.
//
// This member is required.
EnvironmentId *string
// The version of FinSpace managed kdb to run.
//
// This member is required.
ReleaseLabel *string
// Configuration details about the network where the Privatelink endpoint of the
// cluster resides.
//
// This member is required.
VpcConfiguration *types.VpcConfiguration
// The configuration based on which FinSpace will scale in or scale out nodes in
// your cluster.
AutoScalingConfiguration *types.AutoScalingConfiguration
// The availability zone identifiers for the requested regions.
AvailabilityZoneId *string
// The configurations for a read only cache storage associated with a cluster.
// This cache will be stored as an FSx Lustre that reads from the S3 store.
CacheStorageConfigurations []types.KxCacheStorageConfiguration
// A structure for the metadata of a cluster. It includes information like the
// CPUs needed, memory of instances, and number of instances.
CapacityConfiguration *types.CapacityConfiguration
// A token that ensures idempotency. This token expires in 10 minutes.
ClientToken *string
// A description of the cluster.
ClusterDescription *string
// The details of the custom code that you want to use inside a cluster when
// analyzing a data. It consists of the S3 source bucket, location, S3 object
// version, and the relative path from where the custom code is loaded into the
// cluster.
Code *types.CodeConfiguration
// Defines the key-value pairs to make them available inside the cluster.
CommandLineArguments []types.KxCommandLineArgument
// A list of databases that will be available for querying.
Databases []types.KxDatabaseConfiguration
// An IAM role that defines a set of permissions associated with a cluster. These
// permissions are assumed when a cluster attempts to access another cluster.
ExecutionRole *string
// Specifies a Q program that will be run at launch of a cluster. It is a relative
// path within .zip file that contains the custom code, which will be loaded on the
// cluster. It must include the file name itself. For example, somedir/init.q .
InitializationScript *string
// The size and type of the temporary storage that is used to hold data during the
// savedown process. This parameter is required when you choose clusterType as
// RDB. All the data written to this storage space is lost when the cluster node is
// restarted.
SavedownStorageConfiguration *types.KxSavedownStorageConfiguration
// The structure that stores the configuration details of a scaling group.
ScalingGroupConfiguration *types.KxScalingGroupConfiguration
// A list of key-value pairs to label the cluster. You can add up to 50 tags to a
// cluster.
Tags map[string]string
// A configuration to store Tickerplant logs. It consists of a list of volumes
// that will be mounted to your cluster. For the cluster type Tickerplant , the
// location of the TP volume on the cluster will be available by using the global
// variable .aws.tp_log_path .
TickerplantLogConfiguration *types.TickerplantLogConfiguration
noSmithyDocumentSerde
}
type CreateKxClusterOutput struct {
// The configuration based on which FinSpace will scale in or scale out nodes in
// your cluster.
AutoScalingConfiguration *types.AutoScalingConfiguration
// The availability zone identifiers for the requested regions.
AvailabilityZoneId *string
// The number of availability zones you want to assign per cluster. This can be
// one of the following
// - SINGLE – Assigns one availability zone per cluster.
// - MULTI – Assigns all the availability zones per cluster.
AzMode types.KxAzMode
// The configurations for a read only cache storage associated with a cluster.
// This cache will be stored as an FSx Lustre that reads from the S3 store.
CacheStorageConfigurations []types.KxCacheStorageConfiguration
// A structure for the metadata of a cluster. It includes information like the
// CPUs needed, memory of instances, and number of instances.
CapacityConfiguration *types.CapacityConfiguration
// A description of the cluster.
ClusterDescription *string
// A unique name for the cluster.
ClusterName *string
// Specifies the type of KDB database that is being created. The following types
// are available:
// - HDB – A Historical Database. The data is only accessible with read-only
// permissions from one of the FinSpace managed kdb databases mounted to the
// cluster.
// - RDB – A Realtime Database. This type of database captures all the data from
// a ticker plant and stores it in memory until the end of day, after which it
// writes all of its data to a disk and reloads the HDB. This cluster type requires
// local storage for temporary storage of data during the savedown process. If you
// specify this field in your request, you must provide the
// savedownStorageConfiguration parameter.
// - GATEWAY – A gateway cluster allows you to access data across processes in
// kdb systems. It allows you to create your own routing logic using the
// initialization scripts and custom code. This type of cluster does not require a
// writable local storage.
// - GP – A general purpose cluster allows you to quickly iterate on code during
// development by granting greater access to system commands and enabling a fast
// reload of custom code. This cluster type can optionally mount databases
// including cache and savedown storage. For this cluster type, the node count is
// fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
// - Tickerplant – A tickerplant cluster allows you to subscribe to feed
// handlers based on IAM permissions. It can publish to RDBs, other Tickerplants,
// and real-time subscribers (RTS). Tickerplants can persist messages to log, which
// is readable by any RDB environment. It supports only single-node that is only
// one kdb process.
ClusterType types.KxClusterType
// The details of the custom code that you want to use inside a cluster when
// analyzing a data. It consists of the S3 source bucket, location, S3 object
// version, and the relative path from where the custom code is loaded into the
// cluster.
Code *types.CodeConfiguration
// Defines the key-value pairs to make them available inside the cluster.
CommandLineArguments []types.KxCommandLineArgument
// The timestamp at which the cluster was created in FinSpace. The value is
// determined as epoch time in milliseconds. For example, the value for Monday,
// November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
CreatedTimestamp *time.Time
// A list of databases that will be available for querying.
Databases []types.KxDatabaseConfiguration
// A unique identifier for the kdb environment.
EnvironmentId *string
// An IAM role that defines a set of permissions associated with a cluster. These
// permissions are assumed when a cluster attempts to access another cluster.
ExecutionRole *string
// Specifies a Q program that will be run at launch of a cluster. It is a relative
// path within .zip file that contains the custom code, which will be loaded on the
// cluster. It must include the file name itself. For example, somedir/init.q .
InitializationScript *string
// The last time that the cluster was modified. The value is determined as epoch
// time in milliseconds. For example, the value for Monday, November 1, 2021
// 12:00:00 PM UTC is specified as 1635768000000.
LastModifiedTimestamp *time.Time
// A version of the FinSpace managed kdb to run.
ReleaseLabel *string
// The size and type of the temporary storage that is used to hold data during the
// savedown process. This parameter is required when you choose clusterType as
// RDB. All the data written to this storage space is lost when the cluster node is
// restarted.
SavedownStorageConfiguration *types.KxSavedownStorageConfiguration
// The structure that stores the configuration details of a scaling group.
ScalingGroupConfiguration *types.KxScalingGroupConfiguration
// The status of cluster creation.
// - PENDING – The cluster is pending creation.
// - CREATING – The cluster creation process is in progress.
// - CREATE_FAILED – The cluster creation process has failed.
// - RUNNING – The cluster creation process is running.
// - UPDATING – The cluster is in the process of being updated.
// - DELETING – The cluster is in the process of being deleted.
// - DELETED – The cluster has been deleted.
// - DELETE_FAILED – The cluster failed to delete.
Status types.KxClusterStatus
// The error message when a failed state occurs.
StatusReason *string
// A configuration to store the Tickerplant logs. It consists of a list of volumes
// that will be mounted to your cluster. For the cluster type Tickerplant , the
// location of the TP volume on the cluster will be available by using the global
// variable .aws.tp_log_path .
TickerplantLogConfiguration *types.TickerplantLogConfiguration
// A list of volumes mounted on the cluster.
Volumes []types.Volume
// Configuration details about the network where the Privatelink endpoint of the
// cluster resides.
VpcConfiguration *types.VpcConfiguration
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateKxClusterMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateKxCluster{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateKxCluster{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateKxCluster"); 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 = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = addRestJsonContentTypeCustomization(stack); 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 = addIdempotencyToken_opCreateKxClusterMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreateKxClusterValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateKxCluster(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.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
}
type idempotencyToken_initializeOpCreateKxCluster struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreateKxCluster) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreateKxCluster) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreateKxClusterInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreateKxClusterInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreateKxClusterMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreateKxCluster{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreateKxCluster(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateKxCluster",
}
}
|