Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AWS Tools for Windows PowerShell
Command Reference

Synopsis

Calls the Amazon Timestream InfluxDB CreateDbInstance API operation.

Syntax

New-TIDBDbInstance
-AllocatedStorage <Int32>
-Bucket <String>
-S3Configuration_BucketName <String>
-DbInstanceType <DbInstanceType>
-DbParameterGroupIdentifier <String>
-DbStorageType <DbStorageType>
-DeploymentType <DeploymentType>
-S3Configuration_Enabled <Boolean>
-Name <String>
-NetworkType <NetworkType>
-Organization <String>
-Password <String>
-Port <Int32>
-PubliclyAccessible <Boolean>
-Tag <Hashtable>
-Username <String>
-VpcSecurityGroupId <String[]>
-VpcSubnetId <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonTimestreamInfluxDBConfig>

Description

Creates a new Timestream for InfluxDB DB instance.

Parameters

-AllocatedStorage <Int32>
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Bucket <String>
The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonTimestreamInfluxDBConfig>
Amazon.PowerShell.Cmdlets.TIDB.AmazonTimestreamInfluxDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbInstanceType <DbInstanceType>
The Timestream for InfluxDB DB instance type to run InfluxDB on.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbParameterGroupIdentifier <String>
The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DbStorageType <DbStorageType>
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:
  • Influx IO Included 3000 IOPS
  • Influx IO Included 12000 IOPS
  • Influx IO Included 16000 IOPS
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentType <DeploymentType>
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
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)
-Name <String>
The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkType <NetworkType>
Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Organization <String>
The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Password <String>
The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Secrets Manager in your account.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which InfluxDB accepts connections.Valid Values: 1024-65535Default: 8086Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PubliclyAccessible <Boolean>
Configures the DB instance with a public IP to facilitate access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Configuration_BucketName <String>
The name of the S3 bucket to deliver logs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDeliveryConfiguration_S3Configuration_BucketName
-S3Configuration_Enabled <Boolean>
Indicates whether log delivery to the S3 bucket is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDeliveryConfiguration_S3Configuration_Enabled
-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.TimestreamInfluxDB.Model.CreateDbInstanceResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.CreateDbInstanceResponse 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 associate with the DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Username <String>
The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcSecurityGroupId <String[]>
A list of VPC security group IDs to associate with the DB instance.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSecurityGroupIds
-VpcSubnetId <String[]>
A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSubnetIds

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.TimestreamInfluxDB.Model.CreateDbInstanceResponse
This cmdlet returns an Amazon.TimestreamInfluxDB.Model.CreateDbInstanceResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 4.1.795.0