Creates a new Timestream for InfluxDB cluster.
", "idempotent":true }, "CreateDbInstance":{ "name":"CreateDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDbInstanceInput"}, "output":{"shape":"CreateDbInstanceOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates a new Timestream for InfluxDB DB instance.
", "idempotent":true }, "CreateDbParameterGroup":{ "name":"CreateDbParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDbParameterGroupInput"}, "output":{"shape":"CreateDbParameterGroupOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
", "idempotent":true }, "DeleteDbCluster":{ "name":"DeleteDbCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDbClusterInput"}, "output":{"shape":"DeleteDbClusterOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes a Timestream for InfluxDB cluster.
", "idempotent":true }, "DeleteDbInstance":{ "name":"DeleteDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDbInstanceInput"}, "output":{"shape":"DeleteDbInstanceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes a Timestream for InfluxDB DB instance.
", "idempotent":true }, "GetDbCluster":{ "name":"GetDbCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDbClusterInput"}, "output":{"shape":"GetDbClusterOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Retrieves information about a Timestream for InfluxDB cluster.
" }, "GetDbInstance":{ "name":"GetDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDbInstanceInput"}, "output":{"shape":"GetDbInstanceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a Timestream for InfluxDB DB instance.
" }, "GetDbParameterGroup":{ "name":"GetDbParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDbParameterGroupInput"}, "output":{"shape":"GetDbParameterGroupOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a Timestream for InfluxDB DB parameter group.
" }, "ListDbClusters":{ "name":"ListDbClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDbClustersInput"}, "output":{"shape":"ListDbClustersOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a list of Timestream for InfluxDB DB clusters.
" }, "ListDbInstances":{ "name":"ListDbInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDbInstancesInput"}, "output":{"shape":"ListDbInstancesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a list of Timestream for InfluxDB DB instances.
" }, "ListDbInstancesForCluster":{ "name":"ListDbInstancesForCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDbInstancesForClusterInput"}, "output":{"shape":"ListDbInstancesForClusterOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a list of Timestream for InfluxDB clusters.
" }, "ListDbParameterGroups":{ "name":"ListDbParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDbParameterGroupsInput"}, "output":{"shape":"ListDbParameterGroupsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns a list of Timestream for InfluxDB DB parameter groups.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"A list of tags applied to the resource.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.
", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Removes the tag from the specified resource.
", "idempotent":true }, "UpdateDbCluster":{ "name":"UpdateDbCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDbClusterInput"}, "output":{"shape":"UpdateDbClusterOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates a Timestream for InfluxDB cluster.
", "idempotent":true }, "UpdateDbInstance":{ "name":"UpdateDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDbInstanceInput"}, "output":{"shape":"UpdateDbInstanceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates a Timestream for InfluxDB DB instance.
", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
", "exception":true }, "AllocatedStorage":{ "type":"integer", "box":true, "max":15360, "min":20 }, "Arn":{ "type":"string", "max":1011, "min":1, "pattern":"arn:aws[a-z\\-]*:timestream\\-influxdb:[a-z0-9\\-]+:[0-9]{12}:(db\\-instance|db\\-cluster|db\\-parameter\\-group)/[a-zA-Z0-9]{3,64}" }, "Boolean":{ "type":"boolean", "box":true }, "Bucket":{ "type":"string", "max":64, "min":2, "pattern":"[^_\"][^\"]*" }, "ClusterDeploymentType":{ "type":"string", "enum":["MULTI_NODE_READ_REPLICAS"] }, "ClusterStatus":{ "type":"string", "enum":[ "CREATING", "UPDATING", "DELETING", "AVAILABLE", "FAILED", "DELETED" ] }, "ConflictException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"The identifier for the Timestream for InfluxDB resource associated with the request.
" }, "resourceType":{ "shape":"String", "documentation":"The type of Timestream for InfluxDB resource associated with the request.
" } }, "documentation":"The request conflicts with an existing resource in Timestream for InfluxDB.
", "exception":true }, "CreateDbClusterInput":{ "type":"structure", "required":[ "name", "password", "dbInstanceType", "allocatedStorage", "vpcSubnetIds", "vpcSecurityGroupIds", "deploymentType" ], "members":{ "name":{ "shape":"DbClusterName", "documentation":"The name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB cluster names must be unique per customer and per region.
" }, "username":{ "shape":"Username", "documentation":"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 Web Services Secrets Manager in your account.
" }, "password":{ "shape":"Password", "documentation":"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 Amazon Web Services Secrets Manager in your account.
" }, "organization":{ "shape":"Organization", "documentation":"The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
" }, "bucket":{ "shape":"Bucket", "documentation":"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.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"The ID of the DB parameter group to assign to your DB cluster. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB DB instance type to run InfluxDB on.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:
Influx I/O Included 3000 IOPS
Influx I/O Included 12000 IOPS
Influx I/O Included 16000 IOPS
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
" }, "networkType":{ "shape":"NetworkType", "documentation":"Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
" }, "vpcSubnetIds":{ "shape":"VpcSubnetIdList", "documentation":"A list of VPC subnet IDs to associate with the DB cluster. Provide at least two VPC subnet IDs in different Availability Zones when deploying with a Multi-AZ standby.
" }, "vpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.
" }, "deploymentType":{ "shape":"ClusterDeploymentType", "documentation":"Specifies the type of cluster to create.
" }, "failoverMode":{ "shape":"FailoverMode", "documentation":"Specifies the behavior of failure recovery when the primary node of the cluster fails.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"Configuration for sending InfluxDB engine logs to a specified S3 bucket.
" }, "tags":{ "shape":"RequestTagMap", "documentation":"A list of key-value pairs to associate with the DB instance.
" } } }, "CreateDbClusterOutput":{ "type":"structure", "members":{ "dbClusterId":{ "shape":"DbClusterId", "documentation":"A service-generated unique identifier.
" }, "dbClusterStatus":{ "shape":"ClusterStatus", "documentation":"The status of the DB cluster.
" } } }, "CreateDbInstanceInput":{ "type":"structure", "required":[ "name", "password", "dbInstanceType", "vpcSubnetIds", "vpcSecurityGroupIds", "allocatedStorage" ], "members":{ "name":{ "shape":"DbInstanceName", "documentation":"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.
" }, "username":{ "shape":"Username", "documentation":"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.
" }, "password":{ "shape":"Password", "documentation":"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 Amazon Web Services SecretManager in your account.
" }, "organization":{ "shape":"Organization", "documentation":"The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
" }, "bucket":{ "shape":"Bucket", "documentation":"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.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB DB instance type to run InfluxDB on.
" }, "vpcSubnetIds":{ "shape":"VpcSubnetIdList", "documentation":"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.
" }, "vpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"A list of VPC security group IDs to associate with the DB instance.
" }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"Configures the DB instance with a public IP to facilitate access.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"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
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"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.
" }, "deploymentType":{ "shape":"DeploymentType", "documentation":"Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"Configuration for sending InfluxDB engine logs to a specified S3 bucket.
" }, "tags":{ "shape":"RequestTagMap", "documentation":"A list of key-value pairs to associate with the DB instance.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
" }, "networkType":{ "shape":"NetworkType", "documentation":"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.
" } } }, "CreateDbInstanceOutput":{ "type":"structure", "required":[ "id", "name", "arn", "vpcSubnetIds" ], "members":{ "id":{ "shape":"DbInstanceId", "documentation":"A service-generated unique identifier.
" }, "name":{ "shape":"DbInstanceName", "documentation":"The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB instance.
" }, "status":{ "shape":"Status", "documentation":"The status of the DB instance.
" }, "endpoint":{ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections. The default value is 8086.
" }, "networkType":{ "shape":"NetworkType", "documentation":"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.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage allocated for your DB storage type (in gibibytes).
" }, "deploymentType":{ "shape":"DeploymentType", "documentation":"Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
" }, "vpcSubnetIds":{ "shape":"VpcSubnetIdList", "documentation":"A list of VPC subnet IDs associated with the DB instance.
" }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"Indicates if the DB instance has a public IP to facilitate access.
" }, "vpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"A list of VPC security group IDs associated with the DB instance.
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"The id of the DB parameter group assigned to your DB instance.
" }, "availabilityZone":{ "shape":"String", "documentation":"The Availability Zone in which the DB instance resides.
" }, "secondaryAvailabilityZone":{ "shape":"String", "documentation":"The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" }, "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" }, "dbClusterId":{ "shape":"DbClusterId", "documentation":"Specifies the DbCluster to which this DbInstance belongs to.
" }, "instanceMode":{ "shape":"InstanceMode", "documentation":"Specifies the DbInstance's role in the cluster.
" } } }, "CreateDbParameterGroupInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"DbParameterGroupName", "documentation":"The name of the DB parameter group. The name must be unique per customer and per region.
" }, "description":{ "shape":"CreateDbParameterGroupInputDescriptionString", "documentation":"A description of the DB parameter group.
" }, "parameters":{ "shape":"Parameters", "documentation":"A list of the parameters that comprise the DB parameter group.
" }, "tags":{ "shape":"RequestTagMap", "documentation":"A list of key-value pairs to associate with the DB parameter group.
" } } }, "CreateDbParameterGroupInputDescriptionString":{ "type":"string", "max":500, "min":0 }, "CreateDbParameterGroupOutput":{ "type":"structure", "required":[ "id", "name", "arn" ], "members":{ "id":{ "shape":"DbParameterGroupId", "documentation":"A service-generated unique identifier.
" }, "name":{ "shape":"DbParameterGroupName", "documentation":"The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARM) of the DB parameter group.
" }, "description":{ "shape":"String", "documentation":"The description of the DB parameter group.
" }, "parameters":{ "shape":"Parameters", "documentation":"A list of the parameters that comprise the DB parameter group.
" } } }, "DbClusterId":{ "type":"string", "max":64, "min":3, "pattern":"[a-zA-Z0-9]+" }, "DbClusterName":{ "type":"string", "max":40, "min":3, "pattern":"[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" }, "DbClusterSummary":{ "type":"structure", "required":[ "id", "name", "arn" ], "members":{ "id":{ "shape":"DbClusterId", "documentation":"Service-generated unique identifier of the DB cluster to retrieve.
" }, "name":{ "shape":"DbClusterName", "documentation":"Customer supplied name of the Timestream for InfluxDB cluster.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB cluster.
" }, "status":{ "shape":"ClusterStatus", "documentation":"The status of the DB cluster.
" }, "endpoint":{ "shape":"String", "documentation":"The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
" }, "readerEndpoint":{ "shape":"String", "documentation":"The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
" }, "deploymentType":{ "shape":"ClusterDeploymentType", "documentation":"Deployment type of the DB cluster
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB DB instance type that InfluxDB runs on.
" }, "networkType":{ "shape":"NetworkType", "documentation":"Specifies whether the network type of the Timestream for InfluxDB Cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage allocated for your DB storage type (in gibibytes).
" } }, "documentation":"Describes a summary of a Timestream for InfluxDB cluster.
" }, "DbClusterSummaryList":{ "type":"list", "member":{"shape":"DbClusterSummary"} }, "DbInstanceForClusterSummary":{ "type":"structure", "required":[ "id", "name", "arn" ], "members":{ "id":{ "shape":"DbInstanceId", "documentation":"The service-generated unique identifier of the DB instance.
" }, "name":{ "shape":"DbInstanceName", "documentation":"A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB instance.
" }, "status":{ "shape":"Status", "documentation":"The status of the DB instance.
" }, "endpoint":{ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
" }, "networkType":{ "shape":"NetworkType", "documentation":"Specifies whether the network type 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.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type to run InfluxDB on.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The storage type for your DB instance.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage allocated for your DB storage type in GiB (gibibytes).
" }, "deploymentType":{ "shape":"DeploymentType", "documentation":"Specifies the deployment type if applicable.
" }, "instanceMode":{ "shape":"InstanceMode", "documentation":"Specifies the DB instance's role in the cluster.
" } }, "documentation":"Contains a summary of a DB instance belonging to a DB cluster.
" }, "DbInstanceForClusterSummaryList":{ "type":"list", "member":{"shape":"DbInstanceForClusterSummary"} }, "DbInstanceId":{ "type":"string", "max":64, "min":3, "pattern":"[a-zA-Z0-9]+" }, "DbInstanceIdentifier":{ "type":"string", "max":64, "min":3, "pattern":"[a-zA-Z0-9]+" }, "DbInstanceName":{ "type":"string", "max":40, "min":3, "pattern":"[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" }, "DbInstanceSummary":{ "type":"structure", "required":[ "id", "name", "arn" ], "members":{ "id":{ "shape":"DbInstanceId", "documentation":"The service-generated unique identifier of the DB instance.
" }, "name":{ "shape":"DbInstanceName", "documentation":"This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB instance.
" }, "status":{ "shape":"Status", "documentation":"The status of the DB instance.
" }, "endpoint":{ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
" }, "networkType":{ "shape":"NetworkType", "documentation":"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.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type to run InfluxDB on.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The storage type for your DB instance.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
" }, "deploymentType":{ "shape":"DeploymentType", "documentation":"Single-Instance or with a MultiAZ Standby for High availability.
" } }, "documentation":"Contains a summary of a DB instance.
" }, "DbInstanceSummaryList":{ "type":"list", "member":{"shape":"DbInstanceSummary"} }, "DbInstanceType":{ "type":"string", "enum":[ "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge" ] }, "DbParameterGroupId":{ "type":"string", "max":64, "min":3, "pattern":"[a-zA-Z0-9]+" }, "DbParameterGroupIdentifier":{ "type":"string", "max":64, "min":3, "pattern":"[a-zA-Z0-9]+" }, "DbParameterGroupName":{ "type":"string", "max":64, "min":3, "pattern":"[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" }, "DbParameterGroupSummary":{ "type":"structure", "required":[ "id", "name", "arn" ], "members":{ "id":{ "shape":"DbParameterGroupId", "documentation":"A service-generated unique identifier.
" }, "name":{ "shape":"DbParameterGroupName", "documentation":"This customer-supplied name uniquely identifies the parameter group.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB parameter group.
" }, "description":{ "shape":"String", "documentation":"A description of the DB parameter group.
" } }, "documentation":"Contains a summary of a DB parameter group.
" }, "DbParameterGroupSummaryList":{ "type":"list", "member":{"shape":"DbParameterGroupSummary"} }, "DbStorageType":{ "type":"string", "enum":[ "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3" ] }, "DeleteDbClusterInput":{ "type":"structure", "required":["dbClusterId"], "members":{ "dbClusterId":{ "shape":"DbClusterId", "documentation":"Service-generated unique identifier of the DB cluster.
" } } }, "DeleteDbClusterOutput":{ "type":"structure", "members":{ "dbClusterStatus":{ "shape":"ClusterStatus", "documentation":"The status of the DB cluster.
" } } }, "DeleteDbInstanceInput":{ "type":"structure", "required":["identifier"], "members":{ "identifier":{ "shape":"DbInstanceIdentifier", "documentation":"The id of the DB instance.
" } } }, "DeleteDbInstanceOutput":{ "type":"structure", "required":[ "id", "name", "arn", "vpcSubnetIds" ], "members":{ "id":{ "shape":"DbInstanceId", "documentation":"A service-generated unique identifier.
" }, "name":{ "shape":"DbInstanceName", "documentation":"The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB instance.
" }, "status":{ "shape":"Status", "documentation":"The status of the DB instance.
" }, "endpoint":{ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
" }, "networkType":{ "shape":"NetworkType", "documentation":"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.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage allocated for your DB storage type (in gibibytes).
" }, "deploymentType":{ "shape":"DeploymentType", "documentation":"Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
" }, "vpcSubnetIds":{ "shape":"VpcSubnetIdList", "documentation":"A list of VPC subnet IDs associated with the DB instance.
" }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"Indicates if the DB instance has a public IP to facilitate access.
" }, "vpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"A list of VPC security group IDs associated with the DB instance.
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"The id of the DB parameter group assigned to your DB instance.
" }, "availabilityZone":{ "shape":"String", "documentation":"The Availability Zone in which the DB instance resides.
" }, "secondaryAvailabilityZone":{ "shape":"String", "documentation":"The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" }, "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" }, "dbClusterId":{ "shape":"DbClusterId", "documentation":"Specifies the DbCluster to which this DbInstance belongs to.
" }, "instanceMode":{ "shape":"InstanceMode", "documentation":"Specifies the DbInstance's role in the cluster.
" } } }, "DeploymentType":{ "type":"string", "enum":[ "SINGLE_AZ", "WITH_MULTIAZ_STANDBY" ] }, "Duration":{ "type":"structure", "required":[ "durationType", "value" ], "members":{ "durationType":{ "shape":"DurationType", "documentation":"The type of duration for InfluxDB parameters.
" }, "value":{ "shape":"DurationValueLong", "documentation":"The value of duration for InfluxDB parameters.
" } }, "documentation":"Duration for InfluxDB parameters in Timestream for InfluxDB.
" }, "DurationType":{ "type":"string", "enum":[ "hours", "minutes", "seconds", "milliseconds" ] }, "DurationValueLong":{ "type":"long", "box":true, "min":0 }, "FailoverMode":{ "type":"string", "enum":[ "AUTOMATIC", "NO_FAILOVER" ] }, "GetDbClusterInput":{ "type":"structure", "required":["dbClusterId"], "members":{ "dbClusterId":{ "shape":"DbClusterId", "documentation":"Service-generated unique identifier of the DB cluster to retrieve.
" } } }, "GetDbClusterOutput":{ "type":"structure", "required":[ "id", "name", "arn" ], "members":{ "id":{ "shape":"DbClusterId", "documentation":"Service-generated unique identifier of the DB cluster to retrieve.
" }, "name":{ "shape":"DbClusterName", "documentation":"Customer-supplied name of the Timestream for InfluxDB cluster.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB cluster.
" }, "status":{ "shape":"ClusterStatus", "documentation":"The status of the DB cluster.
" }, "endpoint":{ "shape":"String", "documentation":"The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
" }, "readerEndpoint":{ "shape":"String", "documentation":"The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
" }, "deploymentType":{ "shape":"ClusterDeploymentType", "documentation":"Deployment type of the DB cluster.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" }, "networkType":{ "shape":"NetworkType", "documentation":"Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage allocated for your DB storage type (in gibibytes).
" }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"The ID of the DB parameter group assigned to your DB cluster.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" }, "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" }, "vpcSubnetIds":{ "shape":"VpcSubnetIdList", "documentation":"A list of VPC subnet IDs associated with the DB cluster.
" }, "vpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"A list of VPC security group IDs associated with the DB cluster.
" }, "failoverMode":{ "shape":"FailoverMode", "documentation":"The configured failover mode for the DB cluster.
" } } }, "GetDbInstanceInput":{ "type":"structure", "required":["identifier"], "members":{ "identifier":{ "shape":"DbInstanceIdentifier", "documentation":"The id of the DB instance.
" } } }, "GetDbInstanceOutput":{ "type":"structure", "required":[ "id", "name", "arn", "vpcSubnetIds" ], "members":{ "id":{ "shape":"DbInstanceId", "documentation":"A service-generated unique identifier.
" }, "name":{ "shape":"DbInstanceName", "documentation":"The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB instance.
" }, "status":{ "shape":"Status", "documentation":"The status of the DB instance.
" }, "endpoint":{ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
" }, "networkType":{ "shape":"NetworkType", "documentation":"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.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage allocated for your DB storage type (in gibibytes).
" }, "deploymentType":{ "shape":"DeploymentType", "documentation":"Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
" }, "vpcSubnetIds":{ "shape":"VpcSubnetIdList", "documentation":"A list of VPC subnet IDs associated with the DB instance.
" }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"Indicates if the DB instance has a public IP to facilitate access.
" }, "vpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"A list of VPC security group IDs associated with the DB instance.
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"The id of the DB parameter group assigned to your DB instance.
" }, "availabilityZone":{ "shape":"String", "documentation":"The Availability Zone in which the DB instance resides.
" }, "secondaryAvailabilityZone":{ "shape":"String", "documentation":"The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" }, "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" }, "dbClusterId":{ "shape":"DbClusterId", "documentation":"Specifies the DbCluster to which this DbInstance belongs to.
" }, "instanceMode":{ "shape":"InstanceMode", "documentation":"Specifies the DbInstance's role in the cluster.
" } } }, "GetDbParameterGroupInput":{ "type":"structure", "required":["identifier"], "members":{ "identifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"The id of the DB parameter group.
" } } }, "GetDbParameterGroupOutput":{ "type":"structure", "required":[ "id", "name", "arn" ], "members":{ "id":{ "shape":"DbParameterGroupId", "documentation":"A service-generated unique identifier.
" }, "name":{ "shape":"DbParameterGroupName", "documentation":"The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB parameter group.
" }, "description":{ "shape":"String", "documentation":"A description of the DB parameter group.
" }, "parameters":{ "shape":"Parameters", "documentation":"The parameters that comprise the DB parameter group.
" } } }, "InfluxDBv2Parameters":{ "type":"structure", "members":{ "fluxLogEnabled":{ "shape":"Boolean", "documentation":"Include option to show detailed logs for Flux queries.
Default: false
" }, "logLevel":{ "shape":"LogLevel", "documentation":"Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
Default: info
" }, "noTasks":{ "shape":"Boolean", "documentation":"Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.
Default: false
" }, "queryConcurrency":{ "shape":"InfluxDBv2ParametersQueryConcurrencyInteger", "documentation":"Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.
Default: 0
" }, "queryQueueSize":{ "shape":"InfluxDBv2ParametersQueryQueueSizeInteger", "documentation":"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
" }, "tracingType":{ "shape":"TracingType", "documentation":"Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
" }, "metricsDisabled":{ "shape":"Boolean", "documentation":"Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
Default: false
" }, "httpIdleTimeout":{ "shape":"Duration", "documentation":"Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.
Default: 3 minutes
" }, "httpReadHeaderTimeout":{ "shape":"Duration", "documentation":"Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.
Default: 10 seconds
" }, "httpReadTimeout":{ "shape":"Duration", "documentation":"Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.
Default: 0
" }, "httpWriteTimeout":{ "shape":"Duration", "documentation":"Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.
Default: 0
" }, "influxqlMaxSelectBuckets":{ "shape":"InfluxDBv2ParametersInfluxqlMaxSelectBucketsLong", "documentation":"Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.
Default: 0
" }, "influxqlMaxSelectPoint":{ "shape":"InfluxDBv2ParametersInfluxqlMaxSelectPointLong", "documentation":"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
" }, "influxqlMaxSelectSeries":{ "shape":"InfluxDBv2ParametersInfluxqlMaxSelectSeriesLong", "documentation":"Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.
Default: 0
" }, "pprofDisabled":{ "shape":"Boolean", "documentation":"Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.
Default: false
" }, "queryInitialMemoryBytes":{ "shape":"InfluxDBv2ParametersQueryInitialMemoryBytesLong", "documentation":"Initial bytes of memory allocated for a query.
Default: 0
" }, "queryMaxMemoryBytes":{ "shape":"InfluxDBv2ParametersQueryMaxMemoryBytesLong", "documentation":"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
" }, "queryMemoryBytes":{ "shape":"InfluxDBv2ParametersQueryMemoryBytesLong", "documentation":"Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.
Default: 0
" }, "sessionLength":{ "shape":"InfluxDBv2ParametersSessionLengthInteger", "documentation":"Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
" }, "sessionRenewDisabled":{ "shape":"Boolean", "documentation":"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
" }, "storageCacheMaxMemorySize":{ "shape":"InfluxDBv2ParametersStorageCacheMaxMemorySizeLong", "documentation":"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
" }, "storageCacheSnapshotMemorySize":{ "shape":"InfluxDBv2ParametersStorageCacheSnapshotMemorySizeLong", "documentation":"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
" }, "storageCacheSnapshotWriteColdDuration":{ "shape":"Duration", "documentation":"Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.
Default: 10 minutes
" }, "storageCompactFullWriteColdDuration":{ "shape":"Duration", "documentation":"Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.
Default: 4 hours
" }, "storageCompactThroughputBurst":{ "shape":"InfluxDBv2ParametersStorageCompactThroughputBurstLong", "documentation":"Rate limit (in bytes per second) that TSM compactions can write to disk.
Default: 50331648
" }, "storageMaxConcurrentCompactions":{ "shape":"InfluxDBv2ParametersStorageMaxConcurrentCompactionsInteger", "documentation":"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
" }, "storageMaxIndexLogFileSize":{ "shape":"InfluxDBv2ParametersStorageMaxIndexLogFileSizeLong", "documentation":"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
" }, "storageNoValidateFieldSize":{ "shape":"Boolean", "documentation":"Skip field size validation on incoming write requests.
Default: false
" }, "storageRetentionCheckInterval":{ "shape":"Duration", "documentation":"Interval of retention policy enforcement checks. Must be greater than 0.
Default: 30 minutes
" }, "storageSeriesFileMaxConcurrentSnapshotCompactions":{ "shape":"InfluxDBv2ParametersStorageSeriesFileMaxConcurrentSnapshotCompactionsInteger", "documentation":"Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
Default: 0
" }, "storageSeriesIdSetCacheSize":{ "shape":"InfluxDBv2ParametersStorageSeriesIdSetCacheSizeLong", "documentation":"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
" }, "storageWalMaxConcurrentWrites":{ "shape":"InfluxDBv2ParametersStorageWalMaxConcurrentWritesInteger", "documentation":"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
" }, "storageWalMaxWriteDelay":{ "shape":"Duration", "documentation":"Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.
Default: 10 minutes
" }, "uiDisabled":{ "shape":"Boolean", "documentation":"Disable the InfluxDB user interface (UI). The UI is enabled by default.
Default: false
" } }, "documentation":"All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
" }, "InfluxDBv2ParametersInfluxqlMaxSelectBucketsLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersInfluxqlMaxSelectPointLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersInfluxqlMaxSelectSeriesLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersQueryConcurrencyInteger":{ "type":"integer", "box":true, "max":256, "min":0 }, "InfluxDBv2ParametersQueryInitialMemoryBytesLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersQueryMaxMemoryBytesLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersQueryMemoryBytesLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersQueryQueueSizeInteger":{ "type":"integer", "box":true, "max":256, "min":0 }, "InfluxDBv2ParametersSessionLengthInteger":{ "type":"integer", "box":true, "max":2880, "min":1 }, "InfluxDBv2ParametersStorageCacheMaxMemorySizeLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersStorageCacheSnapshotMemorySizeLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersStorageCompactThroughputBurstLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersStorageMaxConcurrentCompactionsInteger":{ "type":"integer", "box":true, "max":64, "min":0 }, "InfluxDBv2ParametersStorageMaxIndexLogFileSizeLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersStorageSeriesFileMaxConcurrentSnapshotCompactionsInteger":{ "type":"integer", "box":true, "max":64, "min":0 }, "InfluxDBv2ParametersStorageSeriesIdSetCacheSizeLong":{ "type":"long", "box":true, "max":1000000000000, "min":0 }, "InfluxDBv2ParametersStorageWalMaxConcurrentWritesInteger":{ "type":"integer", "box":true, "max":256, "min":0 }, "InstanceMode":{ "type":"string", "enum":[ "PRIMARY", "STANDBY", "REPLICA" ] }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The request processing has failed because of an unknown error, exception or failure.
", "exception":true, "fault":true, "retryable":{"throttling":false} }, "ListDbClustersInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"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 an argument of a subsequent API invocation.
" } } }, "ListDbClustersOutput":{ "type":"structure", "required":["items"], "members":{ "items":{ "shape":"DbClusterSummaryList", "documentation":"A list of Timestream for InfluxDB cluster summaries.
" }, "nextToken":{ "shape":"NextToken", "documentation":"Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
" } } }, "ListDbInstancesForClusterInput":{ "type":"structure", "required":["dbClusterId"], "members":{ "dbClusterId":{ "shape":"DbClusterId", "documentation":"Service-generated unique identifier of the DB cluster.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"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 an argument of a subsequent API invocation.
" } } }, "ListDbInstancesForClusterOutput":{ "type":"structure", "required":["items"], "members":{ "items":{ "shape":"DbInstanceForClusterSummaryList", "documentation":"A list of Timestream for InfluxDB instance summaries belonging to the cluster.
" }, "nextToken":{ "shape":"NextToken", "documentation":"Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
" } } }, "ListDbInstancesInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"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.
" } } }, "ListDbInstancesOutput":{ "type":"structure", "required":["items"], "members":{ "items":{ "shape":"DbInstanceSummaryList", "documentation":"A list of Timestream for InfluxDB DB instance summaries.
" }, "nextToken":{ "shape":"NextToken", "documentation":"Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
" } } }, "ListDbParameterGroupsInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"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.
" } } }, "ListDbParameterGroupsOutput":{ "type":"structure", "required":["items"], "members":{ "items":{ "shape":"DbParameterGroupSummaryList", "documentation":"A list of Timestream for InfluxDB DB parameter group summaries.
" }, "nextToken":{ "shape":"NextToken", "documentation":"Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the tagged resource.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"ResponseTagMap", "documentation":"A list of tags used to categorize and track resources.
" } } }, "LogDeliveryConfiguration":{ "type":"structure", "required":["s3Configuration"], "members":{ "s3Configuration":{ "shape":"S3Configuration", "documentation":"Configuration for S3 bucket log delivery.
" } }, "documentation":"Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" }, "LogLevel":{ "type":"string", "enum":[ "debug", "info", "error" ] }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "NetworkType":{ "type":"string", "enum":[ "IPV4", "DUAL" ] }, "NextToken":{ "type":"string", "min":1 }, "Organization":{ "type":"string", "max":64, "min":1 }, "Parameters":{ "type":"structure", "members":{ "InfluxDBv2":{ "shape":"InfluxDBv2Parameters", "documentation":"All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
" } }, "documentation":"The parameters that comprise the parameter group.
", "union":true }, "Password":{ "type":"string", "max":64, "min":8, "pattern":"[a-zA-Z0-9]+", "sensitive":true }, "Port":{ "type":"integer", "box":true, "max":65535, "min":1024 }, "RequestTagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"The identifier for the Timestream for InfluxDB resource associated with the request.
" }, "resourceType":{ "shape":"String", "documentation":"The type of Timestream for InfluxDB resource associated with the request.
" } }, "documentation":"The requested resource was not found or does not exist.
", "exception":true }, "ResponseTagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":0 }, "S3Configuration":{ "type":"structure", "required":[ "bucketName", "enabled" ], "members":{ "bucketName":{ "shape":"S3ConfigurationBucketNameString", "documentation":"The name of the S3 bucket to deliver logs to.
" }, "enabled":{ "shape":"Boolean", "documentation":"Indicates whether log delivery to the S3 bucket is enabled.
" } }, "documentation":"Configuration for S3 bucket log delivery.
" }, "S3ConfigurationBucketNameString":{ "type":"string", "max":63, "min":3, "pattern":"[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The request exceeds the service quota.
", "exception":true }, "Status":{ "type":"string", "enum":[ "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED", "UPDATING_DEPLOYMENT_TYPE", "UPDATING_INSTANCE_TYPE" ] }, "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the tagged resource.
" }, "tags":{ "shape":"RequestTagMap", "documentation":"A list of tags used to categorize and track resources.
" } } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "retryAfterSeconds":{ "shape":"Integer", "documentation":"The number of seconds the caller should wait before retrying.
" } }, "documentation":"The request was denied due to request throttling.
", "exception":true, "retryable":{"throttling":false} }, "TracingType":{ "type":"string", "enum":[ "log", "jaeger" ] }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the tagged resource.
" }, "tagKeys":{ "shape":"TagKeys", "documentation":"The keys used to identify the tags.
" } } }, "UpdateDbClusterInput":{ "type":"structure", "required":["dbClusterId"], "members":{ "dbClusterId":{ "shape":"DbClusterId", "documentation":"Service-generated unique identifier of the DB cluster to update.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"The log delivery configuration to apply to the DB cluster.
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"Update the DB cluster to use the specified DB parameter group.
" }, "port":{ "shape":"Port", "documentation":"Update the DB cluster to use the specified port.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"Update the DB cluster to use the specified DB instance Type.
" }, "failoverMode":{ "shape":"FailoverMode", "documentation":"Update the DB cluster's failover behavior.
" } } }, "UpdateDbClusterOutput":{ "type":"structure", "members":{ "dbClusterStatus":{ "shape":"ClusterStatus", "documentation":"The status of the DB cluster.
" } } }, "UpdateDbInstanceInput":{ "type":"structure", "required":["identifier"], "members":{ "identifier":{ "shape":"DbInstanceIdentifier", "documentation":"The id of the DB instance.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"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.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
If you change the Port value, your database restarts immediately.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB DB instance type to run InfluxDB on.
" }, "deploymentType":{ "shape":"DeploymentType", "documentation":"Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage to allocate for your DB storage type (in gibibytes).
" } } }, "UpdateDbInstanceOutput":{ "type":"structure", "required":[ "id", "name", "arn", "vpcSubnetIds" ], "members":{ "id":{ "shape":"DbInstanceId", "documentation":"A service-generated unique identifier.
" }, "name":{ "shape":"DbInstanceName", "documentation":"This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the DB instance.
" }, "status":{ "shape":"Status", "documentation":"The status of the DB instance.
" }, "endpoint":{ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, "port":{ "shape":"Port", "documentation":"The port number on which InfluxDB accepts connections.
" }, "networkType":{ "shape":"NetworkType", "documentation":"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.
" }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" }, "dbStorageType":{ "shape":"DbStorageType", "documentation":"The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" }, "allocatedStorage":{ "shape":"AllocatedStorage", "documentation":"The amount of storage allocated for your DB storage type (in gibibytes).
" }, "deploymentType":{ "shape":"DeploymentType", "documentation":"Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
" }, "vpcSubnetIds":{ "shape":"VpcSubnetIdList", "documentation":"A list of VPC subnet IDs associated with the DB instance.
" }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"Indicates if the DB instance has a public IP to facilitate access.
" }, "vpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"A list of VPC security group IDs associated with the DB instance.
" }, "dbParameterGroupIdentifier":{ "shape":"DbParameterGroupIdentifier", "documentation":"The id of the DB parameter group assigned to your DB instance.
" }, "availabilityZone":{ "shape":"String", "documentation":"The Availability Zone in which the DB instance resides.
" }, "secondaryAvailabilityZone":{ "shape":"String", "documentation":"The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
" }, "logDeliveryConfiguration":{ "shape":"LogDeliveryConfiguration", "documentation":"Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" }, "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" }, "dbClusterId":{ "shape":"DbClusterId", "documentation":"Specifies the DbCluster to which this DbInstance belongs to.
" }, "instanceMode":{ "shape":"InstanceMode", "documentation":"Specifies the DbInstance's role in the cluster.
" } } }, "Username":{ "type":"string", "max":64, "min":1, "sensitive":true }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{"shape":"String"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The reason that validation failed.
" } }, "documentation":"The input fails to satisfy the constraints specified by Timestream for InfluxDB.
", "exception":true }, "ValidationExceptionReason":{ "type":"string", "enum":[ "FIELD_VALIDATION_FAILED", "OTHER" ] }, "VpcSecurityGroupId":{ "type":"string", "max":64, "min":0, "pattern":"sg-[a-z0-9]+" }, "VpcSecurityGroupIdList":{ "type":"list", "member":{"shape":"VpcSecurityGroupId"}, "max":5, "min":1 }, "VpcSubnetId":{ "type":"string", "max":64, "min":0, "pattern":"subnet-[a-z0-9]+" }, "VpcSubnetIdList":{ "type":"list", "member":{"shape":"VpcSubnetId"}, "max":3, "min":1 } }, "documentation":"Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on Amazon Web Services for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
" }