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 Amazon Timestream InfluxDB CreateDbParameterGroup API operation.

Syntax

New-TIDBDbParameterGroup
-Name <String>
-Description <String>
-HttpIdleTimeout_DurationType <DurationType>
-HttpReadHeaderTimeout_DurationType <DurationType>
-HttpReadTimeout_DurationType <DurationType>
-HttpWriteTimeout_DurationType <DurationType>
-StorageCacheSnapshotWriteColdDuration_DurationType <DurationType>
-StorageCompactFullWriteColdDuration_DurationType <DurationType>
-StorageRetentionCheckInterval_DurationType <DurationType>
-StorageWalMaxWriteDelay_DurationType <DurationType>
-InfluxDBv2_FluxLogEnabled <Boolean>
-InfluxDBv2_InfluxqlMaxSelectBucket <Int64>
-InfluxDBv2_InfluxqlMaxSelectPoint <Int64>
-InfluxDBv2_InfluxqlMaxSelectSeries <Int64>
-InfluxDBv2_LogLevel <LogLevel>
-InfluxDBv2_MetricsDisabled <Boolean>
-InfluxDBv2_NoTask <Boolean>
-InfluxDBv2_PprofDisabled <Boolean>
-InfluxDBv2_QueryConcurrency <Int32>
-InfluxDBv2_QueryInitialMemoryByte <Int64>
-InfluxDBv2_QueryMaxMemoryByte <Int64>
-InfluxDBv2_QueryMemoryByte <Int64>
-InfluxDBv2_QueryQueueSize <Int32>
-InfluxDBv2_SessionLength <Int32>
-InfluxDBv2_SessionRenewDisabled <Boolean>
-InfluxDBv2_StorageCacheMaxMemorySize <Int64>
-InfluxDBv2_StorageCacheSnapshotMemorySize <Int64>
-InfluxDBv2_StorageCompactThroughputBurst <Int64>
-InfluxDBv2_StorageMaxConcurrentCompaction <Int32>
-InfluxDBv2_StorageMaxIndexLogFileSize <Int64>
-InfluxDBv2_StorageNoValidateFieldSize <Boolean>
-InfluxDBv2_StorageSeriesFileMaxConcurrentSnapshotCompaction <Int32>
-InfluxDBv2_StorageSeriesIdSetCacheSize <Int64>
-InfluxDBv2_StorageWalMaxConcurrentWrite <Int32>
-Tag <Hashtable>
-InfluxDBv2_TracingType <TracingType>
-InfluxDBv2_UiDisabled <Boolean>
-HttpIdleTimeout_Value <Int64>
-HttpReadHeaderTimeout_Value <Int64>
-HttpReadTimeout_Value <Int64>
-HttpWriteTimeout_Value <Int64>
-StorageCacheSnapshotWriteColdDuration_Value <Int64>
-StorageCompactFullWriteColdDuration_Value <Int64>
-StorageRetentionCheckInterval_Value <Int64>
-StorageWalMaxWriteDelay_Value <Int64>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonTimestreamInfluxDBConfig>

Description

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

Parameters

-ClientConfig <AmazonTimestreamInfluxDBConfig>
Amazon.PowerShell.Cmdlets.TIDB.AmazonTimestreamInfluxDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the DB parameter group.
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)
-HttpIdleTimeout_DurationType <DurationType>
The type of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_HttpIdleTimeout_DurationType
-HttpIdleTimeout_Value <Int64>
The value of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_HttpIdleTimeout_Value
-HttpReadHeaderTimeout_DurationType <DurationType>
The type of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_HttpReadHeaderTimeout_DurationType
-HttpReadHeaderTimeout_Value <Int64>
The value of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_HttpReadHeaderTimeout_Value
-HttpReadTimeout_DurationType <DurationType>
The type of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_HttpReadTimeout_DurationType
-HttpReadTimeout_Value <Int64>
The value of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_HttpReadTimeout_Value
-HttpWriteTimeout_DurationType <DurationType>
The type of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_HttpWriteTimeout_DurationType
-HttpWriteTimeout_Value <Int64>
The value of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_HttpWriteTimeout_Value
-InfluxDBv2_FluxLogEnabled <Boolean>
Include option to show detailed logs for Flux queries.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_FluxLogEnabled
-InfluxDBv2_InfluxqlMaxSelectBucket <Int64>
Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_InfluxqlMaxSelectBuckets
-InfluxDBv2_InfluxqlMaxSelectPoint <Int64>
Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_InfluxqlMaxSelectPoint
-InfluxDBv2_InfluxqlMaxSelectSeries <Int64>
Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_InfluxqlMaxSelectSeries
-InfluxDBv2_LogLevel <LogLevel>
Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.Default: info
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_LogLevel
-InfluxDBv2_MetricsDisabled <Boolean>
Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_MetricsDisabled
-InfluxDBv2_NoTask <Boolean>
Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_NoTasks
-InfluxDBv2_PprofDisabled <Boolean>
Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_PprofDisabled
-InfluxDBv2_QueryConcurrency <Int32>
Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_QueryConcurrency
-InfluxDBv2_QueryInitialMemoryByte <Int64>
Initial bytes of memory allocated for a query.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_QueryInitialMemoryBytes
-InfluxDBv2_QueryMaxMemoryByte <Int64>
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_QueryMaxMemoryBytes
-InfluxDBv2_QueryMemoryByte <Int64>
Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_QueryMemoryBytes
-InfluxDBv2_QueryQueueSize <Int32>
Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_QueryQueueSize
-InfluxDBv2_SessionLength <Int32>
Specifies the Time to Live (TTL) in minutes for newly created user sessions.Default: 60
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_SessionLength
-InfluxDBv2_SessionRenewDisabled <Boolean>
Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_SessionRenewDisabled
-InfluxDBv2_StorageCacheMaxMemorySize <Int64>
Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.Default: 1073741824
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageCacheMaxMemorySize
-InfluxDBv2_StorageCacheSnapshotMemorySize <Int64>
Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.Default: 26214400
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageCacheSnapshotMemorySize
-InfluxDBv2_StorageCompactThroughputBurst <Int64>
Rate limit (in bytes per second) that TSM compactions can write to disk.Default: 50331648
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageCompactThroughputBurst
-InfluxDBv2_StorageMaxConcurrentCompaction <Int32>
Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageMaxConcurrentCompactions
-InfluxDBv2_StorageMaxIndexLogFileSize <Int64>
Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.Default: 1048576
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageMaxIndexLogFileSize
-InfluxDBv2_StorageNoValidateFieldSize <Boolean>
Skip field size validation on incoming write requests.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageNoValidateFieldSize
-InfluxDBv2_StorageSeriesFileMaxConcurrentSnapshotCompaction <Int32>
Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageSeriesFileMaxConcurrentSnapshotCompactions
-InfluxDBv2_StorageSeriesIdSetCacheSize <Int64>
Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.Default: 100
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageSeriesIdSetCacheSize
-InfluxDBv2_StorageWalMaxConcurrentWrite <Int32>
Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageWalMaxConcurrentWrites
-InfluxDBv2_TracingType <TracingType>
Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_TracingType
-InfluxDBv2_UiDisabled <Boolean>
Disable the InfluxDB user interface (UI). The UI is enabled by default.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_UiDisabled
-Name <String>
The name of the DB parameter group. The name must be unique per customer and per region.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
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.TimestreamInfluxDB.Model.CreateDbParameterGroupResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.CreateDbParameterGroupResponse 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)
-StorageCacheSnapshotWriteColdDuration_DurationType <DurationType>
The type of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageCacheSnapshotWriteColdDuration_DurationType
-StorageCacheSnapshotWriteColdDuration_Value <Int64>
The value of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageCacheSnapshotWriteColdDuration_Value
-StorageCompactFullWriteColdDuration_DurationType <DurationType>
The type of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageCompactFullWriteColdDuration_DurationType
-StorageCompactFullWriteColdDuration_Value <Int64>
The value of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageCompactFullWriteColdDuration_Value
-StorageRetentionCheckInterval_DurationType <DurationType>
The type of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageRetentionCheckInterval_DurationType
-StorageRetentionCheckInterval_Value <Int64>
The value of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageRetentionCheckInterval_Value
-StorageWalMaxWriteDelay_DurationType <DurationType>
The type of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageWalMaxWriteDelay_DurationType
-StorageWalMaxWriteDelay_Value <Int64>
The value of duration for InfluxDB parameters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_InfluxDBv2_StorageWalMaxWriteDelay_Value
-Tag <Hashtable>
A list of key-value pairs to associate with the DB parameter group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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

Supported Version

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