AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the FinSpace User Environment Management Service CreateKxCluster API operation.

Syntax

New-FINSPKxCluster
-ClusterName <String>
-AutoScalingConfiguration_AutoScalingMetric <AutoScalingMetric>
-AvailabilityZoneId <String>
-AzMode <KxAzMode>
-CacheStorageConfiguration <KxCacheStorageConfiguration[]>
-ClusterDescription <String>
-ClusterType <KxClusterType>
-CommandLineArgument <KxCommandLineArgument[]>
-ScalingGroupConfiguration_Cpu <Double>
-Databases <KxDatabaseConfiguration[]>
-EnvironmentId <String>
-ExecutionRole <String>
-InitializationScript <String>
-VpcConfiguration_IpAddressType <IPAddressType>
-AutoScalingConfiguration_MaxNodeCount <Int32>
-ScalingGroupConfiguration_MemoryLimit <Int32>
-ScalingGroupConfiguration_MemoryReservation <Int32>
-AutoScalingConfiguration_MetricTarget <Double>
-AutoScalingConfiguration_MinNodeCount <Int32>
-CapacityConfiguration_NodeCount <Int32>
-ScalingGroupConfiguration_NodeCount <Int32>
-CapacityConfiguration_NodeType <String>
-ReleaseLabel <String>
-Code_S3Bucket <String>
-Code_S3Key <String>
-Code_S3ObjectVersion <String>
-AutoScalingConfiguration_ScaleInCooldownSecond <Double>
-AutoScalingConfiguration_ScaleOutCooldownSecond <Double>
-ScalingGroupConfiguration_ScalingGroupName <String>
-VpcConfiguration_SecurityGroupId <String[]>
-SavedownStorageConfiguration_Size <Int32>
-VpcConfiguration_SubnetId <String[]>
-Tag <Hashtable>
-TickerplantLogConfiguration_TickerplantLogVolume <String[]>
-SavedownStorageConfiguration_Type <KxSavedownStorageType>
-SavedownStorageConfiguration_VolumeName <String>
-VpcConfiguration_VpcId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonFinspaceConfig>

Description

Creates a new kdb cluster.

Parameters

-AutoScalingConfiguration_AutoScalingMetric <AutoScalingMetric>
The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoScalingConfiguration_MaxNodeCount <Int32>
The highest number of nodes to scale. This value cannot be greater than 5.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoScalingConfiguration_MetricTarget <Double>
The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoScalingConfiguration_MinNodeCount <Int32>
The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoScalingConfiguration_ScaleInCooldownSecond <Double>
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingConfiguration_ScaleInCooldownSeconds
-AutoScalingConfiguration_ScaleOutCooldownSecond <Double>
The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingConfiguration_ScaleOutCooldownSeconds
-AvailabilityZoneId <String>
The availability zone identifiers for the requested regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AzMode <KxAzMode>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheStorageConfiguration <KxCacheStorageConfiguration[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCacheStorageConfigurations
-CapacityConfiguration_NodeCount <Int32>
The number of instances running in a cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CapacityConfiguration_NodeType <String>
The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.You can only specify one of the following values:
  • kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.
  • kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.
  • kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.
  • kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.
  • kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.
  • kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.
  • kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonFinspaceConfig>
Amazon.PowerShell.Cmdlets.FINSP.AmazonFinspaceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A token that ensures idempotency. This token expires in 10 minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterDescription <String>
A description of the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterName <String>
A unique name for the cluster that you want to create.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClusterType <KxClusterType>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Code_S3Bucket <String>
A unique name for the S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Code_S3Key <String>
The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Code_S3ObjectVersion <String>
The version of an S3 object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CommandLineArgument <KxCommandLineArgument[]>
Defines the key-value pairs to make them available inside the cluster. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCommandLineArguments
-Databases <KxDatabaseConfiguration[]>
A list of databases that will be available for querying. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnvironmentId <String>
A unique identifier for the kdb environment.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionRole <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InitializationScript <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReleaseLabel <String>
The version of FinSpace managed kdb to run.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SavedownStorageConfiguration_Size <Int32>
The size of temporary storage in gibibytes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SavedownStorageConfiguration_Type <KxSavedownStorageType>
The type of writeable storage space for temporarily storing your savedown data. The valid values are:
  • SDS01 – This type represents 3000 IOPS and io2 ebs volume type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SavedownStorageConfiguration_VolumeName <String>
The name of the kdb volume that you want to use as writeable save-down storage for clusters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingGroupConfiguration_Cpu <Double>
The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingGroupConfiguration_MemoryLimit <Int32>
An optional hard limit on the amount of memory a kdb cluster can use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingGroupConfiguration_MemoryReservation <Int32>
A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingGroupConfiguration_NodeCount <Int32>
The number of kdb cluster nodes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalingGroupConfiguration_ScalingGroupName <String>
A unique identifier for the kdb scaling group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.CreateKxClusterResponse). Specifying the name of a property of type Amazon.Finspace.Model.CreateKxClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TickerplantLogConfiguration_TickerplantLogVolume <String[]>
The name of the volumes for tickerplant logs. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTickerplantLogConfiguration_TickerplantLogVolumes
-VpcConfiguration_IpAddressType <IPAddressType>
The IP address type for cluster network configuration parameters. The following type is available:
  • IP_V4 – IP address version 4
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcConfiguration_SecurityGroupId <String[]>
The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfiguration_SecurityGroupIds
-VpcConfiguration_SubnetId <String[]>
The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfiguration_SubnetIds
-VpcConfiguration_VpcId <String>
The identifier of the VPC endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Finspace.Model.CreateKxClusterResponse
This cmdlet returns an Amazon.Finspace.Model.CreateKxClusterResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z