AWS CLI Command Reference

[ aws . timestream-influxdb ]

create-db-instance

Description

Creates a new Timestream for InfluxDB DB instance.

See also: AWS API Documentation

Synopsis

  create-db-instance
--name <value>
[--username <value>]
--password <value>
[--organization <value>]
[--bucket <value>]
--db-instance-type <value>
--vpc-subnet-ids <value>
--vpc-security-group-ids <value>
[--publicly-accessible | --no-publicly-accessible]
[--db-storage-type <value>]
--allocated-storage <value>
[--db-parameter-group-identifier <value>]
[--deployment-type <value>]
[--log-delivery-configuration <value>]
[--tags <value>]
[--port <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--name (string)

The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.

--username (string)

The username of the initial admin user created in InfluxDB. Must start with a letter and can’t end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.

--password (string)

The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.

--organization (string)

The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.

--bucket (string)

The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.

--db-instance-type (string)

The Timestream for InfluxDB DB instance type to run InfluxDB on.

Possible values:

  • db.influx.medium
  • db.influx.large
  • db.influx.xlarge
  • db.influx.2xlarge
  • db.influx.4xlarge
  • db.influx.8xlarge
  • db.influx.12xlarge
  • db.influx.16xlarge

--vpc-subnet-ids (list)

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.

(string)

Syntax:

"string" "string" ...

--vpc-security-group-ids (list)

A list of VPC security group IDs to associate with the DB instance.

(string)

Syntax:

"string" "string" ...

--publicly-accessible | --no-publicly-accessible (boolean)

Configures the DB instance with a public IP to facilitate access.

--db-storage-type (string)

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

Possible values:

  • InfluxIOIncludedT1
  • InfluxIOIncludedT2
  • InfluxIOIncludedT3

--allocated-storage (integer)

The amount of storage to allocate for your DB storage type in GiB (gibibytes).

--db-parameter-group-identifier (string)

The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

--deployment-type (string)

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

Possible values:

  • SINGLE_AZ
  • WITH_MULTIAZ_STANDBY

--log-delivery-configuration (structure)

Configuration for sending InfluxDB engine logs to a specified S3 bucket.

s3Configuration -> (structure)

Configuration for S3 bucket log delivery.

bucketName -> (string)

The name of the S3 bucket to deliver logs to.

enabled -> (boolean)

Indicates whether log delivery to the S3 bucket is enabled.

Shorthand Syntax:

s3Configuration={bucketName=string,enabled=boolean}

JSON Syntax:

{
  "s3Configuration": {
    "bucketName": "string",
    "enabled": true|false
  }
}

--tags (map)

A list of key-value pairs to associate with the DB instance.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--port (integer)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

id -> (string)

A service-generated unique identifier.

name -> (string)

The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

arn -> (string)

The Amazon Resource Name (ARN) of the DB instance.

status -> (string)

The status of the DB instance.

endpoint -> (string)

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

port -> (integer)

The port number on which InfluxDB accepts connections. The default value is 8086.

dbInstanceType -> (string)

The Timestream for InfluxDB instance type that InfluxDB runs on.

dbStorageType -> (string)

The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

allocatedStorage -> (integer)

The amount of storage allocated for your DB storage type (in gibibytes).

deploymentType -> (string)

Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

vpcSubnetIds -> (list)

A list of VPC subnet IDs associated with the DB instance.

(string)

publiclyAccessible -> (boolean)

Indicates if the DB instance has a public IP to facilitate access.

vpcSecurityGroupIds -> (list)

A list of VPC security group IDs associated with the DB instance.

(string)

dbParameterGroupIdentifier -> (string)

The id of the DB parameter group assigned to your DB instance.

availabilityZone -> (string)

The Availability Zone in which the DB instance resides.

secondaryAvailabilityZone -> (string)

The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

logDeliveryConfiguration -> (structure)

Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

s3Configuration -> (structure)

Configuration for S3 bucket log delivery.

bucketName -> (string)

The name of the S3 bucket to deliver logs to.

enabled -> (boolean)

Indicates whether log delivery to the S3 bucket is enabled.

influxAuthParametersSecretArn -> (string)

The Amazon Resource Name (ARN) of the AWS 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.
© Copyright 2018, Amazon Web Services. Created using Sphinx.