feat(client-timestream-influxdb): Adds networkType parameter to CreateDbInstance API which allows IPv6 support to the InfluxDB endpoint

awstools · awstools · commit a69d90ce4b42 · 2024-12-11T19:51:10.000Z
diff --git a/clients/client-timestream-influxdb/README.md b/clients/client-timestream-influxdb/README.md
@@ -6,7 +6,7 @@
 
 AWS SDK for JavaScript TimestreamInfluxDB Client for Node.js, Browser and React Native.
 
-<p>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 AWS 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.</p>
+<p>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.</p>
 
 ## Installing
 
diff --git a/clients/client-timestream-influxdb/src/TimestreamInfluxDB.ts b/clients/client-timestream-influxdb/src/TimestreamInfluxDB.ts
@@ -240,7 +240,7 @@ export interface TimestreamInfluxDB {
 }
 
 /**
- * <p>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 AWS 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.</p>
+ * <p>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.</p>
  * @public
  */
 export class TimestreamInfluxDB extends TimestreamInfluxDBClient implements TimestreamInfluxDB {}
diff --git a/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts b/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts
@@ -291,7 +291,7 @@ export type TimestreamInfluxDBClientResolvedConfigType = __SmithyResolvedConfigu
 export interface TimestreamInfluxDBClientResolvedConfig extends TimestreamInfluxDBClientResolvedConfigType {}
 
 /**
- * <p>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 AWS 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.</p>
+ * <p>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.</p>
  * @public
  */
 export class TimestreamInfluxDBClient extends __Client<
diff --git a/clients/client-timestream-influxdb/src/commands/CreateDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/CreateDbInstanceCommand.ts
@@ -71,6 +71,7 @@ export interface CreateDbInstanceCommandOutput extends CreateDbInstanceOutput, _
  *     "<keys>": "STRING_VALUE",
  *   },
  *   port: Number("int"),
+ *   networkType: "IPV4" || "DUAL",
  * };
  * const command = new CreateDbInstanceCommand(input);
  * const response = await client.send(command);
@@ -81,6 +82,7 @@ export interface CreateDbInstanceCommandOutput extends CreateDbInstanceOutput, _
  * //   status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE",
  * //   endpoint: "STRING_VALUE",
  * //   port: Number("int"),
+ * //   networkType: "IPV4" || "DUAL",
  * //   dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge",
  * //   dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
  * //   allocatedStorage: Number("int"),
diff --git a/clients/client-timestream-influxdb/src/commands/DeleteDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/DeleteDbInstanceCommand.ts
@@ -51,6 +51,7 @@ export interface DeleteDbInstanceCommandOutput extends DeleteDbInstanceOutput, _
  * //   status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE",
  * //   endpoint: "STRING_VALUE",
  * //   port: Number("int"),
+ * //   networkType: "IPV4" || "DUAL",
  * //   dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge",
  * //   dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
  * //   allocatedStorage: Number("int"),
diff --git a/clients/client-timestream-influxdb/src/commands/GetDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/GetDbInstanceCommand.ts
@@ -51,6 +51,7 @@ export interface GetDbInstanceCommandOutput extends GetDbInstanceOutput, __Metad
  * //   status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE",
  * //   endpoint: "STRING_VALUE",
  * //   port: Number("int"),
+ * //   networkType: "IPV4" || "DUAL",
  * //   dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge",
  * //   dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
  * //   allocatedStorage: Number("int"),
diff --git a/clients/client-timestream-influxdb/src/commands/ListDbInstancesCommand.ts b/clients/client-timestream-influxdb/src/commands/ListDbInstancesCommand.ts
@@ -54,6 +54,7 @@ export interface ListDbInstancesCommandOutput extends ListDbInstancesOutput, __M
  * //       status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE",
  * //       endpoint: "STRING_VALUE",
  * //       port: Number("int"),
+ * //       networkType: "IPV4" || "DUAL",
  * //       dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge",
  * //       dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
  * //       allocatedStorage: Number("int"),
diff --git a/clients/client-timestream-influxdb/src/commands/TagResourceCommand.ts b/clients/client-timestream-influxdb/src/commands/TagResourceCommand.ts
@@ -60,6 +60,9 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The requested resource was not found or does not exist.</p>
  *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request exceeds the service quota.</p>
+ *
  * @throws {@link TimestreamInfluxDBServiceException}
  * <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
  *
diff --git a/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts
@@ -61,6 +61,7 @@ export interface UpdateDbInstanceCommandOutput extends UpdateDbInstanceOutput, _
  * //   status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE",
  * //   endpoint: "STRING_VALUE",
  * //   port: Number("int"),
+ * //   networkType: "IPV4" || "DUAL",
  * //   dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge",
  * //   dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
  * //   allocatedStorage: Number("int"),
diff --git a/clients/client-timestream-influxdb/src/index.ts b/clients/client-timestream-influxdb/src/index.ts
@@ -1,7 +1,7 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>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 AWS 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.</p>
+ * <p>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.</p>
  *
  * @packageDocumentation
  */
diff --git a/clients/client-timestream-influxdb/src/models/models_0.ts b/clients/client-timestream-influxdb/src/models/models_0.ts
@@ -136,6 +136,20 @@ export interface LogDeliveryConfiguration {
   s3Configuration: S3Configuration | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const NetworkType = {
+  DUAL: "DUAL",
+  IPV4: "IPV4",
+} as const;
+
+/**
+ * @public
+ */
+export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];
+
 /**
  * @public
  */
@@ -153,7 +167,7 @@ export interface CreateDbInstanceInput {
   username?: string | undefined;
 
   /**
-   * <p>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.</p>
+   * <p>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.</p>
    * @public
    */
   password: string | undefined;
@@ -250,6 +264,12 @@ export interface CreateDbInstanceInput {
    * @public
    */
   port?: number | undefined;
+
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  networkType?: NetworkType | undefined;
 }
 
 /**
@@ -313,6 +333,12 @@ export interface CreateDbInstanceOutput {
    */
   port?: number | undefined;
 
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  networkType?: NetworkType | undefined;
+
   /**
    * <p>The Timestream for InfluxDB instance type that InfluxDB runs on.</p>
    * @public
@@ -380,7 +406,7 @@ export interface CreateDbInstanceOutput {
   logDeliveryConfiguration?: LogDeliveryConfiguration | undefined;
 
   /**
-   * <p>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.</p>
+   * <p>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.</p>
    * @public
    */
   influxAuthParametersSecretArn?: string | undefined;
@@ -581,6 +607,12 @@ export interface DeleteDbInstanceOutput {
    */
   port?: number | undefined;
 
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  networkType?: NetworkType | undefined;
+
   /**
    * <p>The Timestream for InfluxDB instance type that InfluxDB runs on.</p>
    * @public
@@ -648,7 +680,7 @@ export interface DeleteDbInstanceOutput {
   logDeliveryConfiguration?: LogDeliveryConfiguration | undefined;
 
   /**
-   * <p>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.</p>
+   * <p>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.</p>
    * @public
    */
   influxAuthParametersSecretArn?: string | undefined;
@@ -705,6 +737,12 @@ export interface GetDbInstanceOutput {
    */
   port?: number | undefined;
 
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  networkType?: NetworkType | undefined;
+
   /**
    * <p>The Timestream for InfluxDB instance type that InfluxDB runs on.</p>
    * @public
@@ -772,7 +810,7 @@ export interface GetDbInstanceOutput {
   logDeliveryConfiguration?: LogDeliveryConfiguration | undefined;
 
   /**
-   * <p>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.</p>
+   * <p>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.</p>
    * @public
    */
   influxAuthParametersSecretArn?: string | undefined;
@@ -807,7 +845,7 @@ export interface DbInstanceSummary {
   id: string | undefined;
 
   /**
-   * <p>This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.</p>
+   * <p>This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.</p>
    * @public
    */
   name: string | undefined;
@@ -836,6 +874,12 @@ export interface DbInstanceSummary {
    */
   port?: number | undefined;
 
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  networkType?: NetworkType | undefined;
+
   /**
    * <p>The Timestream for InfluxDB instance type to run InfluxDB on.</p>
    * @public
@@ -935,7 +979,7 @@ export interface UpdateDbInstanceOutput {
   id: string | undefined;
 
   /**
-   * <p>This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.</p>
+   * <p>This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and Amazon Web Services CLI commands.</p>
    * @public
    */
   name: string | undefined;
@@ -964,6 +1008,12 @@ export interface UpdateDbInstanceOutput {
    */
   port?: number | undefined;
 
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  networkType?: NetworkType | undefined;
+
   /**
    * <p>The Timestream for InfluxDB instance type that InfluxDB runs on.</p>
    * @public
@@ -1031,7 +1081,7 @@ export interface UpdateDbInstanceOutput {
   logDeliveryConfiguration?: LogDeliveryConfiguration | undefined;
 
   /**
-   * <p>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.</p>
+   * <p>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.</p>
    * @public
    */
   influxAuthParametersSecretArn?: string | undefined;
diff --git a/codegen/sdk-codegen/aws-models/timestream-influxdb.json b/codegen/sdk-codegen/aws-models/timestream-influxdb.json

Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,7 @@ export interface TimestreamInfluxDB {`
`240`	`240`	`}`
`241`	`241`
`242`	`242`	`/**`
`243`		`- * <p>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 AWS 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.</p>`
	`243`	`+ * <p>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.</p>`
`244`	`244`	`* @public`
`245`	`245`	`*/`
`246`	`246`	`export class TimestreamInfluxDB extends TimestreamInfluxDBClient implements TimestreamInfluxDB {}`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,9 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}`
`60`	`60`	`* @throws {@link ResourceNotFoundException} (client fault)`
`61`	`61`	`* <p>The requested resource was not found or does not exist.</p>`
`62`	`62`	`*`
	`63`	`+ * @throws {@link ServiceQuotaExceededException} (client fault)`
	`64`	`+ * <p>The request exceeds the service quota.</p>`
	`65`	`+ *`
`63`	`66`	`* @throws {@link TimestreamInfluxDBServiceException}`
`64`	`67`	`* <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>`
`65`	`68`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`// smithy-typescript generated code`
`2`	`2`	`/* eslint-disable */`
`3`	`3`	`/**`
`4`		`- * <p>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 AWS 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.</p>`
	`4`	`+ * <p>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.</p>`
`5`	`5`	`*`
`6`	`6`	`* @packageDocumentation`
`7`	`7`	`*/`