AWS.Tools.TimestreamInfluxDB.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.TimestreamInfluxDB</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.AddTIDBResourceTagCmdlet"> <summary> Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.AddTIDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the tagged resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.AddTIDBResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags used to categorize and track resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.AddTIDBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamInfluxDB.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.AddTIDBResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbInstanceCmdlet"> <summary> Returns a Timestream for InfluxDB DB instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbInstanceCmdlet.Identifier"> <summary> <para> <para>The id of the DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbInstanceCmdlet.Select"> <summary> 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.GetDbInstanceResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.GetDbInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbInstanceListCmdlet"> <summary> Returns a list of Timestream for InfluxDB DB instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbInstanceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbInstanceListCmdlet.NextToken"> <summary> <para> <para>The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamInfluxDB.Model.ListDbInstancesResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.ListDbInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbParameterGroupCmdlet"> <summary> Returns a Timestream for InfluxDB DB parameter group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbParameterGroupCmdlet.Identifier"> <summary> <para> <para>The id of the DB parameter group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbParameterGroupCmdlet.Select"> <summary> 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.GetDbParameterGroupResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.GetDbParameterGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbParameterGroupListCmdlet"> <summary> Returns a list of Timestream for InfluxDB DB parameter groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbParameterGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbParameterGroupListCmdlet.NextToken"> <summary> <para> <para>The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBDbParameterGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamInfluxDB.Model.ListDbParameterGroupsResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.ListDbParameterGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBResourceTagCmdlet"> <summary> A list of tags applied to the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the tagged resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.GetTIDBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamInfluxDB.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet"> <summary> Creates a new Timestream for InfluxDB DB instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.AllocatedStorage"> <summary> <para> <para>The amount of storage to allocate for your DB storage type in GiB (gibibytes).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.Bucket"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.S3Configuration_BucketName"> <summary> <para> <para>The name of the S3 bucket to deliver logs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.DbInstanceType"> <summary> <para> <para>The Timestream for InfluxDB DB instance type to run InfluxDB on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.DbParameterGroupIdentifier"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.DbStorageType"> <summary> <para> <para>The Timestream for InfluxDB DB storage type to read and write InfluxDB data.</para><para>You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:</para><ul><li><para>Influx IO Included 3000 IOPS</para></li><li><para>Influx IO Included 12000 IOPS</para></li><li><para>Influx IO Included 16000 IOPS</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.DeploymentType"> <summary> <para> <para>Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.S3Configuration_Enabled"> <summary> <para> <para>Indicates whether log delivery to the S3 bucket is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.Name"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.Organization"> <summary> <para> <para>The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.Password"> <summary> <para> <para>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 AWS SecretManager in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.PubliclyAccessible"> <summary> <para> <para>Configures the DB instance with a public IP to facilitate access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs to associate with the DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.Username"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.VpcSecurityGroupId"> <summary> <para> <para>A list of VPC security group IDs to associate with the DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.VpcSubnetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet"> <summary> Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.Description"> <summary> <para> <para>A description of the DB parameter group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.InfluxDBv2_FluxLogEnabled"> <summary> <para> <para>Include option to show detailed logs for Flux queries.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.InfluxDBv2_LogLevel"> <summary> <para> <para>Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.</para><para>Default: info</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.InfluxDBv2_MetricsDisabled"> <summary> <para> <para>Disable the HTTP /metrics endpoint which exposes <a href="https://docs.influxdata.com/influxdb/v2/reference/internals/metrics/">internal InfluxDB metrics</a>.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.Name"> <summary> <para> <para>The name of the DB parameter group. The name must be unique per customer and per region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.InfluxDBv2_NoTask"> <summary> <para> <para>Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.InfluxDBv2_QueryConcurrency"> <summary> <para> <para>Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.</para><para>Default: 0</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.InfluxDBv2_QueryQueueSize"> <summary> <para> <para>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.</para><para>Default: 0</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs to associate with the DB parameter group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.InfluxDBv2_TracingType"> <summary> <para> <para>Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.NewTIDBDbParameterGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBDbInstanceCmdlet"> <summary> Deletes a Timestream for InfluxDB DB instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBDbInstanceCmdlet.Identifier"> <summary> <para> <para>The id of the DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBDbInstanceCmdlet.Select"> <summary> 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.DeleteDbInstanceResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.DeleteDbInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBDbInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBResourceTagCmdlet"> <summary> Removes the tag from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the tagged resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys used to identify the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TimestreamInfluxDB.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.RemoveTIDBResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet"> <summary> Updates a Timestream for InfluxDB DB instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet.S3Configuration_BucketName"> <summary> <para> <para>The name of the S3 bucket to deliver logs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet.DbInstanceType"> <summary> <para> <para>The Timestream for InfluxDB DB instance type to run InfluxDB on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet.DbParameterGroupIdentifier"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet.DeploymentType"> <summary> <para> <para>Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet.S3Configuration_Enabled"> <summary> <para> <para>Indicates whether log delivery to the S3 bucket is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet.Identifier"> <summary> <para> <para>The id of the DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet.Select"> <summary> 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.UpdateDbInstanceResponse). Specifying the name of a property of type Amazon.TimestreamInfluxDB.Model.UpdateDbInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TIDB.UpdateTIDBDbInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |