id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
timestream-238
|
timestream.pdf
| 238 |
on the time-based and attribute-based pruning of the tables accessed by the query. This information helps you identify the tables that are sub-optimally accessed. • Optimizing your data model and partitioning – You can use the QueryInsights information to access and fine-tune your data model and partitioning strategy. • Tuning queries – QueryInsights highlights opportunities to use indexes more effectively. Note The maximum number of Query API requests you're allowed to make with QueryInsights enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling. Data Types 1024 Amazon Timestream Contents Mode Developer Guide Provides the following modes to enable QueryInsights: • ENABLED_WITH_RATE_CONTROL – Enables QueryInsights for the queries being processed. This mode also includes a rate control mechanism, which limits the QueryInsights feature to 1 query per second (QPS). • DISABLED – Disables QueryInsights. Type: String Valid Values: ENABLED_WITH_RATE_CONTROL | DISABLED Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1025 Amazon Timestream Developer Guide QueryInsightsResponse Service: Amazon Timestream Query Provides various insights and metrics related to the query that you executed. Contents OutputBytes Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise. Type: Long Required: No OutputRows Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise. Type: Long Required: No QuerySpatialCoverage Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning. Type: QuerySpatialCoverage object Required: No QueryTableCount Indicates the number of tables in the query. Type: Long Required: No Data Types 1026 Amazon Timestream QueryTemporalRange Developer Guide Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning: • Add missing time-predicates. • Remove functions around the time predicates. • Add time predicates to all the sub-queries. Type: QueryTemporalRange object Required: No UnloadPartitionCount Indicates the partitions created by the Unload operation. Type: Long Required: No UnloadWrittenBytes Indicates the size, in bytes, written by the Unload operation. Type: Long Required: No UnloadWrittenRows Indicates the rows written by the Unload query. Type: Long Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ Data Types 1027 Amazon Timestream • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide Data Types 1028 Amazon Timestream Developer Guide QuerySpatialCoverage Service: Amazon Timestream Query Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning For example, you can do the following with the QuerySpatialCoverage information: • Add measure_name or use customer-defined partition key (CDPK) predicates. • If you've already done the preceding action, remove functions around them or clauses, such as LIKE. Contents Max Provides insights into the spatial coverage of the executed query and the table with the most inefficient spatial pruning. • Value – The maximum ratio of spatial coverage. • TableArn – The Amazon Resource Name (ARN) of the table with sub-optimal spatial pruning. • PartitionKey – The partition key used for partitioning, which can be a default measure_name or a CDPK. Type: QuerySpatialCoverageMax object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1029 Amazon Timestream Developer Guide QuerySpatialCoverageMax Service: Amazon Timestream Query Provides insights into the table with the most sub-optimal spatial range scanned by your query. Contents PartitionKey The partition key used for partitioning, which can be a default measure_name or a customer defined partition key. Type: Array of strings Required: No TableArn The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Value The maximum ratio of spatial coverage. Type: Double Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 •
|
timestream-239
|
timestream.pdf
| 239 |
by your query. Contents PartitionKey The partition key used for partitioning, which can be a default measure_name or a customer defined partition key. Type: Array of strings Required: No TableArn The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Value The maximum ratio of spatial coverage. Type: Double Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1030 Amazon Timestream Developer Guide QueryStatus Service: Amazon Timestream Query Information about the status of the query, including progress and bytes scanned. Contents CumulativeBytesMetered The amount of data scanned by the query in bytes that you will be charged for. This is a cumulative sum and represents the total amount of data that you will be charged for since the query was started. The charge is applied only once and is either applied when the query completes running or when the query is cancelled. Type: Long Required: No CumulativeBytesScanned The amount of data scanned by the query in bytes. This is a cumulative sum and represents the total amount of bytes scanned since the query was started. Type: Long Required: No ProgressPercentage The progress of the query, expressed as a percentage. Type: Double Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1031 Amazon Timestream Developer Guide Data Types 1032 Amazon Timestream Developer Guide QueryTemporalRange Service: Amazon Timestream Query Provides insights into the temporal range of the query, including the table with the largest (max) time range. Contents Max Encapsulates the following properties that provide insights into the most sub-optimal performing table on the temporal axis: • Value – The maximum duration in nanoseconds between the start and end of the query. • TableArn – The Amazon Resource Name (ARN) of the table which is queried with the largest time range. Type: QueryTemporalRangeMax object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1033 Amazon Timestream Developer Guide QueryTemporalRangeMax Service: Amazon Timestream Query Provides insights into the table with the most sub-optimal temporal pruning scanned by your query. Contents TableArn The Amazon Resource Name (ARN) of the table which is queried with the largest time range. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Value The maximum duration in nanoseconds between the start and end of the query. Type: Long Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1034 Amazon Timestream Developer Guide Row Service: Amazon Timestream Query Represents a single row in the query results. Contents Data List of data points in a single row of the result set. Type: Array of Datum objects Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1035 Amazon Timestream Developer Guide S3Configuration Service: Amazon Timestream Query Details on S3 location for error reports that result from running a query. Contents BucketName Name of the S3 bucket under which error reports will be created. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9] Required: Yes EncryptionOption Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default. Type: String Valid Values: SSE_S3 | SSE_KMS Required: No ObjectKeyPrefix Prefix for the error report key. Timestream by default adds the following prefix to the error report path. Type: String Length Constraints: Minimum length of 1. Maximum length of 896. Pattern: [a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+ Required: No Data Types 1036 Amazon Timestream See Also Developer Guide For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1037 Amazon Timestream Developer Guide S3ReportLocation Service: Amazon Timestream Query S3 report location for the scheduled query run. Contents BucketName S3 bucket name. Type: String Length Constraints: Minimum length of 3. Maximum length of 63.
|
timestream-240
|
timestream.pdf
| 240 |
the error report path. Type: String Length Constraints: Minimum length of 1. Maximum length of 896. Pattern: [a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+ Required: No Data Types 1036 Amazon Timestream See Also Developer Guide For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1037 Amazon Timestream Developer Guide S3ReportLocation Service: Amazon Timestream Query S3 report location for the scheduled query run. Contents BucketName S3 bucket name. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9] Required: No ObjectKey S3 key. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1038 Amazon Timestream Developer Guide ScheduleConfiguration Service: Amazon Timestream Query Configuration of the schedule of the query. Contents ScheduleExpression An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1039 Amazon Timestream Developer Guide ScheduledQuery Service: Amazon Timestream Query Scheduled Query Contents Arn The Amazon Resource Name. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Name The name of the scheduled query. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+ Required: Yes State State of scheduled query. Type: String Valid Values: ENABLED | DISABLED Required: Yes CreationTime The creation time of the scheduled query. Type: Timestamp Required: No Data Types 1040 Developer Guide Amazon Timestream ErrorReportConfiguration Configuration for scheduled query error reporting. Type: ErrorReportConfiguration object Required: No LastRunStatus Status of the last scheduled query run. Type: String Valid Values: AUTO_TRIGGER_SUCCESS | AUTO_TRIGGER_FAILURE | MANUAL_TRIGGER_SUCCESS | MANUAL_TRIGGER_FAILURE Required: No NextInvocationTime The next time the scheduled query is to be run. Type: Timestamp Required: No PreviousInvocationTime The last time the scheduled query was run. Type: Timestamp Required: No TargetDestination Target data source where final scheduled query result will be written. Type: TargetDestination object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Data Types 1041 Amazon Timestream • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Developer Guide Data Types 1042 Amazon Timestream Developer Guide ScheduledQueryDescription Service: Amazon Timestream Query Structure that describes scheduled query. Contents Arn Scheduled query ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Name Name of the scheduled query. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+ Required: Yes NotificationConfiguration Notification configuration. Type: NotificationConfiguration object Required: Yes QueryString The query to be run. Type: String Length Constraints: Minimum length of 1. Maximum length of 262144. Required: Yes Data Types 1043 Developer Guide Amazon Timestream ScheduleConfiguration Schedule configuration. Type: ScheduleConfiguration object Required: Yes State State of the scheduled query. Type: String Valid Values: ENABLED | DISABLED Required: Yes CreationTime Creation time of the scheduled query. Type: Timestamp Required: No ErrorReportConfiguration Error-reporting configuration for the scheduled query. Type: ErrorReportConfiguration object Required: No KmsKeyId A customer provided KMS key used to encrypt the scheduled query resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No LastRunSummary Runtime summary for the last scheduled query run. Data Types 1044 Amazon Timestream Developer Guide Type: ScheduledQueryRunSummary object Required: No NextInvocationTime The next time the scheduled query is scheduled to run. Type: Timestamp Required: No PreviousInvocationTime Last time the query was run. Type: Timestamp Required: No RecentlyFailedRuns Runtime summary for the last five failed scheduled query runs. Type: Array of ScheduledQueryRunSummary objects Required: No ScheduledQueryExecutionRoleArn IAM role that Timestream uses to run the schedule query. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No TargetConfiguration Scheduled query target store configuration. Type: TargetConfiguration object Required: No Data Types 1045 Amazon Timestream See Also Developer Guide For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1046 Amazon Timestream Developer Guide ScheduledQueryInsights Service: Amazon Timestream Query Encapsulates settings for enabling QueryInsights on an ExecuteScheduledQueryRequest. Contents Mode Provides the following modes to enable ScheduledQueryInsights: • ENABLED_WITH_RATE_CONTROL – Enables ScheduledQueryInsights for the queries being processed. This
|
timestream-241
|
timestream.pdf
| 241 |
Maximum length of 2048. Required: No TargetConfiguration Scheduled query target store configuration. Type: TargetConfiguration object Required: No Data Types 1045 Amazon Timestream See Also Developer Guide For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1046 Amazon Timestream Developer Guide ScheduledQueryInsights Service: Amazon Timestream Query Encapsulates settings for enabling QueryInsights on an ExecuteScheduledQueryRequest. Contents Mode Provides the following modes to enable ScheduledQueryInsights: • ENABLED_WITH_RATE_CONTROL – Enables ScheduledQueryInsights for the queries being processed. This mode also includes a rate control mechanism, which limits the QueryInsights feature to 1 query per second (QPS). • DISABLED – Disables ScheduledQueryInsights. Type: String Valid Values: ENABLED_WITH_RATE_CONTROL | DISABLED Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1047 Amazon Timestream Developer Guide ScheduledQueryInsightsResponse Service: Amazon Timestream Query Provides various insights and metrics related to the ExecuteScheduledQueryRequest that was executed. Contents OutputBytes Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise. Type: Long Required: No OutputRows Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise. Type: Long Required: No QuerySpatialCoverage Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning. Type: QuerySpatialCoverage object Required: No QueryTableCount Indicates the number of tables in the query. Type: Long Required: No Data Types 1048 Amazon Timestream QueryTemporalRange Developer Guide Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning: • Add missing time-predicates. • Remove functions around the time predicates. • Add time predicates to all the sub-queries. Type: QueryTemporalRange object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1049 Amazon Timestream Developer Guide ScheduledQueryRunSummary Service: Amazon Timestream Query Run summary for the scheduled query Contents ErrorReportLocation S3 location for error report. Type: ErrorReportLocation object Required: No ExecutionStats Runtime statistics for a scheduled run. Type: ExecutionStats object Required: No FailureReason Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons. Type: String Required: No InvocationTime InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value. Type: Timestamp Required: No QueryInsightsResponse Provides various insights and metrics related to the run summary of the scheduled query. Type: ScheduledQueryInsightsResponse object Data Types 1050 Amazon Timestream Required: No RunStatus The status of a scheduled query run. Type: String Valid Values: AUTO_TRIGGER_SUCCESS | AUTO_TRIGGER_FAILURE | MANUAL_TRIGGER_SUCCESS | MANUAL_TRIGGER_FAILURE Developer Guide Required: No TriggerTime The actual time when the query was run. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1051 Amazon Timestream Developer Guide SelectColumn Service: Amazon Timestream Query Details of the column that is returned by the query. Contents Aliased True, if the column name was aliased by the query. False otherwise. Type: Boolean Required: No DatabaseName Database that has this column. Type: String Required: No Name Name of the column. Type: String Required: No TableName Table within the database that has this column. Type: String Required: No Type Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries. Type: Type object Data Types 1052 Amazon Timestream Required: No See Also Developer Guide For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1053 Amazon Timestream Developer Guide SnsConfiguration Service: Amazon Timestream
|
timestream-242
|
timestream.pdf
| 242 |
of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries. Type: Type object Data Types 1052 Amazon Timestream Required: No See Also Developer Guide For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1053 Amazon Timestream Developer Guide SnsConfiguration Service: Amazon Timestream Query Details on SNS that are required to send the notification. Contents TopicArn SNS topic ARN that the scheduled query status notifications will be sent to. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1054 Amazon Timestream Developer Guide Tag Service: Amazon Timestream Query A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment. Contents Key The key of the tag. Tag keys are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Value The value of the tag. Tag values are case sensitive and can be null. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1055 Amazon Timestream Developer Guide TargetConfiguration Service: Amazon Timestream Query Configuration used for writing the output of a query. Contents TimestreamConfiguration Configuration needed to write data into the Timestream database and table. Type: TimestreamConfiguration object Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1056 Amazon Timestream Developer Guide TargetDestination Service: Amazon Timestream Query Destination details to write data for a target data source. Current supported data source is Timestream. Contents TimestreamDestination Query result destination details for Timestream data source. Type: TimestreamDestination object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1057 Amazon Timestream Developer Guide TimeSeriesDataPoint Service: Amazon Timestream Query The timeseries data type represents the values of a measure over time. A time series is an array of rows of timestamps and measure values, with rows sorted in ascending order of time. A TimeSeriesDataPoint is a single data point in the time series. It represents a tuple of (time, measure value) in a time series. Contents Time The timestamp when the measure value was collected. Type: String Required: Yes Value The measure value for the data point. Type: Datum object Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1058 Amazon Timestream Developer Guide TimestreamConfiguration Service: Amazon Timestream Query Configuration to write data into Timestream database and table. This configuration allows the user to map the query result select columns into the destination table columns. Contents DatabaseName Name of Timestream database to which the query result will be written. Type: String Required: Yes DimensionMappings This is to allow mapping column(s) from the query result to the dimension in the destination table. Type: Array of DimensionMapping objects Required: Yes TableName Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration. Type: String Required: Yes TimeColumn Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP. Type: String Required: Yes MeasureNameColumn Name of the measure column. Data Types 1059 Developer Guide Amazon Timestream Type: String Required: No MixedMeasureMappings Specifies how to map measures to multi-measure records. Type: Array of MixedMeasureMapping objects Array Members: Minimum number of 1 item. Required: No MultiMeasureMappings Multi-measure mappings. Type: MultiMeasureMappings object Required: No See Also For more information
|
timestream-243
|
timestream.pdf
| 243 |
written to. The table should be within the same database that is provided in Timestream configuration. Type: String Required: Yes TimeColumn Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP. Type: String Required: Yes MeasureNameColumn Name of the measure column. Data Types 1059 Developer Guide Amazon Timestream Type: String Required: No MixedMeasureMappings Specifies how to map measures to multi-measure records. Type: Array of MixedMeasureMapping objects Array Members: Minimum number of 1 item. Required: No MultiMeasureMappings Multi-measure mappings. Type: MultiMeasureMappings object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1060 Amazon Timestream Developer Guide TimestreamDestination Service: Amazon Timestream Query Destination for scheduled query. Contents DatabaseName Timestream database name. Type: String Required: No TableName Timestream table name. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Data Types 1061 Amazon Timestream Developer Guide Type Service: Amazon Timestream Query Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, Boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries. Contents ArrayColumnInfo Indicates if the column is an array. Type: ColumnInfo object Required: No RowColumnInfo Indicates if the column is a row. Type: Array of ColumnInfo objects Required: No ScalarType Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types. Type: String Valid Values: VARCHAR | BOOLEAN | BIGINT | DOUBLE | TIMESTAMP | DATE | TIME | INTERVAL_DAY_TO_SECOND | INTERVAL_YEAR_TO_MONTH | UNKNOWN | INTEGER Required: No TimeSeriesMeasureValueColumnInfo Indicates if the column is a timeseries data type. Type: ColumnInfo object Required: No Data Types 1062 Amazon Timestream See Also Developer Guide For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 Common Errors 1063 Developer Guide Amazon Timestream NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Common Parameters 1064 Amazon Timestream Action The action to be performed. Type: string Required: Yes Version Developer Guide The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a
|
timestream-244
|
timestream.pdf
| 244 |
Amazon Timestream Action The action to be performed. Type: string Required: Yes Version Developer Guide The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional Common Parameters 1065 Amazon Timestream X-Amz-Date Developer Guide The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-SignedHeaders Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Common Parameters 1066 Amazon Timestream Developer Guide Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional Document history Change Description Date Amazon Timestream for LiveAnalytics will no longer be open to new customers Amazon Timestream for LiveAnalytics will no longer be open to new customers starting June 20, 2025. starting on 6/20/2025. If May 20, 2025 AmazonTimestreamIn fluxDBFullAccessWi thoutMarketplaceAc cess – New policy you would like to use the service, please sign up prior to 06/20/2025. For capabilities similar to Amazon Timestrea m for LiveAnalytics, explore Amazon Timestream for InfluxDB. This policy grants administr ative permissions that allow full access to all Timestrea m for InfluxDB resources , excluding any marketpla ce-related actions. For more information see AWS managed policies for Amazon Timestream for InfluxDB. April 16, 2025 AmazonTimestreamIn – fluxDBFullAccess Update to an existing policy Amazon Timestream for InfluxDB has added to the existing AmazonTim estreamInfluxDBFul April 16, 2025 Document history 1067 Amazon Timestream Developer Guide AmazonTimestreamIn – fluxDBFullAccess Update to an existing policy Documentation-only update Amazon Timestream now supports query insights lAccess managed policy. For more information, see AWS managed policies for Amazon Timestream for InfluxDB. Amazon Timestream for InfluxDB has added access to create, update, delete, and list Amazon Timestrea m InfluxDB clusters to the existing AmazonTim estreamInfluxDBFul lAccess managed policy. For more information, see AWS managed policies for Amazon Timestream for InfluxDB. Updated the Quotas topic to segregate the default quotas and system limits. Timestream now includes support for the query insights feature that helps you optimize your queries, improve their performance, and reduce costs. February 17, 2025 October 22, 2024 October 22, 2024 Document history 1068 Amazon Timestream Developer Guide Amazon Timestream for InfluxDB update to an existing Amazon Timestream for InfluxDB has added the October 8, 2024 policy. AmazonTimestreamIn – fluxDBFullAccess Update to an existing policy ec2:DescribeRouteT ables action to the existing AmazonTimestreamIn fluxDBFullAccess managed policy for describin g your route tables. For more information, see AWS managed policies for Amazon Timestream for InfluxDB. Amazon Timestream for InfluxDB has added the ec2:DescribeRouteT ables action to the existing AmazonTimestreamIn fluxDBFullAccess managed policy. This action is used for describing your route tables. See AmazonTim estreamInfluxDBFullAccess. September 12, 2024 AmazonTimestreamRe Timestream for LiveAnalytics June 3, 2024 adOnlyAccess to an existing policy – Update has added the DescribeA ccountSettings permission to the AmazonTim estreamReadOnlyAcc ess managed
|
timestream-245
|
timestream.pdf
| 245 |
added the October 8, 2024 policy. AmazonTimestreamIn – fluxDBFullAccess Update to an existing policy ec2:DescribeRouteT ables action to the existing AmazonTimestreamIn fluxDBFullAccess managed policy for describin g your route tables. For more information, see AWS managed policies for Amazon Timestream for InfluxDB. Amazon Timestream for InfluxDB has added the ec2:DescribeRouteT ables action to the existing AmazonTimestreamIn fluxDBFullAccess managed policy. This action is used for describing your route tables. See AmazonTim estreamInfluxDBFullAccess. September 12, 2024 AmazonTimestreamRe Timestream for LiveAnalytics June 3, 2024 adOnlyAccess to an existing policy – Update has added the DescribeA ccountSettings permission to the AmazonTim estreamReadOnlyAcc ess managed policy for describing AWS account settings. Document history 1069 Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics now supports Amazon Timestream for LiveAnalytics now includes Timestream Compute Units support for Timestream April 29, 2024 (TCUs) New policies added March 14, 2024 Compute Units (TCUs) to measure the compute capacity allocated for your query needs. Amazon Timestream for InfluxDB added two new policies: One that allows the service to manage network interfaces and security groups in your account. For more information, see AmazonTim estreamInfluxDBServiceRoleP olicy. Another that provide full administrative access to create, update, delete and list Amazon Timestream InfluxDB instances and create and list parameter groups. For more information, see AmazonTim estreamInfluxDBFullAccess. Amazon Timestream for InfluxDB is now generally available. This documentation covers the initial release of Amazon Timestream for InfluxDB. March 14, 2024 Document history 1070 Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics Query Amazon Timestream for LiveAnalytics now publishes events are available in AWS Query API data events to AWS September 12, 2023 CloudTrail Amazon Timestream for LiveAnalytics UNLOAD CloudTrail. Customers can audit all Query API requests made in their AWS accounts, and see information such as which IAM User/Role made the request, when the request was made, which databases and tables were queried, and the request's Query ID. Amazon Timestream for LiveAnalytics now supports UNLOAD to export query results to S3. May 12, 2023 Amazon Timestream for LiveAnalytics update to an Batch load permissions added to a managed policy. February 24, 2023 existing policy. Amazon Timestream for LiveAnalytics batch load. Amazon Timestream for LiveAnalytics now supports batch load functionality. February 24, 2023 Amazon Timestream for LiveAnalytics now supports AWS Backup. Amazon Timestream for LiveAnalytics now supports AWS Backup. December 14, 2022 Amazon Timestream for LiveAnalytics updates to AWS managed policies New information about AWS managed policies and Amazon Timestream for LiveAnalytics, including updates to existing managed policies. November 29, 2021 Document history 1071 Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics supports Amazon Timestream for LiveAnalytics now supports scheduled queries running a query on your November 29, 2021 Amazon Timestream for LiveAnalytics supports magnetic store. behalf, based on a schedule. Amazon Timestream for LiveAnalytics now supports using magnetic storage for your table writes. November 29, 2021 Amazon Timestream for LiveAnalytics multi-measure Amazon Timestream for LiveAnalytics now supports November 29, 2021 records. a more compact format for storing your time-series data. Amazon Timestream for LiveAnalytics updates to AWS New information about AWS managed policies and May 24, 2021 managed policies Amazon Timestream for LiveAnalytics, including updates to existing managed policies. Amazon Timestream for LiveAnalytics is now available Amazon Timestream for LiveAnalytics is now generally April 23, 2021 in the Europe (Frankfurt) available in the Europe region. (Frankfurt) region (eu- central-1 ). Amazon Timestream for LiveAnalytics now supports VPC endpoints (AWS PrivateLi nk). Amazon Timestream for LiveAnalytics now supports the use of VPC endpoints (AWS PrivateLink). March 23, 2021 Amazon Timestream now supports cross table queries. You can use Amazon Timestream for LiveAnalytics to run cross table queries. February 10, 2021 Document history 1072 Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics now supports Amazon Timestream for LiveAnalytics now supports enhanced query execution enhanced query execution statistics. statistics, such as amount of data scanned. February 10, 2021 Amazon Timestream for LiveAnalytics now supports You can use Amazon Timestream for LiveAnaly advanced time series tics to run SQL queries February 10, 2021 functions. with advanced time series functions, such as derivatives, integrals, and correlations. Amazon Timestream for LiveAnalytics is now HIPAA, You can now use Amazon Timestream for LiveAnalytics ISO, and PCI compliant. for workloads that require January 27, 2021 HIPAA, ISO, and PCI-compl iant infrastructure. Amazon Timestream for LiveAnalytics now supports You can now use Telegraf, the open-source, plugin-dr open-source Telegraf and iven server agent for collectin November 25, 2020 Grafana. g and reporting metrics, and Grafana, the open-sour ce analytics and monitorin g platform for databases, with Amazon Timestream for LiveAnalytics. Amazon Timestream for LiveAnalytics is now generally available. This documentation covers the initial release of Amazon Timestream for LiveAnalytics. September 30, 2020 Document history 1073 Amazon Timestream Developer Guide What is Timestream for InfluxDB? Amazon Timestream for InfluxDB is a managed time series database engine that
|
timestream-246
|
timestream.pdf
| 246 |
2021 HIPAA, ISO, and PCI-compl iant infrastructure. Amazon Timestream for LiveAnalytics now supports You can now use Telegraf, the open-source, plugin-dr open-source Telegraf and iven server agent for collectin November 25, 2020 Grafana. g and reporting metrics, and Grafana, the open-sour ce analytics and monitorin g platform for databases, with Amazon Timestream for LiveAnalytics. Amazon Timestream for LiveAnalytics is now generally available. This documentation covers the initial release of Amazon Timestream for LiveAnalytics. September 30, 2020 Document history 1073 Amazon Timestream Developer Guide What is Timestream for InfluxDB? 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 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. Amazon Timestream for InfluxDB gives you access to the capabilities of the familiar open source version of InfluxDB on its 2.x branch. This means that the code, applications, and tools you already use today with your existing InfluxDB open-source databases should work seamlessly with Amazon Timestream for InfluxDB. Amazon Timestream for InfluxDB can automatically back up your database and keep your database software up to date with the latest version. In addition, Amazon Timestream for InfluxDB makes it easy to use replication to enhance database availability, and improve data durability. As with all AWS services, there are no upfront investments required, and you pay only for the resources you use. DB instances A DB instance is an isolated database environment running in the cloud. It is the basic building block of Amazon Timestream for InfluxDB. A DB instance can contain multiple user-created databases (or organizations and buckets for the case of InfluxDb 2.x databases), and can be accessed using the same client tools and applications you might use to access a standalone self- managed InfluxDB instance. DB instances are simple to create and modify with the AWS command line tools, Amazon Timestream InfluxDB API operations, or the AWS Management Console. Note Amazon Timestream for InfluxDB supports access to databases using the Influx API operations and Influx UI. Amazon Timestream for InfluxDB does not allow direct host access. You can have up to 40 Amazon Timestream for InfluxDB instances. Each DB instance has a DB instance id. This service generated name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands. The DB instance id is unique for that customer in an AWS Region. DB instances 1074 Amazon Timestream Developer Guide The DB instance id forms part of the DNS hostname allocated to your instance by Timestream for InfluxDB. For example, if you specify influxdb1 as the DB instance name and the service generates an instance id c5vasdqn0b then Timestream will automatically allocate a DNS endpoint for your instance. An example endpoint is c5vasdqn0b-3ksj4dla5nfjhi.timestream-influxdb.us- east-1.on.aws, where c5vasdqn0b is your instance id. All instances created before 12/09/2024 will maintain the old structure with an endpoint similar to: influxdb1-3ksj4dla5nfjhi.us- east-1.timestream-influxdb.amazonaws.com where influxdb1 is your instance name. In the example endpoint c5vasdqn0b-3ksj4dla5nfjhi.timestream-influxdb.us- east-1.on.aws, the string 3ksj4dla5nfjhi is a unique account identifier generated by AWS. The identifier 3ksj4dla5nfjhi in the example doesn't change for the specified account in a certain Region. Therefore, all your DB instances created by this account share the same fixed identifier in the Region. Consider the following features of the fixed identifier: • Currently Timestream for InfluxDB does not support DB instance renaming. • For all instances created after 12/09/2024, if you delete and re-create your DB instance with the same DB instance name, the endpoint will change since a new instance id will be assigned to the instance. Instance created before tthe aforementioned date will be assigned the same endpoint based on instance name. • If you use the same account to create a DB instance in a different Region, the internally generated identifier is different because the Region is different, as in zxlasoonhvd.4a3j5du5ks7md2.timestream-influxdb.us-east-1.on.aws. Each DB instance supports only one Timestream for InfluxDB database engine. When creating a DB instance, InfluxDB requires that an organization name be specified. A DB instance can host multiple organizations and multiple buckets associated to each organization. Amazon Timestream for InfluxDB allows you to create a master user account and password for your DB instance as part of the creation process. This master user has permissions to create organizations, buckets, and to perform read, write, delete and upsert operations on your data. You will also be able to access the InfluxUI and retrieve you operator token on. your first log in. From there you will be able to manage all your access tokens as well. You must set the master user password when you create a DB
|
timestream-247
|
timestream.pdf
| 247 |
host multiple organizations and multiple buckets associated to each organization. Amazon Timestream for InfluxDB allows you to create a master user account and password for your DB instance as part of the creation process. This master user has permissions to create organizations, buckets, and to perform read, write, delete and upsert operations on your data. You will also be able to access the InfluxUI and retrieve you operator token on. your first log in. From there you will be able to manage all your access tokens as well. You must set the master user password when you create a DB instance, but you can change it at any time using the Influx API, Influx CLI, or the InfluxUI. DB instances 1075 Amazon Timestream DB instance classes Developer Guide The DB instance class determines the computation and memory capacity of an Amazon Timestream fi UbfkyxDB DB instance. The DB instance class that you need depends on your processing power and memory requirements. A DB instance class consists of both the DB instance class type and the size. For example, db.influx is a memory-optimized DB instance class type suitable for the high performance memory requirements related to running InfluxDb workloads. Within the db.influx instance class type, db.influx.2xlarge is a DB instance class. The size of this class is 2xlarge. For more information about instance class pricing, see Amazon Timestream for InfluxDB pricing. DB instance class types Amazon Timestream for InfluxDB supports DB instance classes for the following use case optimized for InfluxDB use cases. • db.influx—These instance classes are ideal for running memory-intensive workloads in open- source InfluxDB databases Hardware specifications for DB instance classes The following terminology describes the hardware specifications for DB instance classes: • vCPU The number of virtual central processing units (CPUs). A virtual CPU is a unit of capacity that you can use to compare DB instance classes. • Memory (GiB) The RAM, in gibibytes, allocated to the DB instance. There is often a consistent ratio between memory and vCPU. As an example, take the db.influx instance class, which has a memory to vCPU ratio similar to the EC2 r7g instance class. • Influx-Optimized DB instance classes 1076 Amazon Timestream Developer Guide The DB instance uses an optimized configuration stack and provides additional, dedicated capacity for I/O. This optimization provides the best performance by minimizing contention between I/O and other traffic from your instance. • Network bandwidth The network speed relative to other DB instance classes. In the following table, you can find hardware details about the Amazon Timestream for InfluxDB instance classes. Instances Class vCPU Memory (GiB) Storage Type Network bandwidth (Gbps) db.influx .medium db.influx.large db.influx.xlarge 1 2 4 db.influx.2xlarge 8 db.influx.4xlarge 16 db.influx.8xlarge 32 db.influx .12xlarge db.influx .16xlarge 48 64 8 16 32 64 128 256 384 512 Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included 10 10 10 10 10 12 20 25 Hardware specifications 1077 Amazon Timestream Developer Guide InfluxDB instance storage DB instances for Amazon Timestream for InfluxDB use Influx IOPS Included volumes for databases and log storage. In some cases, your database workload might not be able to achieve 100 percent of the IOPS that you have provisioned. For more information, see Factors that affect storage performance. For more information about Timestream for InfluxDB storage pricing, see Amazon Timestream pricing. Amazon Timestream for InfluxDB storage types Amazon Timestream for InfluxDB provides support for one storage type, Influx IOPS Included. You can create Timestream for InfluxDB instances with up to 16 tebibytes (TiB) of storage. Here is a brief description of the available storage type: • Influx IO Included storage: Storage performance is the combination of I/O operations per second (IOPS) and how fast the storage volume can perform reads and writes (storage throughput). On Influx IOPS Included storage volumes, Amazon Timestream for InfluxDB provides 3 storage tiers that come pre configured with optimal IOPS and throughput required for different types of workloads. InfluxDB instance sizing The optimal configuration of a Timestream for InfluxDB instance depends on various factors, including ingestion rate, batch sizes, time series cardinality, concurrent queries, and query types. To provide sizing recommendations, let's consider an exemplary workload with the following characteristics: • Data is collected and written by a fleet of Telegraf agents gathering System, CPU, Memory, Disk, IO, and etc. from a data center. Each write request contains 5000 lines. • The queries executed on the system are categorized as “moderate complexity” queries, exhibiting the following characteristics: • They have multiple functions and one or two regular expressions • They may include group by clauses or sample a time range of multiple weeks. Instance Storage 1078 Amazon Timestream Developer Guide • They typically takes a few hundred milliseconds to a couple
|
timestream-248
|
timestream.pdf
| 248 |
let's consider an exemplary workload with the following characteristics: • Data is collected and written by a fleet of Telegraf agents gathering System, CPU, Memory, Disk, IO, and etc. from a data center. Each write request contains 5000 lines. • The queries executed on the system are categorized as “moderate complexity” queries, exhibiting the following characteristics: • They have multiple functions and one or two regular expressions • They may include group by clauses or sample a time range of multiple weeks. Instance Storage 1078 Amazon Timestream Developer Guide • They typically takes a few hundred milliseconds to a couple of thousand milliseconds to execute. • The CPU favors query performance primarily. Max # of series Writes (lines per second) Reads (Queries per second) Instance class Storage Type <100K ~50,000 <10 db.influx.large <1MM ~150,000 <25 db.influx.2xlarge ~1MM ~200,000 ~25 db.influx.4xlarge <5MM ~250,000 ~35 db.influx.4xlarge <10MM ~500,000 ~50 db.influx.8xlarge ~10MM <750,000 <5100 db.influx .12xlarge Influx IO Included 3K Influx IO Included 3K Influx IO Included 3K Influx IO Included 12K Influx IO Included 12K Influx IO Included 12K AWS Regions and Availability Zones Amazon cloud computing resources are hosted in multiple locations world-wide. These locations are composed of AWS Regions and . Each AWS Region is a separate geographic area. Each AWS Region has multiple, isolated locations known as Availability Zones. Note For information about finding the for an AWS Region, see Regions and Zones in the Amazon EC2 User Guide. Regions and Availability Zones 1079 Amazon Timestream Developer Guide Amazon Timestream for InfluxDB enables you to place resources, such as DB instances, and data in multiple locations. Amazon operates state-of-the-art, highly-available data centers. Although rare, failures can occur that affect the availability of DB instances that are in the same location. If you host all your DB instances in one location that is affected by such a failure, none of your DB instances will be available. It is important to remember that each AWS Region is completely independent. Any Amazon Timestream for InfluxDB activity you initiate (for example, creating database instances or listing available database instances) runs only in your current default AWS Region. The default AWS Region can be changed in the console, or by setting the AWS_DEFAULT_REGION environment variable. Or it can be overridden by using the --region parameter with the AWS Command Line Interface (AWS CLI). For more information, see Configuring the AWS Command Line Interface, specifically the sections about environment variables and command line options. To create or work with an Amazon Timestream for InfluxDB DB instance in a specific AWS Region, use the corresponding regional service endpoint. Regions and Availability Zones 1080 Amazon Timestream Developer Guide AWS Region availability The following table shows the AWS Regions where Amazon Timestream for InfluxDB is currently available and the endpoint for each Region. AWS Region name Region Endpoint Protocol US East (N. Virginia) us-east-1 US East (Ohio) us-east-2 US West (Oregon) us-west-2 Asia Pacific (Mumbai) ap-south-1 Asia Pacific (Singapor e) ap-southeast-1 Asia Pacific (Sydney) ap-southeast-2 Asia Pacific (Tokyo) ap-northeast-1 Europe (Frankfurt) eu-central-1 timestream-influxd b.us-east-1.amazon HTTPS aws.com timestream-influxd b.us-east-2.amazon HTTPS aws.com timestream-influxd b.us-west-2.amazon HTTPS aws.com timestream-influxd b.ap-south-1.amazo HTTPS naws.com timestream-influxd b.ap-southeast-1.a mazonaws.com timestream-influxd b.ap-southeast-2.a mazonaws.com timestream-influxd b.ap-northeast-1.a mazonaws.com timestream-influxd b.eu-central-1.ama zonaws.com HTTPS HTTPS HTTPS HTTPS Regions availability 1081 Amazon Timestream Developer Guide AWS Region name Region Endpoint Protocol Europe (Ireland) eu-west-1 Europe (Stockholm) eu-north-1 Canada (Central) ca-central-1 Europe (London) eu-west-2 Europe (Paris) eu-west-3 Asia Pacific (Jakarta) ap-southeast-3 Europe (Milan) eu-south-1 Europe (Spain) eu-south-2 Middle East (UAE) me-central-1 timestream-influxd b.eu-west-1.amazon HTTPS aws.com timestream-influxd b.eu-north-1.amazo HTTPS naws.com timestream-influxd b.ca-central-1.ama zonaws.com HTTPS timestream-influxd b.eu-west-2.amazon HTTPS aws.com timestream-influxd b.eu-west-3.amazon HTTPS aws.com timestream-influxd b.ap-southeast-3.a mazonaws.com HTTPS timestream-influxd b.eu-south-1.amazo HTTPS naws.com timestream-influxd b.eu-south-2.amazo naws.com timestream-influxd b.me-central-1.ama zonaws.com HTTPS HTTPS Regions availability 1082 Amazon Timestream Developer Guide AWS Region name Region Endpoint Protocol China (Beijing) cn-north-1 China (Ningxia) cn-northwest-1 HTTPS HTTPS timestream-influxd b.cn-north-1.on.am azonwebservices.co m.cn timestream-influxd b.cn-northwest-1.o n.amazonwebservice s.com.cn For more information on AWS Regions where Amazon Timestream for InfluxDB is currently available and the endpoint for each Region, see Amazon Timestream endpoints and quotas. AWS Regions design Each AWS Region is designed to be isolated from the other AWS Regions. This design achieves the greatest possible fault tolerance and stability. When you view your resources, you see only the resources that are tied to the AWS Region that you specified. This is because AWS Regions are isolated from each other, and we don't automatically replicate resources across AWS Regions. AWS Availability Zones When you create a DB instance, Amazon Timestream for InfluxDB choose one for you randomly based on your subnet configuration. An Availability Zone is represented by an AWS Region code followed by a letter identifier (for example, us-east-1a). Use the describe-availability-zones Amazon EC2 command as follows to describe the within the specified Region that are enabled for your account. aws ec2 describe-availability-zones --region
|
timestream-249
|
timestream.pdf
| 249 |
you see only the resources that are tied to the AWS Region that you specified. This is because AWS Regions are isolated from each other, and we don't automatically replicate resources across AWS Regions. AWS Availability Zones When you create a DB instance, Amazon Timestream for InfluxDB choose one for you randomly based on your subnet configuration. An Availability Zone is represented by an AWS Region code followed by a letter identifier (for example, us-east-1a). Use the describe-availability-zones Amazon EC2 command as follows to describe the within the specified Region that are enabled for your account. aws ec2 describe-availability-zones --region region-name For example, to describe the within the US East (N. Virginia) Region (us-east-1) that are enabled for your account, run the following command: Regions design 1083 Amazon Timestream Developer Guide aws ec2 describe-availability-zones --region us-east-1 You can't choose the for the primary and secondary DB instances in a Multi-AZ DB deployment. Amazon Timestream for InfluxDB chooses them for you randomly. For more information about Multi-AZ deployments, see Configuring and managing a multi-AZ deployment. DB Instance billing for Amazon Timestream for InfluxDB Amazon Timestream for InfluxDB instances are billed based on the following components: • DB instance hours (per hour) — Based on the DB instance class of the DB instance, for example, db.influx.large. Pricing is listed on a per-hour basis, but bills are calculated down to the second and show times in decimal form. Amazon Timestream for InfluxDB usage is billed in 1-second increments, with a minimum of 10 minutes. For more information, see DB instance classesDB instance classes. • Storage (per GiB per month) — Storage capacity that you have provisioned to your DB instance. For more information, see InfluxDB instance storage. • Data transfer (per GB) — Data transfer in and out of your DB instance from or to the internet and other AWS Regions. For Amazon Timestream for InfluxDB pricing information, see the Amazon Timestream for InfluxDB pricing page. Setting up Amazon Timestream for InfluxDB Before you use Amazon Timestream for InfluxDB for the first time, complete the following tasks: If you already have an AWS account, know your Amazon Timestream for InfluxDB requirements, and prefer to use the defaults for IAM and Amazon VPC Getting started with Timestream for InfluxDB. Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account • Go to the AWS sign in page. Billing 1084 Amazon Timestream Developer Guide • Choose Create a new accountand the follow the instructions. Note Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to an administrative user, and use only the root user to perform tasks that require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. User management Create an administrative user Create an administrative user After you sign up for an AWS account, create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Grant programmatic access Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. Setting up 1085 Amazon Timestream Developer Guide To grant users programmatic access, choose one of the following options: Which user needs programmatic access? To By Workforce identity(Users managed in IAM Identity Use temporary credentials to sign programmatic requests Following the instructions for the interface that you want to Center) to the AWS CLI, AWS SDKs, or use. AWS APIs. For the AWS CLI, see Configuri ng IAM Identity Center authentication with the AWS CLI in the AWS Command Line Interface User Guide. For AWS SDKs, tools, and AWS APIs, see Using IAM Identity Center to authentic ate AWS SDK and tools in the AWS SDKs and Tools Reference Guide. IAM IAM
|
timestream-250
|
timestream.pdf
| 250 |
access, choose one of the following options: Which user needs programmatic access? To By Workforce identity(Users managed in IAM Identity Use temporary credentials to sign programmatic requests Following the instructions for the interface that you want to Center) to the AWS CLI, AWS SDKs, or use. AWS APIs. For the AWS CLI, see Configuri ng IAM Identity Center authentication with the AWS CLI in the AWS Command Line Interface User Guide. For AWS SDKs, tools, and AWS APIs, see Using IAM Identity Center to authentic ate AWS SDK and tools in the AWS SDKs and Tools Reference Guide. IAM IAM Use temporary credentials to sign programmatic requests Following the instructions in Use temporary credentia to the AWS CLI, SDKs, and ls with AWS resources in APIs. (Not recommended) Use long-term credentials to sign programmatic requests to the AWS CLI, SDKs, and APIs. the AWS Identity and Access Management User Guide. Following the instructions for the interface that you want to use. For the AWS CLI, see Authenticating using IAM user credentials for the AWS CLI in the AWS Command Line Interface User Guide. Setting up 1086 Amazon Timestream Developer Guide Which user needs programmatic access? To By For AWS SDKs and tools, see Using long-term credentia ls to authenticate AWS SDKs and tools in the AWS SDKs and Tools Reference Guide. For AWS APIs, see Managing access keys for IAM users in the AWS Identity and Access Management User Guide. Determine requirements The basic building block of Amazon Timestream for InfluxDB is the DB instance. In a DB instance, you create your buckets. A DB instance provides a network address called an endpoint. Your applications use this endpoint to connect to your DB instance. You will also access your InfluxUI using this same endpoint from your browser. When you create a DB instance, you specify details like storage, memory, database engine and version, network configuration, and security. You control network access to a DB instance through a security group. Before you create a DB instance and a security group, you must know your DB instance and network needs. Here are some important things to consider: • Resource requirements — What are the memory and processor requirements for your application or service? You use these settings to help you determine what DB instance class to use. For specifications about DB instance classes, see DB instance classes. • VPC and security group — Your DB instance will most likely be in a virtual private cloud (VPC). To connect to your DB instance, you need to set up security group rules. These rules are set up differently depending on what kind of VPC you use and how you use it. For example, you can use: a default VPC or a user-defined VPC. The following list describes the rules for each VPC option: • Default VPC — If your AWS account has a default VPC in the current AWS Region, that VPC is configured to support DB instances. If you specify the default VPC when you create the Determine requirements 1087 Amazon Timestream Developer Guide DB instance, make sure to create a VPC security group that authorizes connections from the application or service to the Amazon Timestream for InfluxDB DB instance. Use the Security Group option on the VPC console or the AWS CLI to create VPC security groups. For more information, see Step 3: Create a VPC security group. • User-defined VPC — If you want to specify a user-defined VPC when you create a DB instance, be aware of the following: • Make sure to create a VPC security group that authorizes connections from the application or service to the Amazon Timestream for InfluxDB DB instance. Use the Security Group option on the VPC console or the AWS CLI to create VPC security groups. For information, see Step 3: Create a VPC security group. • The VPC must meet certain requirements in order to host DB instances, such as having at least two subnets, each in a separate Availability Zone. For information, see Amazon VPC and Amazon Timestream for InfluxDB. • High availability — Do you need failover support? On Amazon Timestream for InfluxDB, a Multi- AZ deployment creates a primary DB instance and a secondary standby DB instance in another Availability Zone for failover support. We recommend Multi-AZ deployments for production workloads to maintain high availability. For development and test purposes, you can use a deployment that isn't Multi-AZ. For more information, see Multi-AZ DB instance deployments. • IAM policies — Does your AWS account have policies that grant the permissions needed to perform Amazon Timestream for InfluxDB operations? If you are connecting to AWS using IAM credentials, your IAM account must have IAM policies that grant the permissions required to perform Amazon Timestream for InfluxDB control plane operations. For more
|
timestream-251
|
timestream.pdf
| 251 |
instance and a secondary standby DB instance in another Availability Zone for failover support. We recommend Multi-AZ deployments for production workloads to maintain high availability. For development and test purposes, you can use a deployment that isn't Multi-AZ. For more information, see Multi-AZ DB instance deployments. • IAM policies — Does your AWS account have policies that grant the permissions needed to perform Amazon Timestream for InfluxDB operations? If you are connecting to AWS using IAM credentials, your IAM account must have IAM policies that grant the permissions required to perform Amazon Timestream for InfluxDB control plane operations. For more information, see Identity and Access Management for Amazon Timestream for InfluxDB. • Open ports — What TCP/IP port does your database listen on? The firewalls at some companies might block connections to the default port for your database engine. The default for Timestream for InfluxDB is 8086. • AWS Region — What AWS Region do you want your database in? Having your database in close proximity to your application or web service can reduce network latency. For more information, see AWS Regions and Availability Zones . • DB disk subsystem — What are your storage requirements? Amazon Timestream for InfluxDB provides provides three configurations for it Influx IOPS Included storage type:: • Influx Io Included 3k IOPS (SSD) • Influx Io Included 12k IOPS (SSD) • Influx Io Included 16k IOPS (SSD) Determine requirements 1088 Amazon Timestream Developer Guide For more information on Amazon Timestream for InfluxDB storage, see Amazon Timestream for InfluxDB DB instance storage. When you have the information you need to create the security group and the DB instance, continue to the next step. Provide access to your DB instance in your VPC by creating a security group VPC security groups provide access to DB instances in a VPC. They act as a firewall for the associated DB instance, controlling both inbound and outbound traffic at the DB instance level. DB instances are created by default with a firewall and a default security group that protect the DB instance. Before you can connect to your DB instance, you must add rules to a security group that enable you to connect. Use your network and configuration information to create rules to allow access to your DB instance. For example, suppose that you have an application that accesses a database on your DB instance in a VPC. In this case, you must add a custom TCP rule that specifies the port range and IP addresses that your application uses to access the database. If you have an application on an Amazon EC2 instance, you can use the security group that you set up for the Amazon EC2 instance. Creating a security group for VPC access To create a VPC security group, sign in to the AWS Management Console and choose VPC. Note Make sure you are in the VPC console, not the Amazon Timesteam for InfluxDB console. • In the upper-right corner of the AWS Management Console, choose the AWS Region where you want to create your VPC security group and DB instance. In the list of Amazon VPC resources for that AWS Region, you should see at least one VPC and several subnets. If you don't, you don't have a default VPC in that AWS Region.. • In the navigation pane, choose Security Groups. • Choose Create security group. VPC access 1089 Amazon Timestream Developer Guide • Inn the Basic details section of the security group page, enter the Security group name and Description. For VPC, choose the VPC thatyou want to create your DB instance in. • In Inbound rules, choose Add rule. • For Type, choose Custom TCP. • For Source, choose a Security group name or enter the IP address range (CIDR value) from where you access the DB instance. If you choose My IP, this allows access to the DB instance from the IP address detected in your browser. For Source, choose a security group name or type the IP address range (CIDR value) from where you access the DB instance. If you choose My IP, this allows access to the DB instance from the IP address detected in your browser. • (Optional) In Outbound rules, add rules for outbound traffic. By default, all outbound traffic is allowed. • Choose Create security group. You can use this VPC security group as the security group for your DB instance when you create it. Note If you use a default VPC, a default subnet group spanning all of the VPC's subnets is created for you. When you create a DB instance, you can choose the default eiifccntf VPC and choose default for DB Subnet Group. After you have completed the setup requirements, you can create a DB instance using your requirements and security group. To do
|
timestream-252
|
timestream.pdf
| 252 |
Outbound rules, add rules for outbound traffic. By default, all outbound traffic is allowed. • Choose Create security group. You can use this VPC security group as the security group for your DB instance when you create it. Note If you use a default VPC, a default subnet group spanning all of the VPC's subnets is created for you. When you create a DB instance, you can choose the default eiifccntf VPC and choose default for DB Subnet Group. After you have completed the setup requirements, you can create a DB instance using your requirements and security group. To do so, follow the instructions in Creating a DB instance. Getting started with Timestream for InfluxDB In the following examples, you can find out how to create and connect to a DB instance using Amazon Timestream for InfluxDB Service. Note Before you can create or connect to a DB instance, make sure to complete the tasks in Setting up Amazon Timestream for InfluxDB. Getting started 1090 Amazon Timestream Topics • Creating and connecting to a Timestream for InfluxDB instance • Creating a new operator token for your InfluxDB instance Developer Guide Creating and connecting to a Timestream for InfluxDB instance This tutorial creates an Amazon EC2 instance and an Amazon Timestream for InfluxDB DB instance. The tutorial shows you how to write data to the DB instance from the EC2 instance using the Telegraf client. As a best practice, this tutorial creates a private DB instance in a virtual private cloud (VPC). In most cases, other resources in the same VPC, such as EC2 instances, can access the DB instance, but resources outside of the VPC can't access it. After you complete the tutorial, there will be a public and private subnet in each Availability Zone in your VPC. In one Availability Zone, the EC2 instance will be in the public subnet, and the DB instance will be in the private subnet. Note There's no charge for creating an AWS account. However, by completing this tutorial, you might incur costs for the AWS resources you use. You can delete these resources after you complete the tutorial if they are no longer needed. The following diagram shows the configuration when accessibility is public. Creating and connecting to a Timestream for InfluxDB instance 1091 Amazon Timestream Developer Guide Warning We don't recommend using 0.0.0.0/0 for HTTP access, since you would make it possible for all IP addresses to access your public InfluxDB instance via HTTP. This approach is not acceptable even for a short time in a test environment. Authorize only a specific IP address or range of addresses to access your InfluxDB instances using HTTP for web UI or API access. Creating and connecting to a Timestream for InfluxDB instance 1092 Amazon Timestream Developer Guide This tutorial creates a DB instance running InfluxDB with the AWS Management Console. We will focus only on the DB instance size and DB instance identifier. We will use the default settings for the other configuration options. The DB instance created by this example will be private. Other settings that you could configure include availability, security, and logging. To create a public DB instance, you must choose to make your instance Publicly accessible on the Connectivity configuration section. For information about creating DB instances, see Creating a DB instance. If your instance is not publicly accessible, do the following: • Create a host on the VPC of the instance through which you can tunnel traffic. • Set up SSH tunneling to the instance. For more information, see Amazon EC2 instance port forwarding with AWS Systems Manager. • In order for the certificate to work, add the following line to the /etc/hosts file of your client machine: 127.0.0.1. This is the DNS address of your instance. • Connect to your instance using the fully qualified domain name, for example, https:// <DNS>:8086. Note Localhost is unable to validate the certificate because localhost is not part of the certificate SAN. The following diagram shows the configuration when accessibility is private: Creating and connecting to a Timestream for InfluxDB instance 1093 Amazon Timestream Developer Guide Prerequisites Before you begin, complete the steps in the following sections: • Sign up for an AWS account. • Create an administrative user. Step 1: Create an Amazon EC2 instance Create an Amazon EC2 instance that you will use to connect to your database. 1. Sign in to the AWS Management Console and open the Amazon EC2 console at https:// console.aws.amazon.com/ec2/. 2. In the upper-right corner of the AWS Management Console, choose the AWS Region in which you want to create the EC2 instance. 3. Choose EC2 Dashboard, and then choose Launch instance. 4. When the Launch an instance page opens, choose the following settings: Creating and connecting to a Timestream for InfluxDB instance 1094 Amazon
|
timestream-253
|
timestream.pdf
| 253 |
AWS account. • Create an administrative user. Step 1: Create an Amazon EC2 instance Create an Amazon EC2 instance that you will use to connect to your database. 1. Sign in to the AWS Management Console and open the Amazon EC2 console at https:// console.aws.amazon.com/ec2/. 2. In the upper-right corner of the AWS Management Console, choose the AWS Region in which you want to create the EC2 instance. 3. Choose EC2 Dashboard, and then choose Launch instance. 4. When the Launch an instance page opens, choose the following settings: Creating and connecting to a Timestream for InfluxDB instance 1094 Amazon Timestream Developer Guide a. Under Name and tags, enter ec2-database-connect for Name. b. Under Application and OS Images (Amazon Machine Image), choose Amazon Linux, and then select Amazon Linux 2023 AMI. Keep the default selections for the other choices. c. Under Instance type, choose t2.micro. d. Under Key pair (login), choose a Key pair name to use an existing key pair. To create a new key pair for the Amazon EC2 instance, choose Create new key pair and then use the Create key pair window to create it. For more information about creating a new key pair, see Create a key pair for your Amazon EC2 instance in the Amazon Elastic Compute Cloud User Guide. e. For Allow SSH traffic from in Network settings, choose the source of SSH connections to the EC2 instance. You can choose My IP if the displayed IP address is correct for SSH connections. Otherwise, you can determine the IP address to use to connect to EC2 instances in your VPC using Secure Shell (SSH). To determine your public IP address, in a different browser window or tab, you can use the service at checkip.amazonaws.com/. An example of an IP address is 192.0.2.1/32. In many cases, you might connect through an internet service provider (ISP) or from behind your firewall without a static IP address. If so, make sure to determine the range of IP addresses used by client computers. Warning We do not recommend using 0.0.0.0/0 for SSH access, since you would make it possible for all IP addresses to access your public EC2 instances using SSH. This approach is not acceptable even for a short time in a test environment. Authorize only a specific IP address or range of addresses to access your EC2 instances using SSH. Step 2: Create an InfluxDB DB instance The basic building block of Amazon Timestream for InfluxDB is the DB instance. This environment is where you run your InfluxDB databases. In this example, you will create a DB instance running the InfluxDB database engine with a db.influx.large DB instance class. Creating and connecting to a Timestream for InfluxDB instance 1095 Amazon Timestream Developer Guide 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console at https://console.aws.amazon.com/timestream/. 2. In the upper-right corner of the Amazon Timestream for InfluxDB console, choose the AWS Region in which you want to create the DB instance. 3. In the navigation pane, choose InfluxDB Databases. 4. Choose Create InfluxDB database. 5. In the Deployment settings section, select Cluster with read replicas. Choose View subscription options to start a subscription for the read replica add-on. For more information, see Read replica licensing through AWS Marketplace. 6. In the Database credentials section, enter KronosTest-1 for DB cluster name. 7. Provide the InfluxDB basic configuration parameters: Initial username, Initial organization name, Initial bucket name and Password. Important You won't be able to view the user password again. You won't be able to access your instance and obtain an operator token without your password. If you don't record it, you might have to change it. See Creating a new operator token for your InfluxDB instance. If you need to change the user password after the DB instance is available, you can modify the DB instance to do so. For more information about modifying a DB instance, see Updating DB instances. Creating and connecting to a Timestream for InfluxDB instance 1096 Amazon Timestream Developer Guide 8. 9. 10. In the Instance configuration section, select the db.influx.large DB instance class. In the Storage configuration section, select Influx IO Included (3K) for Storage type. In the Connectivity configuration section, select IPv4 for the Network type. Make sure your InfluxDB instance is in the same subnet as your newly created EC2 instance. Under Public access, select Not publicly accessible to make your DB instance private. Creating and connecting to a Timestream for InfluxDB instance 1097 Amazon Timestream Developer Guide 11. In the Failover settings and Parameter group settings sections, keep the default values. 12. Configure your logs in Log delivery settings and create tags (optional). For more information about logs, see Setup to view InfluxDB logs on Timestream Influxdb Instances. For more details about adding
|
timestream-254
|
timestream.pdf
| 254 |
In the Connectivity configuration section, select IPv4 for the Network type. Make sure your InfluxDB instance is in the same subnet as your newly created EC2 instance. Under Public access, select Not publicly accessible to make your DB instance private. Creating and connecting to a Timestream for InfluxDB instance 1097 Amazon Timestream Developer Guide 11. In the Failover settings and Parameter group settings sections, keep the default values. 12. Configure your logs in Log delivery settings and create tags (optional). For more information about logs, see Setup to view InfluxDB logs on Timestream Influxdb Instances. For more details about adding tags, see Adding tags and labels to resources. 13. Choose Create InfluxDB database. 14. In the Databases list, chose the name of your new InfluxDB instance to show its details. The DB instance has a status of Creating until it is ready to use. Creating and connecting to a Timestream for InfluxDB instance 1098 Amazon Timestream Developer Guide You can connect to the DB instance when the status changes to Available. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available. Important At this time, you can't modify compute (instance types) and storage (storage types) configurations of existing instances. Step 3: Access the InfluxDB UI To access the InfluxDB UI from a private Timestream for InfluxDB DB instance, you must connect from within the same subnet and security group. One way to facilitate this connection is to create a bastion host within the private subnet. A bastion host is a special-purpose server that acts as a secure entry point to critical systems, protecting your network from external access. It serves as a gateway between your secure internal network and the outside world. Note For publicly accessible Timestream for InfluxDB DB instances, you can access the InfluxDB UI via the InfluxDB UI button on the instance details page in the console. Note that this button will be disabled for instances that are not publicly accessible. If you have a public DB instance, connect to the InfluxDB UI via the console and proceed to Step 4: Send Telegraf data to your InfluxDB instance. Follow these steps to create and configure your bastion host: Creating and connecting to a Timestream for InfluxDB instance 1099 Amazon Timestream Developer Guide 1. Create a bastion host: To create a bastion host, you can launch a new EC2 instance or use an existing one. Ensure that the instance has the necessary network setup to access the security group you used to create the private Timestream for InfluxDB instance you are trying to access. 2. Connect to the InfluxDB UI: Once you have created a bastion host, you can use the endpoint displayed in the console to connect to the InfluxDB UI. The endpoint will be in the format <db-identifier>-<*>.timestream- influxdb.<region>.on.aws. In China, it will be <db-identifier>-<*>.timestream- influxdb.<region>.on.amazonwebservices.com.cn. 3. Configure your bastion host for local forwarding: To set up local forwarding, use the AWS Systems Manager (SSM) session manager. Run the following command, replacing bastion- ec2-instance-id with the ID of your bastion host instance, endpoint with the endpoint displayed in the above console, and port-number with the port number you want to use: aws ssm start-session --target bastion-ec2-instance-id \ --document-name AWS-StartPortForwardingSessionToRemoteHost \ --parameters '{"host":["endpoint"], "portNumber":["port-number"], "localPortNumber":["port-number"]}' You may be prompted to install the SessionManagerPlugin. For more details, see Install the Session Manager plugin for the AWS CLI. 4. Access the InfluxDB UI: After completing the above steps, you can access the InfluxDB UI at http://localhost:port-number. You will need to acknowledge the "not secure" message. 5. Enable domain name validation: To enable domain name validation, add the following line to your /etc/hosts file (Linux), /private/etc/hosts (Mac), or C:\Windows \System32\drivers\etc (Windows). 127.0.0.1 endpoint 6. You can now access the InfluxDB UI using https://endpoint:port-number. Step 4: Send Telegraf data to your InfluxDB instance You can now start sending telemetry data to your InfluxDB DB instance using the Telegraf agent. In this example, you'll install and configure a Telegraf agent to send performance metrics to you InfluxDB DB instance. Creating and connecting to a Timestream for InfluxDB instance 1100 Amazon Timestream Developer Guide 1. After you connect to the InfluxDB UI, you should see a new browser window with a login prompt. Enter the credentials you used earlier to create your InfluxDB DB instance. 2. 3. In the left navigation pane, click on the arrow icon and select API Tokens. For this test, choose Generate API Token. Select All Access API Token from the dropdown list. Note For production scenarios, we recommend creating tokens with specific access to the required buckets that are built for specific Telegraf needs. 4. Your token will appear on the screen. Important Make sure to copy and save the token since it will
|
timestream-255
|
timestream.pdf
| 255 |
the InfluxDB UI, you should see a new browser window with a login prompt. Enter the credentials you used earlier to create your InfluxDB DB instance. 2. 3. In the left navigation pane, click on the arrow icon and select API Tokens. For this test, choose Generate API Token. Select All Access API Token from the dropdown list. Note For production scenarios, we recommend creating tokens with specific access to the required buckets that are built for specific Telegraf needs. 4. Your token will appear on the screen. Important Make sure to copy and save the token since it will not be displayed again. 5. Connect to the EC2 instance that you created earlier by following the steps in Connect to your Linux instance using SSH in the Amazon Elastic Compute Cloud User Guide. Creating and connecting to a Timestream for InfluxDB instance 1101 Amazon Timestream Developer Guide We recommend that you connect to your EC2 instance using SSH. If the SSH client utility is installed on Windows, Linux, or Mac, you can connect to the instance using the following command format: ssh -i location_of_pem_file ec2-user@ec2-instance-public-dns-name For example, assume that ec2-database-connect-key-pair.pem is stored in /dir1 on Linux, and the public IPv4 DNS for your EC2 instance is ec2-12-345-678-90.compute-1.amazonaws.com. Your SSH command would look as follows: ssh -i /dir1/ec2-database-connect-key-pair.pem ec2- [email protected] 6. Get the latest version of Telegraf installed on your instance. To do this, use the following command: cat <<EOF | sudo tee /etc/yum.repos.d/influxdata.repo [influxdata] name = InfluxData Repository - Stable baseurl = https://repos.influxdata.com/stable/\$basearch/main enabled = 1 gpgcheck = 1 gpgkey = https://repos.influxdata.com/influxdata-archive_compat.key EOF sudo yum install telegraf 7. Configure your Telegraf instance. Note If telegraf.conf does not exist or it does not contain a timestream section, you can generate one with: telegraf —section-filter agent:inputs:outputs —input-filter cpu:mem —output- filter timestream config > telegraf.conf Creating and connecting to a Timestream for InfluxDB instance 1102 Amazon Timestream Developer Guide a. Edit the configuration file usually located at /etc/telegraf. sudo nano /etc/telegraf/telegraf.conf b. Configure the input plugins for CPUs, memory metrics, and disk usage. [[inputs.cpu]] percpu = true totalcpu = true collect_cpu_time = false report_active = false [[inputs.mem]] [[inputs.disk]] ignore_fs = ["tmpfs", "devtmpfs", "devfs"] c. Configure the output plugin to send data to your InfluxDB DB instance and save your changes. [[outputs.influxdb_v2]] urls = ["https://us-west-2-1.aws.cloud2.influxdata.com"] token = "<your_telegraf_token" organization = "your_org" bucket = "your_bucket" timeout = "5s" d. Configure the Timestream target. # Configuration for sending metrics to Amazon Timestream. [[outputs.timestream]] ## Amazon Region and credentials region = "us-east-1" access_key = "<AWS key here>" secret_key = "<AWS secret key here>" database_name = "<timestream database name>" # needs to exist ## Specifies if the plugin should describe on start. describe_database_on_start = false mapping_mode = "multi-table" # allows multiple tables for each input metrics Creating and connecting to a Timestream for InfluxDB instance 1103 Amazon Timestream Developer Guide create_table_if_not_exists = true create_table_magnetic_store_retention_period_in_days = 365 create_table_memory_store_retention_period_in_hours = 24 use_multi_measure_records = true # Important to use multi-measure records measure_name_for_multi_measure_records = "telegraf_measure" max_write_go_routines = 25 8. Enable and start the Telegraf service. $ sudo systemctl enable telegraf $ sudo systemctl start telegraf Step 5: Delete the Amazon EC2 instance and the InfluxDB DB instance After you explore the Telegraf-generated data using your your InfluxDB DB instance with the InfluxDB UI, delete both your EC2 and your InfluxDB DB instances so you are no longer charged for them. To delete the EC2 instance: 1. Sign in to the AWS Management Console and open the Amazon EC2 console at https:// 2. 3. console.aws.amazon.com/ec2/. In the navigation pane, choose Instances. Select the checkbox next to the EC2 instance's name, and then select Instance state. Choose Terminate (delete) instance. 4. Choose Terminate (delete) when prompted for confirmation. For more information about deleting an EC2 instance, see Terminate Amazon EC2 instances in the Amazon Elastic Compute Cloud User Guide. To delete the DB instance with no final DB snapshot: 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console at https://console.aws.amazon.com/timestream/. 2. 3. In the navigation pane, choose InfluxDB databases. Select the DB instance you want to delete. Choose Delete Creating and connecting to a Timestream for InfluxDB instance 1104 Amazon Timestream Developer Guide 4. Confirm the deletion and choose Delete. Creating a new operator token for your InfluxDB instance If you need to get the Operator Token for your new InfluxDB instance, perform the following steps: 1. To change your operator token, we recommend using the Influx CLI. For instructions, please see: Install and use the Influx CLI. 2. Configure your CLI to use --username-password to be able to create the operator: influx config create --config-name CONFIG_NAME1 --host-url "https:// yourinstanceid.eu-central-1.timestream-influxdb.amazonaws.com:8086" --org [YOURORG] --username-password [YOURUSERNAME] --active 3. Create your new operator token. You will be asked for your password to confirm this step. influx auth create --org
|
timestream-256
|
timestream.pdf
| 256 |
deletion and choose Delete. Creating a new operator token for your InfluxDB instance If you need to get the Operator Token for your new InfluxDB instance, perform the following steps: 1. To change your operator token, we recommend using the Influx CLI. For instructions, please see: Install and use the Influx CLI. 2. Configure your CLI to use --username-password to be able to create the operator: influx config create --config-name CONFIG_NAME1 --host-url "https:// yourinstanceid.eu-central-1.timestream-influxdb.amazonaws.com:8086" --org [YOURORG] --username-password [YOURUSERNAME] --active 3. Create your new operator token. You will be asked for your password to confirm this step. influx auth create --org [YOURORG] --operator Important Once a new operator token has been created, you will need to update any client that is currently using the old one. Migrating data from self-managed InfluxDB to Timestream for InfluxDB The Influx migration script is a Python script that migrates data between InfluxDB OSS instances, whether those instances are managed by AWS or not. InfluxDB is a time series database. InfluxDB contains points, which contain a number of key-value pairs and a timestamp. When points are grouped by key-value pairs, they form a series. A series is grouped by a string identifier called a measurement. InfluxDB is often used for operations monitoring, IOT data, and analytics. A bucket is a kind of container within InfluxDB to store data. AWS-managed InfluxDB is InfluxDB within the AWS ecosystem. InfluxDB provides the InfluxDB v2 API for accessing data and making changes to the database. The InfluxDB v2 API is what the Influx migration script uses to migrate data. Creating a new operator token for your InfluxDB instance 1105 Amazon Timestream Developer Guide • The Influx migration script can migrate buckets and their metadata, migrate all buckets from all organizations, or do a full migration, which replaces all data on the destination instance. • The script backups data from the source instance locally, on whatever system executes the script, then restores the data to the destination instance. The data is kept in code>influxdb-backup- <timestamp></timestamp> directories, one for each migration. • The script provides a number of options and configurations including mounting S3 buckets to limit local storage usage during migration and choosing which organizations to use during migration. Topics • Preparation • How to use scripts • Migration Overview Preparation Data migration for InfluxDB is accomplished with a Python script that utilizes InfluxDB CLI features and the InfluxDB v2 API. Execution of the migration script requires the following environment configuration: • Supported Versions: A minimum version of 2.3 of InfluxDB and Influx CLI is supported. • Token Environment Variables • Create the environment variable INFLUX_SRC_TOKEN containing the token for your source InfluxDB instance. • Create the environment variable INFLUX_DEST_TOKEN containing the token for your destination InfluxDB instance. • Python 3 • Check installation: python3 --version. • If not installed, install from the Python website. Minimum version 3.7 required. On Windows the default Python 3 alias is simply python. • The Python module requests is required. Install it with: shell python3 -m pip install requests • TThe Python module influxdb_client is required. Install it with: shell python3 -m pip install influxdb_client Preparation 1106 Amazon Timestream • InfluxDB CLI Developer Guide • Confirm installation: influx version. • If not installed, follow the installation guide in the InfluxDB documentation. Add influx to your $PATH. • S3 Mounting Tools (Optional) When S3 mounting is used, all backup files are stored in a user-defined S3 bucket. S3 mounting can be useful to save space on the executing machine or when backup files need to be shared. If S3 mounting isn't used, by omitting the --s3-bucket option, then a local influxdb- backup-<millisecond timestamp> directory will be created to store backup files in the same directory that the script was run. For Linux: mountpoint-s3. For Windows: rclone (Prior rclone configuration is needed). • Disk Space • The migration process automatically creates unique directories to store sets of backup files and retains these backup directories in either S3 or on the local filesystem, depending on the program arguments provided. • Ensure there is enough disk space for database backup, ideally double the size of the existing InfluxDB database if you choose to omit the --s3-bucket option and use local storage for backup and restoration. • Check space with df -h (UNIX/Linux) or by checking drive properties on Windows. • Direct Connection Ensure a direct network connection exists between the system running the migration script and the source and destination systems. influx ping --host <host> is one way to verify a direct connection. How to use scripts A simple example of running the script is the command: python3 influx_migration.py --src-host <source host> --src-bucket <source bucket> -- dest-host <destination host> How to use scripts 1107 Amazon Timestream Which migrates a single bucket. All options can be viewed by running: python3
|
timestream-257
|
timestream.pdf
| 257 |
local storage for backup and restoration. • Check space with df -h (UNIX/Linux) or by checking drive properties on Windows. • Direct Connection Ensure a direct network connection exists between the system running the migration script and the source and destination systems. influx ping --host <host> is one way to verify a direct connection. How to use scripts A simple example of running the script is the command: python3 influx_migration.py --src-host <source host> --src-bucket <source bucket> -- dest-host <destination host> How to use scripts 1107 Amazon Timestream Which migrates a single bucket. All options can be viewed by running: python3 influx_migration.py -h Usage Developer Guide shell influx_migration.py [-h] [--src-bucket SRC_BUCKET] [--dest-bucket DEST_BUCKET] [--src-host SRC_HOST] --dest-host DEST_HOST [--full] [--confirm-full] [--src-org SRC_ORG] [--dest-org DEST_ORG] [--csv] [--retry-restore-dir RETRY_RESTORE_DIR] [--dir- name DIR_NAME] [--log-level LOG_LEVEL] [--skip-verify] [--s3-bucket S3_BUCKET] Options • -confirm-full (optional): Using --full without --csv will replace all tokens, users, buckets, dashboards, and any other key-value data in the destination database with the tokens, users, buckets, dashboards, and any other key-value data in the source database. --full with --csv only migrates all bucket and bucket metadata, including bucket organizations. This option (-- confirm-full) will confirm a full migration and proceed without user input. If this option is not provided, and --full has been provided and --csv not provided, then the script will pause for execution and wait for user confirmation. This is a critical action, proceed with caution. Defaults to false. • -csv (optional): Whether to use csv files for backing up and restoring. If --full is passed as well then all user-defined buckets in all organizations will be migrated, not system buckets, users, tokens, or dashboards. If a singular organization is desired for all buckets in the destination server instead of their already-existing source organizations, use --dest-org. • -dest-bucket DEST_BUCKET (optional): The name of the InfluxDB bucket in the destination server, must not be an already existing bucket. Defaults to value of --src-bucket or None if -- src-bucket not provided. • -dest-host DEST_HOST: The host for the destination server. Example: http://localhost:8086. • -dest-org DEST_ORG (optional): The name of the organization to restore buckets to in the destination server. If this is omitted, then all migrated buckets from the source server will retain their original organization and migrated buckets may not be visible in the destination server without creating and switching organizations. This value will be used in all forms of restoration whether a single bucket, a full migration, or any migration using csv files for backup and restoration. How to use scripts 1108 Amazon Timestream Developer Guide • -dir-name DIR_NAME (optional): The name of the backup directory to create. Defaults to influxdb-backup-<timestamp>. Must not already exist. • -full (optional): Whether to perform a full restore, replacing all data on destination server with all data from source server from all organizations, including all key-value data such as tokens, dashboards, users, etc. Overrides --src-bucket and --dest-bucket. If used with --csv, only migrates data and metadata of buckets. Defaults to false. • h, --help: Shows help message and exits. • -log-level LOG_LEVEL(optional): The log level to be used during execution. Options are debug, error, and info. Defaults to info. • -retry-restore-dir RETRY_RESTORE_DIR(optional): Directory to use for restoration when a previous restore failed, will skip backup and directory creation, will fail if the directory doesn't exist, can be a directory within an S3 bucket. If a restoration fails, the backup directory path that can be used for restoration will be indicated relative to the current directory. S3 buckets will be in the form influxdb-backups/<s3 bucket>/<backup directory>. The default backup directory name is influxdb-backup-<timestamp>. • -s3-bucket S3_BUCKET(optional): The name of the S3 bucket to use to store backup files. On Linux this is simply the name of the S3 bucket, such as amzn-s3-demo-bucket1, given AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables have been set or ${HOME}/.aws/credentials exists. On Windows, this is the rclone configured remote and bucket name, such as my-remote:amzn-s3-demo-bucket1. All backup files will be left in the S3 bucket after migration in a created influxdb-backups-<timestamp> directory. A temporary mount directory named influx-backups will be created in the directory from where this script is ran. If not provided, then all backup files will be stored locally in a created influxdb-backups-<timestamp> directory from where this script is run. • -skip-verify(optional): Skip TLS certificate verification. • -src-bucket SRC_BUCKET(optional): The name of the InfluxDB bucket in the source server. If not provided, then --full must be provided. • -src-host SRC_HOST(optional): The host for the source server. Defaults to http://localhost:8086. As noted previously, mountpoint-s3 and rclone are needed if --s3-bucket is to be used, but can be ignored if the user doesn't provide a value for --s3-bucket, in which case backup files will be stored in a unique directory locally. How to use scripts 1109 Amazon Timestream Migration Overview After meeting the prerequisites:
|
timestream-258
|
timestream.pdf
| 258 |
influxdb-backups-<timestamp> directory from where this script is run. • -skip-verify(optional): Skip TLS certificate verification. • -src-bucket SRC_BUCKET(optional): The name of the InfluxDB bucket in the source server. If not provided, then --full must be provided. • -src-host SRC_HOST(optional): The host for the source server. Defaults to http://localhost:8086. As noted previously, mountpoint-s3 and rclone are needed if --s3-bucket is to be used, but can be ignored if the user doesn't provide a value for --s3-bucket, in which case backup files will be stored in a unique directory locally. How to use scripts 1109 Amazon Timestream Migration Overview After meeting the prerequisites: Developer Guide 1. Run Migration Script: Using a terminal app of your choice, run the Python script to transfer data from the source InfluxDB instance to the destination InfluxDB instance. 2. Provide Credentials: Provide host addresses and ports as CLI options. 3. Verify Data: Ensure the data is correctly transferred by: a. Using the InfluxDB UI and inspecting buckets. b. Listing buckets with influx bucket list -t <destination token> --host <destination host address> --skip-verify. c. Using influx v1 shell -t <destination token> --host <destination host address> --skip-verify and running SELECT * FROM <migrated bucket>.<retention period>.<measurement name> LIMIT 100 to view contents of a bucket or SELECT COUNT(*) FROM <migrated bucket>.<retention period>.<measurment name> to verify the correct number of records have been migrated. Example Example run 1. Open a terminal app of your choice and make sure the required prerequisites are properly installed: 2. Navigate to the migration script: Migration Overview 1110 Amazon Timestream Developer Guide 3. Prepare the following information: a. Name of the source bucket to be migrated. b. c. (Optional) Choose a new bucket name for the migrated bucket in the destination server. Root token for source and destination influx instances. d. Host address of source and destination influx instances. e. (Optional) S3 bucket name and credentials; AWS Command Line Interface credentials should be set in the OS environment variables. # AWS credentials (for timestream testing) export AWS_ACCESS_KEY_ID="xxx" export AWS_SECRET_ACCESS_KEY="xxx" f. Construct the command as: python3 influx_migration.py --src-bucket [amzn-s3-demo-source-bucket] --dest- bucket [amzn-s3-demo-destination-bucket] --src-host [source host] --dest-host [dest host] --s3-bucket [amzn-s3-demo-bucket2](optional) --log-level debug g. Execute the script: h. Wait for the script to finish executing. i. Check the newly migrated bucket for data integrity, performance.txt. This file, located under the same directory where the script was run, contains some basic information on how long each step took. Migration scenarios Example Example 1: Simple Migration Using Local Storage You want to migrate a single bucket, amzn-s3-demo-primary-bucket, from the source server (http://localhost:8086) to a destination server (http://dest-server-address:8086). Migration Overview 1111 Amazon Timestream Developer Guide After ensuring you have TCP access (for HTTP access) to both machines hosting the InfluxDB instances on port 8086 and you have both source and destination tokens and have stored them as the environment variables INFLUX_SRC_TOKEN and INFLUX_DEST_TOKEN, respectively, for added security: python3 influx_migration.py --src-bucket amzn-s3-demo-primary-bucket --src-host http:// localhost:8086 --dest-host http://dest-server-address:8086 The output should look similar to the following: INFO: influx_migration.py: Backing up bucket data and metadata using the InfluxDB CLI 2023/10/26 10:47:15 INFO: Downloading metadata snapshot 2023/10/26 10:47:15 INFO: Backing up TSM for shard 1 2023/10/26 10:47:15 INFO: Backing up TSM for shard 8245 2023/10/26 10:47:15 INFO: Backing up TSM for shard 8263 [More shard backups . . .] 2023/10/26 10:47:20 INFO: Backing up TSM for shard 8240 2023/10/26 10:47:20 INFO: Backing up TSM for shard 8268 2023/10/26 10:47:20 INFO: Backing up TSM for shard 2 INFO: influx_migration.py: Restoring bucket data and metadata using the InfluxDB CLI 2023/10/26 10:47:20 INFO: Restoring bucket "96c11c8876b3c016" as "amzn-s3-demo-primary- bucket" 2023/10/26 10:47:21 INFO: Restoring TSM snapshot for shard 12772 2023/10/26 10:47:22 INFO: Restoring TSM snapshot for shard 12773 [More shard restores . . .] 2023/10/26 10:47:28 INFO: Restoring TSM snapshot for shard 12825 2023/10/26 10:47:28 INFO: Restoring TSM snapshot for shard 12826 INFO: influx_migration.py: Migration complete The directory influxdb-backup-<timestamp> will be created and stored in the directory from where the script was run, containing backup files. Example Example 2: Full Migration Using Local Storage and Debug Logging Same as above except you want to migrate all buckets, tokens, users, and dashboards, deleting the buckets in the destination server, and proceeding without user confirmation of a complete database migration by using the --confirm-full option. You also want to see what the performance measurements are so you enable debug logging. Migration Overview 1112 Amazon Timestream Developer Guide python3 influx_migration.py --full --confirm-full --src-host http://localhost:8086 -- dest-host http://dest-server-address:8086 --log-level debug The output should look similar to the following: INFO: influx_migration.py: Backing up bucket data and metadata using the InfluxDB CLI 2023/10/26 10:55:27 INFO: Downloading metadata snapshot 2023/10/26 10:55:27 INFO: Backing up TSM for shard 6952 2023/10/26 10:55:27 INFO: Backing up TSM for shard 6953 [More shard backups . . .] 2023/10/26 10:55:36 INFO: Backing up TSM for shard 8268 2023/10/26 10:55:36 INFO: Backing up
|
timestream-259
|
timestream.pdf
| 259 |
the --confirm-full option. You also want to see what the performance measurements are so you enable debug logging. Migration Overview 1112 Amazon Timestream Developer Guide python3 influx_migration.py --full --confirm-full --src-host http://localhost:8086 -- dest-host http://dest-server-address:8086 --log-level debug The output should look similar to the following: INFO: influx_migration.py: Backing up bucket data and metadata using the InfluxDB CLI 2023/10/26 10:55:27 INFO: Downloading metadata snapshot 2023/10/26 10:55:27 INFO: Backing up TSM for shard 6952 2023/10/26 10:55:27 INFO: Backing up TSM for shard 6953 [More shard backups . . .] 2023/10/26 10:55:36 INFO: Backing up TSM for shard 8268 2023/10/26 10:55:36 INFO: Backing up TSM for shard 2 DEBUG: influx_migration.py: backup started at 2023-10-26 10:55:27 and took 9.41 seconds to run. INFO: influx_migration.py: Restoring bucket data and metadata using the InfluxDB CLI 2023/10/26 10:55:36 INFO: Restoring KV snapshot 2023/10/26 10:55:38 WARN: Restoring KV snapshot overwrote the operator token, ensure following commands use the correct token 2023/10/26 10:55:38 INFO: Restoring SQL snapshot 2023/10/26 10:55:39 INFO: Restoring TSM snapshot for shard 6952 2023/10/26 10:55:39 INFO: Restoring TSM snapshot for shard 6953 [More shard restores . . .] 2023/10/26 10:55:49 INFO: Restoring TSM snapshot for shard 8268 2023/10/26 10:55:49 INFO: Restoring TSM snapshot for shard 2 DEBUG: influx_migration.py: restore started at 2023-10-26 10:55:36 and took 13.51 seconds to run. INFO: influx_migration.py: Migration complete Example Example 3: Full Migration Using CSV, Destination Organization, and S3 Bucket Same as the previous example but using Linux or Mac and storing the files in the S3 bucket, amzn- s3-demo-bucket. This avoids backup files overloading the local storage capacity. python3 influx_migration.py --full --src-host http://localhost:8086 --dest-host http:// dest-server-address:8086 --csv --dest-org MyOrg --s3-bucket amzn-s3-demo-bucket The output should look similar to the following: INFO: influx_migration.py: Creating directory influxdb-backups INFO: influx_migration.py: Mounting amzn-s3-demo-influxdb-migration-bucket Migration Overview 1113 Amazon Timestream Developer Guide INFO: influx_migration.py: Creating directory influxdb-backups/amzn-s3-demo-bucket/ influxdb-backup-1698352128323 INFO: influx_migration.py: Backing up bucket data and metadata using the InfluxDB v2 API INFO: influx_migration.py: Restoring bucket data and metadata from csv INFO: influx_migration.py: Restoring bucket amzn-s3-demo-some-bucket INFO: influx_migration.py: Restoring bucket amzn-s3-demo-another-bucket INFO: influx_migration.py: Restoring bucket amzn-s3-demo-primary-bucket INFO: influx_migration.py: Migration complete INFO: influx_migration.py: Unmounting influxdb-backups INFO: influx_migration.py: Removing temporary mount directory Configuring a DB instance This section shows how to set up your Amazon Timestream for InfluxDB DB instance. Before creating a DB instance, decide on the DB instance class that will run the DB instance. Also, decide where the DB instance will run by choosing an AWS Region. Next, create the DB instance. You can configure a DB instance with a DB parameter group.A DB parameter group acts as a container for engine configuration values that are applied to one or more DB instances. The parameters that are available depend on the DB engine and DB engine version. You can specify a DB parameter group when you create a DB instance. You can also modify a DB instance to specify them. Important At this time, you can't modify compute (Instance types) and Storage (Storage Types) configuration of existing instances. Creating a DB instance Using the console 1. 2. Sign in to the AWS Management Console and open Amazon Timestream for InfluxDB. In the upper-right corner of the Amazon Timestream for InfluxDB console, choose the AWS Region in which you want to create the DB instance. 3. In the navigation pane, choose InfluxDB Databases. Configuring a DB instance 1114 Amazon Timestream Developer Guide 4. Choose Create Influx database. 5. For DB Instance Identifier. enter a name that will identify your instance. 6. Provide the InfluxDB basic configuration parameters User Name, Organization, Bucket Name and Password. Important Your user name, organization, bucket name and password will be stored as a secret in AWS Secrets Manager that will be created for your account. If you need to change the user password after the DB instance is available, you can modify using the Influx CLI. 7. 8. 9. For DB Instance Class, select an instance size that better fit your workload needs. For DB Storage Class, select a storage class that fits your need. In all cases, you will only need to configure the allocated storage. 10. In the Connectivity configuration section, make sure your InfluxDB instance is in the same subnet as your new the clients that require connectivity to your Timestream for InfluxDB DB instance. You could also chose to make your DB instance publicly available. 11. Choose Create Influx database. 12. In the Databases list, choose the name of your new InfluxDB instance to show its details. The DB Instance has a status of Creating until is ready to use. 13. When the status changes to Available, you can connect to the DB instance. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available. Using the CLI To create a DB instance by using the AWS
|
timestream-260
|
timestream.pdf
| 260 |
for InfluxDB DB instance. You could also chose to make your DB instance publicly available. 11. Choose Create Influx database. 12. In the Databases list, choose the name of your new InfluxDB instance to show its details. The DB Instance has a status of Creating until is ready to use. 13. When the status changes to Available, you can connect to the DB instance. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available. Using the CLI To create a DB instance by using the AWS Command Line Interface, call the create-db-instance command with the following parameters: --name --vpc-subnet-ids --vpc-security-group-ids Creating a DB instance 1115 Developer Guide Amazon Timestream --db-instance-type --db-storage-type --username --organization --password --allocated-storage For information about each setting, see Settings for DB instances. Example Example: Using default engine configs For Linux, macOS, or Unix: aws timestream-influxdb create-db-instance \ --name myinfluxDbinstance \ --allocated-storage 400 \ --db-instance-type db.influx.4xlarge \ --vpc-subnet-ids subnetid1 subnetid2 --vpc-security-group-ids mysecuritygroup \ --username masterawsuser \ --password \ --db-storage-type InfluxIOIncludedT2 For Windows: aws timestream-influxdb create-db-instance \ --name myinfluxDbinstance \ --allocated-storage 400 \ --db-instance-type db.influx.4xlarge \ --vpc-subnet-ids subnetid1 subnetid2 --vpc-security-group-ids mysecuritygroup \ --username masterawsuser \ --password \ --db-storage-type InfluxIOIncludedT2 Using the API To create a DB instance by using the AWS Command Line Interface, call the CreateDBInstance command with the following parameters: For information about each setting, see Settings for DB instances. Creating a DB instance 1116 Amazon Timestream Important Developer Guide Part of the DBInstance response object you receive an influxAuthParametersSecretArn. This will hold an ARN to a SecretsManager secret in your account. It will only be populated after your InfluxDB DB instances is available. The secret contains influx authentication parameters provided during the CreateDbInstance process. This is a READONLY copy as any updates/modifications/deletions to this secret doesn't impact the created DB instance. If you delete this secret, our API response will still refer to the deleted secret ARN. Once you have finished creating your Timestream for InfluxDB DB instance, we recommend you download, install and configure the Influx CLI. The influx CLI provides a simple way to interact with InfluxDB from a command line. For detailed installation and setup instructions, see Use the Influx CLI. Settings for DB instances You can create a DB instance using the console, the create-db-instance CLI command, or the CreateDBInstance Timestream for InfluxDB API operation. The following table provides details about settings that you choose when you create a DB instance. Console Setting Description CLI option and Timestream API parameter Allocated storage The amount of storage to allocate for your DB instance (in gibibytes). In some cases, allocating a higher amount of storage for your DB instance than the size of your database can improve I/O performan ce. CLI: allocated -storage API: allocated storage For more information, see InfluxDB instance storage. Bucket Name A name for the bucket to initialize the InfluxDb instance CLI: bucket API: bucket Settings for DB instances 1117 Amazon Timestream Console Setting Description Developer Guide CLI option and Timestream API parameter DB instance type The configuration for your DB instance. For example, a db.influx.large DB instance class has 16 GiB CLI: db-instan ce-type memory, 2 vCPUs, memory optimized. API: Dbinstanc If possible, choose a DB instance type large enough etype that a typical query working set can be held in memory. When working sets are held in memory, the system can avoid writing to disk, which improves performance. For more information, see DB instance class types. DB instance identifier The name for your DB instance. Name your DB instances in the same way that you name your on- CLI: db-instan ce-identi premises servers. Your DB instance identifier can fier contain up to 63 alphanumeric characters, and must be unique for your account in the AWS Region you chose. API: Dbinstanc eidentifier DB parameter group A parameter group for your DB instance. You can choose the default parameter group, or you can CLI: db-parame ter-group- create a custom parameter group. name For more information, see Working with DB parameter groups.. Log Delivery Setting The name of the S3 bucket were the InfluxDB logs will be stored. API: DBParamet erGroupName CLI: LogDelive ryConfigu ration API: log-deliv ery-confi guration Settings for DB instances 1118 Amazon Timestream Developer Guide Console Setting Description Multi-AZ deployment Create a standby instance to create a passive secondary replica of your DB instance in another Availability Zone for failover support. We recommend Multi-AZ for production workloads to maintain high availability. For development and testing, you can choose Do not create a standby instance. For more information, see Configuring and managing a multi-AZ deployment. CLI option and Timestream API parameter CLI: MultiAz API: multi-az Network Type The IP addressing protocols supported by the DB instance. CLI: network-t ype IPv4 (the default) to specify that
|
timestream-261
|
timestream.pdf
| 261 |
ery-confi guration Settings for DB instances 1118 Amazon Timestream Developer Guide Console Setting Description Multi-AZ deployment Create a standby instance to create a passive secondary replica of your DB instance in another Availability Zone for failover support. We recommend Multi-AZ for production workloads to maintain high availability. For development and testing, you can choose Do not create a standby instance. For more information, see Configuring and managing a multi-AZ deployment. CLI option and Timestream API parameter CLI: MultiAz API: multi-az Network Type The IP addressing protocols supported by the DB instance. CLI: network-t ype IPv4 (the default) to specify that resources can API: NetworkTy communicate with the DB instance only over pe the Internet Protocol version 4 (IPv4) addressing protocol. Dual-stack mode to specify that resources can communicate with the DB instance over IPv4, Internet Protocol version 6 (IPv6), or both. Use dual-stack mode if you have any resources that must communicate with your DB instance over the IPv6 addressing protocol. Also, make sure that you associate an IPv6 CIDR block with all subnets in the DB subnet group that you specify. While IPv6 is public by default, we do support private IPv6 endpoints, keep in mind that this is a one way door since we do not support changing the Publicly Accessible flag after instance creation. Settings for DB instances 1119 Amazon Timestream Console Setting Description Developer Guide CLI option and Timestream API parameter Password This will be your master use password use to Initializ e your InfluxDB Db instance. You will use this password to log in into the InfluxUI to obtain your CLI: password API: password operator token. Public Access Yes to give the DB instance a public IP address, meaning that it's accessible outside the VPC. To be CLI: publicly- accessible API: PubliclyA ccessible publicly accessible, the DB instance also has to be in a public subnet in the VPC. No to make the DB instance accessible only from inside the VPC. To connect to a DB instance from outside of its VPC, the DB instance must be publicly accessible. Also, access must be granted using the inbound rules of the DB instance's security group. In addition, other requirements must be met. Storage Type The storage type for your DB instance You can choose between 3 different types Provision CLI: db-storag e-type ed influx IOPS Included storage according to your API: DbStorage workloads requirements: Type * Influx IOPS Included 3000 IOPS * Influx IOPS Included 12000 IOPS * INflux IOPS Included 16000 IOPS For more information, see InfluxDB instance storage. Settings for DB instances 1120 Amazon Timestream Developer Guide Console Setting Description Initial username This will be the master user to initialize your InfluxDB DB instance with. You will use this username to log in into the InfluxUI to obtain your operator token. CLI option and Timestream API parameter CLI: username API: Username Subnets A vpc subnet to associate with this DB instance. CLI: vpc-subne VPC Security Group (firewall) t-ids API: VPCSubnet Ids The security group to associate with the DB instance. CLI: vpc-secur ity-group- ids API: VPCSecuri tyGroupIds Connecting to an Amazon Timestream for InfluxDB DB instance Before you can connect to a DB instance, you must create the DB instance. For information, see Creating a DB instance. After Amazon Timestream provisions your DB instance, use the InfluxDB API, influx CLI, or any compatible client or utility for InfluxDB to connect to the DB instance. Topics • Finding the connection information for an Amazon Timestream for InfluxDB DB instance • Database authentication options • Working with parameter groups Connecting to an Amazon Timestream for InfluxDB DB instance 1121 Amazon Timestream Developer Guide Finding the connection information for an Amazon Timestream for InfluxDB DB instance The connection information for a DB instance includes its endpoint, port, username, password, and a valid access token, such as the operator or all-access token. For example, for a Timestream for InfluxDB DB instance, suppose that the endpoint value is c5vasdqn0b-3ksj4dla5nfjhi.timestream-influxdb.us-east-1.on.aws. In this case, the port value is 8086, and the database user is admin. Given this information, to access the instance you will use: • The endpoint of your instance, c5vasdqn0b-3ksj4dla5nfjhi.timestream-influxdb.us- east-1.on.aws:8086. • Either the username and password supplied when creating the instance or valid access token. Instances created before December 9, 2024 will have an endpoint that contains the instance name instead of the instance ID. For example: influxdb1-123456789.us-east-1.timestream- influxdb.amazonaws.com. Important As part of the DB instance response object, you will receive a influxAuthParametersSecretArn. This will hold an ARN to a Secrets Manager secret in your account. t will only be populated after your InfluxDB DB instances are available. The secret contains Influx authentication parameters provided during the CreateDbInstance process. This is a read-only copy as any updates/modifications/deletions to this secret doesn't impact the created DB instance. If you
|
timestream-262
|
timestream.pdf
| 262 |
creating the instance or valid access token. Instances created before December 9, 2024 will have an endpoint that contains the instance name instead of the instance ID. For example: influxdb1-123456789.us-east-1.timestream- influxdb.amazonaws.com. Important As part of the DB instance response object, you will receive a influxAuthParametersSecretArn. This will hold an ARN to a Secrets Manager secret in your account. t will only be populated after your InfluxDB DB instances are available. The secret contains Influx authentication parameters provided during the CreateDbInstance process. This is a read-only copy as any updates/modifications/deletions to this secret doesn't impact the created DB instance. If you delete this secret, our API response will still refer to the deleted secret ARN. The endpoint is unique for each DB instance, and the values of the port and user can vary. To connect to a DB instance, you can use the influx CLI, InfluxDB API, or any client compatible with InfluxDB. To find the connection information for a DB instance, use the AWS Management Console. You can also use the AWS Command Line Interface (AWS CLI) describe-db-instances command or the Timestream for InfluxDB API GetDBInstance operation. Connecting to an Amazon Timestream for InfluxDB DB instance 1122 Amazon Timestream Developer Guide Using the AWS Management Console 1. 2. Sign in to the AWS Management Console and open the Amazon Timestream console. In the navigation pane, choose InfluxDB Databases to display a list of your DB instances. 3. Choose the name of the DB instance to display its details. 4. In the Summary section, copy the endpoint. Also, note the port number. You will need both the endpoint and the port number to connect to the DB instance. If you need to find the username and password information, choose the Configuration Details tab and choose the influxAuthParametersSecretArn to access your Secrets Manager. Using the CLI • To find the connection information for a InfluxDB DB instance by using the AWS CLI, call the get-db-instance command. In the call, query for the DB instance ID, endpoint, port, and influxAuthParametersSecretArn. For Linux, macOS, or Unix: aws timestream-influxdb get-db-instance --identifier id \ --query "[name,endpoint,influxAuthParametersSecretArn]" For Windows: aws timestream-influxdb get-db-instance --identifier id ^ --query "[name,endpoint,influxAuthParametersSecretArn]" Your output should be similar to the following. To access the username information, you will need to check the InfluxAuthParameterSecret. [ [ "mydb", "mydbid-123456789012.timestream-influxdb.us-east-1.on.aws", 8086, ] ] Connecting to an Amazon Timestream for InfluxDB DB instance 1123 Amazon Timestream Creating access tokens Developer Guide With this information, you are going to be able to connect to your instance to retrieve or create your access tokens. There are several ways to achieve this: Using the CLI 1. If you haven’t already, download, install, and configure the influx CLI. 2. When configuring your influx CLI config, use --username-password to authenticate. influx config create --config-name YOUR_CONFIG_NAME --host-url "https:// yourinstanceid-accountidentifier.timestream-influxdb.us-east-1.on.aws:8086" --org yourorg --username-password admin --active 3. Use the influx auth create command to re-create your operator token. Take into account that this process will invalidate the old operator token. influx auth create --org kronos --operator 4. Once you have the operator token, you can use the influx auth list command to view all your tokens. You can use the influx auth create command to create an all-access token. Important You will need to perform this step to obtain your operator token first. Then you will be able to create new tokens using the InfluxDB API or CLI. Using the InfluxDB UI 1. Browse to your Timestream for InfluxDB instance using the created endpoint to log in and access the InfluxDB UI. You will need to use the username and password used to create your InfluxDB DB instance. You can retrieve this information from the influxAuthParametersSecretArn that was specified in the response object of the CreateDbInstance. Alternatively you can open the InfluxDB UI from the Amazon Timestream for InfluxDB console: Connecting to an Amazon Timestream for InfluxDB DB instance 1124 Amazon Timestream Developer Guide a. Sign in to the AWS Management Console and open the Timestream for InfluxDB console at https://console.aws.amazon.com/timestream/. b. In the upper-right corner of the Amazon Timestream for InfluxDB console, choose the AWS Region in which you created the DB instance. c. In the Databases list, choose the name of your InfluxDB instance to show its details. In the upper right corner, choose InfluxDB UI. 2. Once logged in to your InfluxDB UI, navigate to Load Data and then API Tokens using the left navigation bar. 3. Choose Generate API Token and select All Access API Token. 4. Enter a description for the API token and choose SAVE. 5. Copy the generated token and store it for safe keeping. Important When creating tokens from the InfluxDB UI, the newly created tokens are only going to be shown once. Make sure you copy these. Otherwise, you will need to re-create them. Using the
|
timestream-263
|
timestream.pdf
| 263 |
instance to show its details. In the upper right corner, choose InfluxDB UI. 2. Once logged in to your InfluxDB UI, navigate to Load Data and then API Tokens using the left navigation bar. 3. Choose Generate API Token and select All Access API Token. 4. Enter a description for the API token and choose SAVE. 5. Copy the generated token and store it for safe keeping. Important When creating tokens from the InfluxDB UI, the newly created tokens are only going to be shown once. Make sure you copy these. Otherwise, you will need to re-create them. Using the InfluxDB API • Send a request to the InfluxDB API /api/v2/authorizations endpoint using the POST request method. Include the following with your request: a. Headers: i. ii. Authorization: Token <INFLUX_OPERATOR_TOKEN> Content-Type: application/json b. Request body: JSON body with the following properties: i. ii. status: "active" description: API token description iii. orgID: InfluxDB organization ID Connecting to an Amazon Timestream for InfluxDB DB instance 1125 Amazon Timestream Developer Guide iv. permissions: Array of objects where each object represents permissions for an InfluxDB resource type or a specific resource. Each permission contains the following properties: A. B. action: “read” or “write” resource: JSON object that represents the InfluxDB resource to grant permission to. Each resource contains at least the following property: orgID: InfluxDB organization ID C. type: Resource type. For information about what InfluxDB resource types exist, use the /api/v2/resources endpoint. The following example uses curl and the InfluxDB API to generate an all-access token: export INFLUX_HOST=https://instanceid-123456789.timestream-influxdb.us-east-1.on.aws export INFLUX_ORG_ID=<YOUR_INFLUXDB_ORG_ID> export INFLUX_TOKEN=<YOUR_INFLUXDB_OPERATOR_TOKEN> curl --request POST \ "$INFLUX_HOST/api/v2/authorizations" \ --header "Authorization: Token $INFLUX_TOKEN" \ --header "Content-Type: text/plain; charset=utf-8" \ --data '{ "status": "active", "description": "All access token for get started tutorial", "orgID": "'"$INFLUX_ORG_ID"'", "permissions": [ {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "authorizations"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "authorizations"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "buckets"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "buckets"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "dashboards"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "dashboards"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "orgs"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "orgs"}}, Connecting to an Amazon Timestream for InfluxDB DB instance 1126 Amazon Timestream Developer Guide {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "sources"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "sources"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "tasks"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "tasks"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "telegrafs"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "telegrafs"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "users"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "users"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "variables"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "variables"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "scrapers"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "scrapers"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "secrets"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "secrets"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "labels"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "labels"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "views"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "views"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "documents"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "documents"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "notificationRules"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "notificationRules"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "notificationEndpoints"}}, Connecting to an Amazon Timestream for InfluxDB DB instance 1127 Amazon Timestream Developer Guide {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "notificationEndpoints"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "checks"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "checks"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "dbrp"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "dbrp"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "notebooks"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "notebooks"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "annotations"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "annotations"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "remotes"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "remotes"}}, {"action": "read", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "replications"}}, {"action": "write", "resource": {"orgID": "'"$INFLUX_ORG_ID"'", "type": "replications"}} ] } ' Database authentication options Amazon Timestream for InfluxDB supports the following ways to authenticate database users: • Password authentication – Your DB instance performs all administration of user accounts. You create users, specify passwords, and administer tokens using the InfluxDB UI, influx CLI, or InfluxDB API. • Token authentication – Your DB instance performs all administration of user accounts. You can create users, specify passwords, and administer tokens using your operator token via the influx CLI and InfluxDB API. Connecting to an Amazon Timestream for InfluxDB DB instance 1128 Amazon Timestream Encrypted connections Developer Guide You can use Secure Socket Layer (SSL) or Transport Layer Security (TLS) from your application to encrypt a connection to a DB instance. The certificates needed for the TLS handshake between InfluxDB and the applications created and managed by the Kronos service. When the certificate is renewed, the instance is automatically updated with the latest version without requiring any user intervention. Working with parameter groups Database parameters specify how the database is configured. For example, database
|
timestream-264
|
timestream.pdf
| 264 |
token via the influx CLI and InfluxDB API. Connecting to an Amazon Timestream for InfluxDB DB instance 1128 Amazon Timestream Encrypted connections Developer Guide You can use Secure Socket Layer (SSL) or Transport Layer Security (TLS) from your application to encrypt a connection to a DB instance. The certificates needed for the TLS handshake between InfluxDB and the applications created and managed by the Kronos service. When the certificate is renewed, the instance is automatically updated with the latest version without requiring any user intervention. Working with parameter groups Database parameters specify how the database is configured. For example, database parameters can specify the amount of resources, such as memory, to allocate to a database. You manage your database configuration by associating your DB instances with parameter groups. Amazon Timestream for InfluxDB defines parameter groups with default settings. You can also define your own parameter groups with customized settings. Overview of parameter groups A DB parameter group acts as a container for engine configuration values that are applied to one or more DB instances. Topics • Default and custom parameter groups • Creating a DB parameter group • Static and dynamic DB instance parameters • Supported parameters and parameter values Default and custom parameter groups DB instances use DB parameter groups. The following sections describe configuring and managing DB instance parameter groups. Creating a DB parameter group You can create a new DB parameter group using the AWS Management Console, the AWS Command Line Interface, or the Timestream API. The following limitations apply to the DB parameter group name: Connecting to an Amazon Timestream for InfluxDB DB instance 1129 Amazon Timestream Developer Guide • The name must be 1 to 255 letters, numbers, or hyphens. • Default parameter group names can include a period, such as default.InfluxDB.2.7. However, custom parameter group names can't include a period. • The first character must be a letter. • The name cannot start with “dbpg-” • The name can't end with a hyphen or contain two consecutive hyphens. • If you create a DB instance without specifying a DB parameter group, the DB instance uses the InfluxDB engine defaults. You can't modify the parameter settings of a default parameter group. Instead, you can do the following: 1. Create a new parameter group. 2. Change the settings of your desired parameters. Not all DB engine parameters in a parameter group are eligible to be modified. 3. Update your DB instance to use the custom parameter group. For information about updating a DB instance, see Updating DB instances. Note If you have modified your DB instance to use a custom parameter group, and you start the DB instance, Amazon Timestream for InfluxDB automatically reboots the DB instance as part of the startup process. Currently, you won’t be able to modify custom parameter groups once they have been created. If you need to change a parameter, it is required that you create a new custom parameter group and assign it to the instances that require this configuration change. If you update an existing DB instance to assign a new parameter group, it will always be applied immediately and reboot your instance. Static and dynamic DB instance parameters InfluxDB DB instance parameters are always static. They behave as follows: When you change a static parameter, save the DB parameter group, and assign it to an instance, the parameter change takes effect automatically after the instance is rebooted. Connecting to an Amazon Timestream for InfluxDB DB instance 1130 Amazon Timestream Developer Guide When you associate a new DB parameter group with a DB instance, Timestream applies the modified static parameters only after the DB instance is rebooted. Currently the only option is apply immediately. For more information about changing the DB parameter group, see Updating DB instances. Supported parameters and parameter values To determine the supported parameters for your DB instance, view the parameters in the DB parameter group used by the DB instance. For more information, see Viewing parameter values for a DB parameter group. For more information about all parameters supported by the open-source version of InfluxDB, see InfluxDB configuration options. Currently you will only be able to modify the following InfluxDB parameters: Parameter Description Default value Value Valid range Note FALSE Boolean N/A info debug, info, error N/A flux-log- enabled log-level Include option to show detailed logs for Flux queries Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified. no-tasks Disable the task FALSE Boolean N/A Connecting to an Amazon Timestream for InfluxDB DB instance 1131 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks. Number of queries allowed to execute concurren tly. Setting to
|
timestream-265
|
timestream.pdf
| 265 |
Value Valid range Note FALSE Boolean N/A info debug, info, error N/A flux-log- enabled log-level Include option to show detailed logs for Flux queries Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified. no-tasks Disable the task FALSE Boolean N/A Connecting to an Amazon Timestream for InfluxDB DB instance 1131 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks. Number of queries allowed to execute concurren tly. Setting to 0 allows an unlimited number of concurrent queries. query-con currency 1,024 N/A Connecting to an Amazon Timestream for InfluxDB DB instance 1132 Amazon Timestream Developer Guide Default value 1,024 Value Valid range Note N/A "" log, jaeger N/A Parameter Description query-queue- size tracing-type 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. Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default. Connecting to an Amazon Timestream for InfluxDB DB instance 1133 Amazon Timestream Developer Guide Parameter Description metrics-d isabled Disable the HTTP / Default value FALSE Value Valid range Note N/A metrics endpoint which exposes internal InfluxDB metrics. Connecting to an Amazon Timestream for InfluxDB DB instance 1134 Amazon Timestream Developer Guide Default value 3m0s Parameter Description http-idle- timeout Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout. Value Valid range Note Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 Hours: -Minimum: 0 -Maximum: 256,205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 Connecting to an Amazon Timestream for InfluxDB DB instance 1135 Amazon Timestream Developer Guide Default value 10s Parameter Description http-read -header-t imeout Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout. Value Valid range Note Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 Hours: -Minimum: 0 -Maximum: 256,205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 Connecting to an Amazon Timestream for InfluxDB DB instance 1136 Amazon Timestream Developer Guide Default value 0 Parameter Description http-read- timeout Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout. Value Valid range Note Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 Hours: -Minimum: 0 -Maximum: 256,205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 Connecting to an Amazon Timestream for InfluxDB DB instance 1137 Amazon Timestream Developer Guide Default value 0 Parameter Description http-write- timeout Maximum duration the server should spend processin g and respondin g to write requests. Set to 0 for no timeout. Value Valid range Note Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 Hours: -Minimum: 0 -Maximum: 256,205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 Connecting to an Amazon Timestream for InfluxDB DB instance 1138 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note 0 Long Minimum: 0 Maximum: 9,223,372 ,036,854, 775,807 0 Long Minimum: 0 Maximum: 9,223,372 ,036,854, 775,807 influxql- max-select- buckets influxql-max- select-point Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets. 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). Connecting to an Amazon Timestream for InfluxDB DB instance 1139 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note influxql-max- select-series pprof-dis abled query-initial- memory- bytes 0 Long Minimum: 0 Maximum: 9,223,372 ,036,854, 775,807 Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series. Disable the TRUE Boolean N/A /debug/pp rof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging. Initial bytes of memory allocated for a query. 0 Long Minimum: 0 Maximum: query-mem ory-bytes While InfluxDB sets pprof- disabled as false by default, AWS sets it as true by default. Connecting to an Amazon Timestream for InfluxDB DB instance 1140 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note query-max -memory-b ytes query-mem ory-bytes session-l ength Maximum total bytes of memory allowed for queries. Specifies the Time to Live (TTL) in minutes for newly created user sessions. Specifies the Time to Live (TTL) in minutes for newly
|
timestream-266
|
timestream.pdf
| 266 |
runtime profiling data and can be helpful when debugging. Initial bytes of memory allocated for a query. 0 Long Minimum: 0 Maximum: query-mem ory-bytes While InfluxDB sets pprof- disabled as false by default, AWS sets it as true by default. Connecting to an Amazon Timestream for InfluxDB DB instance 1140 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note query-max -memory-b ytes query-mem ory-bytes session-l ength Maximum total bytes of memory allowed for queries. Specifies the Time to Live (TTL) in minutes for newly created user sessions. Specifies the Time to Live (TTL) in minutes for newly created user sessions. 0 0 Long Minimum: 0 Maximum: 9,223,372 ,036,854, 775,807 Long Minimum: 0 Maximum: 2,147,483 ,647 Must be greater than or equal to query-initial- memory- bytes. 60 Integer Minimum: 0 Maximum: 2,880 Connecting to an Amazon Timestream for InfluxDB DB instance 1141 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note FALSE Boolean N/A session-r enew-disa bled Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to 5 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. Connecting to an Amazon Timestream for InfluxDB DB instance 1142 Amazon Timestream Developer Guide Parameter Description Default value storage-c ache-max- Maximum size (in bytes) 1,073,741 ,824 memory-size a shard’s cache can reach before it starts rejecting writes. Value Valid range Note Long Minimum: 0 Maximum: 549,755,8 13,888 Must be lower than instance' s total memory capacity. We recommend setting it to below 15 percent of the total memory capacity. Must be lower than storage-c ache-max- memory-size. 26,214,400 Long Minimum: 0 Maximum: 549,755,8 13,888 storage-c ache-snap Size (in bytes) at shot-memo which the ry-size storage engine will snapshot the cache and write it to a TSM file to make more memory available. Connecting to an Amazon Timestream for InfluxDB DB instance 1143 Amazon Timestream Developer Guide Parameter Description storage-c ache-snap Duration at which shot-write- the storage cold-duration engine will Default value 10m0s snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes. Value Valid range Note Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 Hours: -Minimum: 0 -Maximum: 256,205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 Connecting to an Amazon Timestream for InfluxDB DB instance 1144 Amazon Timestream Developer Guide Parameter Description storage-c ompact-full- Duration at which write-cold- the storage Default value 4h0m0s duration engine will compact all TSM files in a shard if it hasn’t received writes or deletes. Value Valid range Note Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 Hours: -Minimum: 0 -Maximum: 256,205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 storage-c ompact-th roughput- burst Rate limit (in bytes per second) that TSM compactions can write to disk. 50,331,648 Long Minimum: 0 Maximum: 9,223,372 ,036,854, 775,807 Connecting to an Amazon Timestream for InfluxDB DB instance 1145 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note storage-max- concurrent- Maximum number of compactions full and level 0 Integer Minimum: 0 Maximum: 64 compactions that can run concurrently. A value of 0 results in 50 percent of runtime.G OMAXPROCS (0) used at runtime. Any number greater than zero limits compactio ns to that value. This setting does not apply to cache snapshotting. Connecting to an Amazon Timestream for InfluxDB DB instance 1146 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note 1,048,576 Long Minimum: 0 Maximum: 9,223,372 ,036,854, 775,807 FALSE Boolean N/A storage-m ax-index-log- file-size 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. Skip field size validation on incoming write requests. storage-n o-validate- field-size Connecting to an Amazon Timestream for InfluxDB DB instance 1147 Amazon Timestream Developer Guide Default value 30m0s Parameter Description storage-r etention- check-int erval Interval of retention policy enforcement checks. Value Valid range Note Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 N/A Hours: -Minimum: 0 -Maximum: 256,205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 Connecting to an Amazon Timestream for InfluxDB DB instance 1148 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note 0 Integer Minimum: 0 Maximum: 64 storage-s eries-file- max-con current-s Maximum number of snapshot compactions napshot-c that can run ompactions concurren tly across all series partitions in a database. Connecting
|
timestream-267
|
timestream.pdf
| 267 |
check-int erval Interval of retention policy enforcement checks. Value Valid range Note Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 N/A Hours: -Minimum: 0 -Maximum: 256,205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 Connecting to an Amazon Timestream for InfluxDB DB instance 1148 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note 0 Integer Minimum: 0 Maximum: 64 storage-s eries-file- max-con current-s Maximum number of snapshot compactions napshot-c that can run ompactions concurren tly across all series partitions in a database. Connecting to an Amazon Timestream for InfluxDB DB instance 1149 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note 100 Long Minimum: 0 Maximum: 9,223,372 ,036,854, 775,807 storage-s eries-id-set- Size of the internal cache-size cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalcula ted when a subsequen t query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance. Connecting to an Amazon Timestream for InfluxDB DB instance 1150 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note storage-w al-max-co ncurrent- writes storage-wal- max-write- delay Maximum number writes to the WAL directory to attempt at the same time. Maximum amount of time a write request to the WAL directory will wait when the the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout. 0 Integer Minimum: 0 10m Duration with unit hours, minutes, seconds, milliseco nds . Example: durationT ype=minut es,value= 10 Maximum: 256 Hours: -Minimum: 0 -Maximum: 256205 Minutes: -Minimum: 0 -Maximum: 15,372,286 Seconds: -Minimum: 0 -Maximum: 922,337,203 Milliseconds: -Minimum: 0 -Maximum: 922,337,2 03,685 Connecting to an Amazon Timestream for InfluxDB DB instance 1151 Amazon Timestream Developer Guide Parameter Description Default value Value Valid range Note FALSE Boolean N/A ui-disabled Disable the InfluxDB user interface (UI). The UI is enabled by default. Improperly setting parameters in a parameter group can have unintended adverse effects, including degraded performance and system instability. Always be cautious when modifying database parameters. Test parameter group setting changes on a test DB instance before applying those parameter group changes to a production DB instance. Working with DB parameter groups DB instances use DB parameter groups. The following sections describe configuring and managing DB instance parameter groups. Topics • Creating a DB parameter group • Associating a DB parameter group with a DB instance • Listing DB parameter groups • Viewing parameter values for a DB parameter group Creating a DB parameter group Using the AWS Management Console 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console. 2. In the navigation pane, choose Parameter groups. 3. Choose Create parameter group. 4. 5. In the Parameter group name box, enter the name of the new DB parameter group. In the Description box, enter a description for the new DB parameter group. Connecting to an Amazon Timestream for InfluxDB DB instance 1152 Amazon Timestream Developer Guide 6. Choose the parameters to modify and apply the desired values. For more information on supported parameters, see Supported parameters and parameter values. 7. Choose Create parameter group. Using the AWS Command Line Interface • To create a DB parameter group by using the AWS CLI, call the create-db-parameter- group command with the following parameters: --db-parameter-group-name <value> --description <value> --endpoint_url <value> --region <value> --parameters (list) (string) Example Example For information about each setting, see Settings for DB instances. This example uses default engine configs. aws timestream-influxdb create-db-parameter-group --db-parameter-group-name YOUR_PARAM_GROUP_NAME \ --endpoint-url YOUR_ENDPOINT \ --region YOUR_REGION \ --parameters "InfluxDBv2={logLevel=debug,queryConcurrency=10,metricsDisabled=true}" \" \ --debug Associating a DB parameter group with a DB instance You can create your own DB parameter groups with customized settings. You can associate a DB parameter group with a DB instance using the AWS Management Console, the AWS Command Line Interface, or the Timestream for InfluxDB API. You can do so when you create or modify a DB instance. For information about creating a DB parameter group, see Creating a DB parameter group. For information about creating a DB instance, see Creating a DB instance. For information about modifying a DB instance, see Updating DB instances. Connecting to an Amazon Timestream for InfluxDB DB instance 1153 Amazon Timestream Note Developer Guide When you associate a new DB parameter group with a DB instance, the modified static parameters are applied only after the DB instance is rebooted. Currently, only apply immediately is supported. Timestream for InfluxDB only support static parameters. Using the AWS Management Console 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console. 2. In
|
timestream-268
|
timestream.pdf
| 268 |
group. For information about creating a DB instance, see Creating a DB instance. For information about modifying a DB instance, see Updating DB instances. Connecting to an Amazon Timestream for InfluxDB DB instance 1153 Amazon Timestream Note Developer Guide When you associate a new DB parameter group with a DB instance, the modified static parameters are applied only after the DB instance is rebooted. Currently, only apply immediately is supported. Timestream for InfluxDB only support static parameters. Using the AWS Management Console 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console. 2. In the navigation pane, choose InfluxDB Databases, and then choose the DB instance that you want to modify. 3. Choose Update. The Update DB instance page appears. 4. Change the DB parameter group setting. 5. Choose Continue and check the summary of modifications. 6. Currently only Apply immediately is supported. This option can cause an outage in some cases since it will reboot your DB instance. 7. On the confirmation page, review your changes. If they are correct, choose Update DB instance to save your changes and apply them. Or choose Back to edit your changes or Cancel to cancel your changes. Using the AWS Command Line Interface For Linux, macOS, or Unix: aws timestream-influxdb update-db-instance --identifier YOUR_DB_INSTANCE_ID \ --region YOUR_REGION \ --db-parameter-group-identifier YOUR_PARAM_GROUP_ID \ --log-delivery-configuration "{\"s3Configuration\": {\"bucketName\": \"${LOGGING_BUCKET}\", \"enabled\": false }}" For Windows: aws timestream-influxdb update-db-instance Connecting to an Amazon Timestream for InfluxDB DB instance 1154 Amazon Timestream Developer Guide --identifier YOUR_DB_INSTANCE_ID ^ --region YOUR_REGION ^ --db-parameter-group-identifier YOUR_PARAM_GROUP_ID ^ --log-delivery-configuration "{\"s3Configuration\": {\"bucketName\": \"${LOGGING_BUCKET}\", \"enabled\": false }}" Listing DB parameter groups You can list the DB parameter groups you've created for your AWS account. Using the AWS Management Console 1. 2. 3. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console. In the navigation pane, choose Parameter groups. The DB parameter groups appear in a list. Using the AWS Command Line Interface To list all DB parameter groups for an AWS account, use the AWS Command Line Interface list- db-parameter-groups command. aws timestream-influxdb list-db-parameter-groups --region region To return a specific DB parameter groups for an AWS account, use the AWS Command Line Interface get-db-parameter-group command. aws timestream-influxdb get-db-parameter-group --region region --identifier identifier Viewing parameter values for a DB parameter group You can get a list of all parameters in a DB parameter group and their values. Using the AWS Management Console 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console. Connecting to an Amazon Timestream for InfluxDB DB instance 1155 Amazon Timestream Developer Guide 2. 3. In the navigation pane, choose Parameter groups. The DB parameter groups appear in a list. 4. Choose the name of the parameter group to see its list of parameters. Using the AWS Command Line Interface To view the parameter values for a DB parameter group, use the AWS Command Line Interface get-db-parameter-group command. Replace parameter-group-identifier with your own information. get-db-parameter-group --identifier parameter-group-identifier Using the API To view the parameter values for a DB parameter group, use the Timestream API GetDbParameterGroup command. Replace parameter-group-identifier with your own information. GetDbParameterGroup parameter-group-identifier Working with Multi-AZ read replica clusters for Amazon Timestream for InfluxDB A read replica cluster deployment is an asynchronous deployment mode of Amazon Timestream for InfluxDB that allows you to configure read replicas attached to a primary DB instance. A read replica cluster has a writer DB instance and at least one reader DB instance in separate Availability Zones within the same AWS Region. Read replica clusters provide high availability and increased capacity for read workloads when compared to Multi-AZ DB instance deployments. Instance class availability for read replica clusters Read replica cluster deployments are supported for the same instance types as regular Timestream for InfluxDB instances. Working with read replica clusters 1156 Amazon Timestream Developer Guide Instance class vCPU Memory (GiB) Storage type Network bandwidth (Gbps) db.influx .medium db.influx.large db.influx.xlarge 1 2 4 db.influx.2xlarge 8 db.influx.4xlarge 16 db.influx.8xlarge 32 db.influx .12xlarge db.influx .16xlarge 48 64 8 16 32 64 128 256 384 512 Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included 10 10 10 10 10 12 20 25 Read replica cluster architecture With a read replica cluster, Amazon Timestream for InfluxDB automatically replicates all writes made to the writer DB instance to all reader DB instances using InfluxData’s licensed read replica add-on. This replication is asynchronous and all writes are acknowledged as soon as they are committed by the writer node. Writes do not require acknowledgement from all reader nodes to be considered as a successful write. Once data is committed by the writer DB instance, it is replicated to the read replica instance almost
|
timestream-269
|
timestream.pdf
| 269 |
IOPS Included Influx IOPS Included 10 10 10 10 10 12 20 25 Read replica cluster architecture With a read replica cluster, Amazon Timestream for InfluxDB automatically replicates all writes made to the writer DB instance to all reader DB instances using InfluxData’s licensed read replica add-on. This replication is asynchronous and all writes are acknowledged as soon as they are committed by the writer node. Writes do not require acknowledgement from all reader nodes to be considered as a successful write. Once data is committed by the writer DB instance, it is replicated to the read replica instance almost instantaneously. In case of unrecoverable writer failure, any data that has not been replicated over to at least one of the readers will be lost. Read replica cluster architecture 1157 Amazon Timestream Developer Guide A read replica instance is a read-only copy of a writer DB instance. You can reduce the load on your writer DB instance by routing some or all of the queries from your applications to the read replica. In this way, you can elastically scale out beyond the capacity constraints of a single DB instance for read-heavy database workloads. The following diagram shows a primary DB instance replicating to a read replica in a different Availability Zone. Clients have read/write access to the primary DB instance and read-only access to the replica. Parameter groups for read replica clusters In a read replica cluster, a DB parameter group acts as a container for engine configuration values that are applied to every DB instance in the read replica cluster. A default DB parameter group is set based on the DB engine and DB engine version. The settings in the DB parameter group are used for all of the DB instances in the cluster. Parameter groups 1158 Amazon Timestream Developer Guide When passing a specific DB parameter group using CreateDbCluster or UpdateDbCluster for Multi- AZ DB read replica, ensure the storage-wal-max-write-delay is set to a duration of 1 hour minimum. If no DB parameter group is specified, storage-wal-max-write-delay will default to 1 hour. Replica lag in read replica clusters Although Timestream for InfluxDB read replica clusters allow for high write performance, replica lag can still occur due to the nature of engine-based asynchronous replication. This lag can lead to potential data loss in the event of a failover, making it essential to monitor. You can track the replica lag from CloudWatch by selecting All metrics in the AWS Management Console navigation pane. Choose Timestream/InfluxDB, then By DbCluster. Select your DbClusterName and then your DbReaderInstanceName. Here, besides the normal set of metrics tracked for all Timestream for InfluxDB instances (see below list), you will also see ReplicaLag, expressed in milliseconds. • CPUUtilization • MemoryUtilization • DiskUtilization • ReplicaLag (only for replica instance mode DB instances) Common causes of replica lag In general, replica lag occurs when the write and read workloads are too high for the reader DB instances to apply the transactions efficiently. Various workloads can incur temporary or continuous replica lag. Some examples of common causes are the following: • High write concurrency or heavy batch updating on the writer DB instance, causing the apply process on the reader DB instances to fall behind. • Heavy read workload that is using resources on one or more reader DB instances. Running slow or large queries can affect the apply process and can cause replica lag. • Transactions that modify large amounts of data or DDL statements can sometimes cause a temporary increase in replica lag because the database must preserve commit order. Replica lag 1159 Amazon Timestream Developer Guide For a tutorial that shows you how to create a CloudWatch alarm when replica lag exceeds a set amount of time, see Tutorial: Create an Amazon CloudWatch alarm for Multi-AZ cluster replica lag for Amazon Timestream for InfluxDB. Mitigating replica lag For Timestream for InfluxDB read replica clusters, you can mitigate replica lag by reducing the load on your writer DB instance. Availability and durability Read replica clusters can be configured to either automatically fail over to one of the reader instances in case of writer failure to prioritize write availability or to avoid failing over to minimize tip data loss. Tip data refers to the replication gap of data not yet replicated to at least one of the reader nodes (see Replica lag in read replica clusters). The default and recommended behavior for read replica clusters is to automatically fail over in case of writer failures. However, if tip data loss is more important than write availability for your use cases, you can override the default by updating the cluster. Read replica clusters ensure that all DB instances of the cluster are distributed across at least two Availability Zones to ensure increased write availability and data durability in case
|
timestream-270
|
timestream.pdf
| 270 |
loss. Tip data refers to the replication gap of data not yet replicated to at least one of the reader nodes (see Replica lag in read replica clusters). The default and recommended behavior for read replica clusters is to automatically fail over in case of writer failures. However, if tip data loss is more important than write availability for your use cases, you can override the default by updating the cluster. Read replica clusters ensure that all DB instances of the cluster are distributed across at least two Availability Zones to ensure increased write availability and data durability in case of an Availability Zone outage. Topics • Overview of Amazon Timestream for InfluxDB read replica clusters • Creating a Timestream for InfluxDB read replica cluster • Connecting to a Timestream for InfluxDB read replica DB cluster • Modifying a read replica cluster for Amazon Timestream for InfluxDB • Creating CloudWatch alarms to monitor Amazon Timestream for InfluxDB • Read replica licensing through AWS Marketplace Overview of Amazon Timestream for InfluxDB read replica clusters The following sections discuss Timestream for InfluxDB read replica clusters: Topics • Use cases for read replicas Availability and durability 1160 Amazon Timestream • How read replicas work • Characteristics of Timestream for InfluxDB read replicas • Read replica instance and storage types • Considerations when deleting replicas Use cases for read replicas Developer Guide Using a read replica cluster might make sense in a variety of scenarios, including the following: • Scaling beyond the compute or I/O capacity of a single DB instance for read-heavy database workloads. You can direct this excess read traffic to one or more read replicas. • Serving read traffic while the primary writer instance is unavailable. In some cases, your primary DB instance might not be able to take I/O requests, for example, due to I/O suspension for backups or scheduled maintenance. In these cases, you can direct read traffic to your read replica. For this use case, keep in mind that the data on the read replica might be "stale" because the primary DB instance is unavailable. Also, keep in mind that you will need to turn off automatic failover for these scenarios to work. • Business reporting or data warehousing scenarios where you might want business reporting queries to run against a read replica, rather than your production DB instance. • Implementing disaster recovery. You can promote a read replica to primary as a disaster recovery solution if the primary DB instance fails. • Faster failover for scenarios where availability is more important than durability. Since read replicas use asynchronous replication, there is a chance that some data that was committed by the primary writer instance was not replicated before a failover. However, for applications where uptime is paramount, this trade-off is acceptable. Depending on your workload characteristics, a failover to a read replica could be significantly faster than a failover to a standby DB instance that uses synchronous replication, as the replica instance is already running and does not need to start the engine. This can be particularly beneficial in use cases where every minute counts. How read replicas work To create a read replica cluster, Amazon Timestream for InfluxDB uses InfluxData’s licensed read replica add-ons. The add-on subscription is activated via the AWS Marketplace, directly from the Amazon Timestream management console. For more details, see Read replica licensing through AWS Marketplace. Read replicas cluster overview 1161 Amazon Timestream Developer Guide Read replicas are billed as standard DB instances at the same rates as the DB instance type used for each node in your cluster, plus the cost of InfluxData’s licensed add-on. The cost of the add-on is billed in instance-hours via the AWS Marketplace. You aren't charged for the data transfer incurred in replicating data between the source DB instance and a read replica within the same AWS Region. Once you have created and configured your read replica cluster and start accepting writes, Amazon Timestream for InfluxDB uses the asynchronous replication method to update the read replica whenever there is a change to the primary DB instance. The read replica functions as a dedicated DB instance, exclusively accepting read-only connections. Applications can connect to a read replica in the same manner as they would to any other DB instance, providing a seamless and familiar experience. Amazon Timestream for InfluxDB automatically replicates all data from the primary DB instance to the read replica, ensuring data consistency and accuracy. Note that updates are done at the cluster level and applied at the same time to both the primary and replica. Characteristics of Timestream for InfluxDB read replicas Feature or behavior Timestream for InfluxDB What is the replicati on method? Logical replication. Can a replica be made writable? No, Timestream for InfluxDB read replicas are designed to be read-only and
|
timestream-271
|
timestream.pdf
| 271 |
in the same manner as they would to any other DB instance, providing a seamless and familiar experience. Amazon Timestream for InfluxDB automatically replicates all data from the primary DB instance to the read replica, ensuring data consistency and accuracy. Note that updates are done at the cluster level and applied at the same time to both the primary and replica. Characteristics of Timestream for InfluxDB read replicas Feature or behavior Timestream for InfluxDB What is the replicati on method? Logical replication. Can a replica be made writable? No, Timestream for InfluxDB read replicas are designed to be read-only and cannot be made writable. While a read replica can be promoted to primary in the event of a failover, thereby accepting writes, at any given time, there can only be one writer DB instance in a Timestrea m for InfluxDB read replica cluster. This ensures data consistency and prevents conflicts that could arise from multiple writable instances. The read replica's role is to provide a redundant, read-only copy of the data, and it will automatically reject write requests to maintain data integrity . Yes, you can use the built-in engine capabilities to create backups using the Influx CLI. Can backups be performed on the replica? Read replicas cluster overview 1162 Amazon Timestream Developer Guide Feature or behavior Timestream for InfluxDB Can you use parallel replication? No, Timestream for InfluxDB has a single process handling replication. Read replica instance and storage types A read replica is created with the same instance and storage type as the primary DB instance. Any changes to the configuration must be made at the cluster level and will apply to all instances within the cluster. All instance and storage configurations available for Timestream for InfluxDB DB instances are available for Timestream for InfluxDB read replica clusters. Instance types Instance class vCPU Memory (GiB) Storage type Network bandwidth (Gbps) db.influx .medium db.influx.large db.influx.xlarge 1 2 4 db.influx.2xlarge 8 db.influx.4xlarge 16 db.influx.8xlarge 32 db.influx .12xlarge 48 8 16 32 64 128 256 384 Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included Influx IOPS Included 10 10 10 10 10 12 20 Read replicas cluster overview 1163 Amazon Timestream Developer Guide Instance class vCPU Memory (GiB) Storage type Network bandwidth (Gbps) db.influx .16xlarge 64 512 Influx IOPS Included 25 Storage options Timestream for InfluxDB DB cluster storage Source DB instance storage allocation Included IOPS Influx IO Included (3K) 20 GiB to 16 TiB 3,000 IOPS Influx IO Included (12K) 400 GiB to 16 TiB 12,000 IOPS Influx IO Included (16K) 400 GiB to 16 TiB 16,000 IOPS Considerations when deleting replicas If you no longer require read replicas, you can explicitly delete the cluster by calling the delete- db-cluster API. In the following example, replace each user input placeholder with your own information. Keep in mind that you cannot remove a single node from your cluster at this time. aws timestream-influxdb delete-db-cluster \ --region region \ --endpoint endpoint \ --db-cluster-id cluster-id Creating a Timestream for InfluxDB read replica cluster A Timestream for InfluxDB read replica cluster has a writer DB instance and at least one reader DB instance in separate Availability Zones. Timestream for InfluxDB read replica clusters provide high availability, increased capacity for read workloads, and faster failover when failover to replica is configured. Creating a read replica cluster 1164 Amazon Timestream DB cluster prerequisites Important The following are prerequisites to complete before creating a read replica cluster. Developer Guide Topics • Configure the network for the DB cluster • Additional prerequisites Configure the network for the DB cluster You can only create a Timestream for InfluxDB read replica DB cluster in a virtual private cloud (VPC) based on the Amazon VPC service. It must be in an AWS Region that has at least three Availability Zones. The DB subnet group that you choose for the DB cluster must cover at least three Availability Zones. This configuration ensures that each DB instance in the DB cluster is in a different Availability Zone. To connect to your DB cluster from resources other than EC2 instances in the same VPC, configure the network connections manually. Additional prerequisites Before you create your read replica cluster, consider the following additional prerequisites: To tailor the configuration parameters for your DB cluster, specify a DB cluster parameter group with the required parameter settings. For information about creating or modifying a DB cluster parameter group, see Parameter groups for read replica clusters. Determine the TCP/IP port number to specify for your DB cluster. The firewalls at some companies block connections to the default ports. If your company firewall blocks the default port, choose another port for your DB cluster. All DB instances in a DB cluster use the same port. Create a DB cluster You
|
timestream-272
|
timestream.pdf
| 272 |
your read replica cluster, consider the following additional prerequisites: To tailor the configuration parameters for your DB cluster, specify a DB cluster parameter group with the required parameter settings. For information about creating or modifying a DB cluster parameter group, see Parameter groups for read replica clusters. Determine the TCP/IP port number to specify for your DB cluster. The firewalls at some companies block connections to the default ports. If your company firewall blocks the default port, choose another port for your DB cluster. All DB instances in a DB cluster use the same port. Create a DB cluster You can create a Timestream for InfluxDB read replica DB cluster using the AWS Management Console, the AWS CLI, or the Amazon Timestream for InfluxDB API. Creating a read replica cluster 1165 Amazon Timestream Developer Guide Using the AWS Management Console You can create a Timestream for InfluxDB read replica DB cluster by choosing Cluster with read replicas in the Deployment settings section. To create a read replica DB cluster using the console: 1. 2. Sign in to the AWS Management Console and open the Amazon Timestream console. In the upper-right corner of the AWS Management Console, choose the AWS Region in which you want to create the read replica DB cluster. 3. In the navigation pane, choose InfluxDB databases. 4. Choose Create InfluxDB database. 5. In Deployment settings, choose Cluster with read replicas. Once you select that option, a message will appear indicating you need to activate your subscription via the AWS Marketplace widget. Click on View subscription options. Note that it can take 1–2 minutes for the subscription to become active. Creating a read replica cluster 1166 Amazon Timestream Developer Guide 6. Once the subscription is active, click View subscription. 7. A window will appear presenting information on the cost per vCPU per instance hour for each Region. This follows the same compute pricing model where you are charged for the number of hours your instance is active based on the instance type you have selected. You will only need to subscribe to the add-on once, and that will allow you to create instances in all Regions where Timestream for InfluxDB is available. Creating a read replica cluster 1167 Amazon Timestream Developer Guide Important To subscribe to the offer, you will need to have either AWSMarketplaceManageSubscriptions or AWSMarketplaceFullAccess permissions. For more information about these permissions, check Controlling access to AWS Marketplace subscriptions. Creating a read replica cluster 1168 Amazon Timestream Developer Guide 8. Once you confirm your subscription, the service will automatically select the Region based on the Region of your instance. 9. In Database credentials, complete the following fields: a. For DB cluster name, enter the identifier for your DB cluster. b. Provide the InfluxDB basic initial configuration parameters: username, organization name, bucket name, and password. 10. In Instance configuration, specify the DB instance class. Select an instance size that best fits your workload needs. Keep in mind that this instance type will be used for all instances in your read replica DB cluster. 11. In Storage configuration, select a Storage type that fits your needs. In all cases, you will only need to configure the allocated storage. Keep in mind that this storage type will be used for all instances in your read replica DB cluster. 12. In the Connectivity configuration section, make sure your InfluxDB cluster is in the same subnet as the clients that require connectivity to your Timestream for InfluxDB DB instance. You could also choose to make your DB instance publicly available in the Public access subsection. 13. Choose Create InfluxDB database. 14. In the InfluxDB databases list, choose the name of your new InfluxDB cluster to show its details. The DB cluster will have a status of Creating until it is ready to use. 15. When the status changes to Available, you can connect to the DB cluster. Depending on the DB instance class and the amount of storage, it can take up to 20 minutes before the new instance is available. Creating a read replica cluster 1169 Amazon Timestream Developer Guide 16. Once created, you can click on your DB cluster identifier to retrieve information about your newly created cluster. The endpoint showing an instance mode of PRIMARY is the one you will need to use for writes and engine administration. Using the AWS CLI To create a DB instance using the AWS Command Line Interface, call the create-db-cluster command with the following parameters. Replace each user input placeholder with your own information. aws timestream-influxdb create-db-cluster \ --region region \ --vpc-subnet-ids subnet-ids \ --vpc-security-group-ids security-group-ids \ --db-instance-type db.influx.large \ --db-storage-type InfluxIOIncludedT2 \ --allocated-storage 400 \ Creating a read replica cluster 1170 Amazon Timestream Developer Guide --password password \ --name cluster-name \ --deployment-type MULTI_NODE_READ_REPLICAS \ --publicly-accessible //--failover-mode is optional and defaults to
|
timestream-273
|
timestream.pdf
| 273 |
endpoint showing an instance mode of PRIMARY is the one you will need to use for writes and engine administration. Using the AWS CLI To create a DB instance using the AWS Command Line Interface, call the create-db-cluster command with the following parameters. Replace each user input placeholder with your own information. aws timestream-influxdb create-db-cluster \ --region region \ --vpc-subnet-ids subnet-ids \ --vpc-security-group-ids security-group-ids \ --db-instance-type db.influx.large \ --db-storage-type InfluxIOIncludedT2 \ --allocated-storage 400 \ Creating a read replica cluster 1170 Amazon Timestream Developer Guide --password password \ --name cluster-name \ --deployment-type MULTI_NODE_READ_REPLICAS \ --publicly-accessible //--failover-mode is optional and defaults to AUTOMATIC. Settings for creating read replica clusters For details about settings that you choose when you create a read replica cluster, see the following table. For more information about the AWS CLI options, see create-db-cluster. For more information about the Amazon Timestream for InfluxDB API parameters, see CreateDbCluster. Console setting Setting description Allocated storage The amount of storage to allocate for each DB instance in your DB cluster (in gibibytes). For more informati on, see InfluxDB instance storage. CLI option and Timestream for InfluxDB API parameter CLI option: --allocated- storage API parameter: allocated Storage Database port The port number on which InfluxDB accepts connections. CLI option: --port API parameter: port DB cluster name Valid Values: 1024-65535 Default: 8086 Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680. The name that uniquely identifies the DB cluster. DB instance names must be unique per customer and per region. CLI option: --name API parameter: name Creating a read replica cluster 1171 Amazon Timestream Developer Guide Console setting Setting description CLI option and Timestream for InfluxDB API parameter DB instance type The compute and memory capacity of each DB instance CLI option: --db-inst ance-type API parameter: dbInstanc eType in your Timestream for InfluxDB DB cluster, for example db.influx .xlarge . If possible, choose a DB instance class large enough that a typical query working set can be held in memory. When working sets are held in memory, the system can avoid writing to disk, which improves performance. DB cluster parameter group The ID of the DB parameter group to assign to your DB CLI option: --db-para meter-group-identi cluster. DB parameter groups fier Deployment type specify how the database is configured. For example, DB parameter groups can specify the limit for query concurren cy. API parameter: dbParamet erGroupIdentifier Specifies whether the DB cluster will be deployed as a multinode read replica or a Multi-AZ multinode read replica. CLI option: --deploym ent-type API parameter: deploymen tType Possible values: MULTI_NOD E_READ_REPLICAS Creating a read replica cluster 1172 Amazon Timestream Developer Guide Console setting Setting description VPC subnet ID Organization Bucket The DB subnet ID you want to use for the DB cluster. Select Choose existing to use an existing DB subnet group, then choose the required subnet group from the Existing DB subnet groups dropdown list. Choose Automatic setup to let Timestream for InfluxDB select a compatible DB subnet group. The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. 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. CLI option and Timestream for InfluxDB API parameter CLI option: --vpc-sub net-ids API parameter: vpcSubnet Ids CLI option: --organiz ation API parameter: organizat ion CLI option: --bucket API parameter: bucket Creating a read replica cluster 1173 Amazon Timestream Developer Guide Console setting Setting description CLI option and Timestream for InfluxDB API parameter Log exports Configuration for sending InfluxDB engine logs to a CLI option: --log-del ivery-configuration specified S3 bucket. API parameter: logDelive Configuration for S3 bucket ryConfiguration log delivery: s3Configu ration -> (structur e) The name of the S3 bucket to deliver logs to: bucketName -> (string) Indicates whether log delivery to the S3 bucket is enabled: enabled -> (boolean) Shorthand syntax: s3Configuration={b ucketName=string, enabled=boolean} The password of the initial admin user you 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 Secrets Manager in your account. CLI option: --password API parameter: password Password Creating a read replica cluster 1174 Amazon Timestream Developer Guide CLI option and Timestream for InfluxDB API parameter CLI option: --username API parameter: username Console setting Setting description Username 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
|
timestream-274
|
timestream.pdf
| 274 |
administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in AWS Secrets Manager in your account. CLI option: --password API parameter: password Password Creating a read replica cluster 1174 Amazon Timestream Developer Guide CLI option and Timestream for InfluxDB API parameter CLI option: --username API parameter: username Console setting Setting description Username 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 administr ative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in AWS Secrets Manager in your account. Public access Indicates whether the DB cluster is accessible from CLI options: --publicly- accessible --no-publ outside the VPC. icly-accessible API parameter: publiclyA ccessible Publicly accessible gives the DB cluster a public IP address, meaning it's accessibl e outside the VPC. To be publicly accessible, the DB cluster also has to be in a public subnet in the VPC. Not publicly accessibl e makes the DB cluster accessible only from inside the VPC. Creating a read replica cluster 1175 Amazon Timestream Developer Guide Console setting Setting description DB storage type InfluxDB data. You can choose between three different types of provisioned Influx IOPS CLI option and Timestream for InfluxDB API parameter CLI options: --db-stor age-type --no-publ icly-accessible API parameter: dbStorage Included storage according to Type your workload's requirements. Possible values: • InfluxIOIncludedT1 • InfluxIOIncludedT2 • InfluxIOIncludedT3 VPC security group A list of VPC security group IDs to associate with the DB CLI options: --vpc-sec urity-group-ids --no- instance. publicly-accessible VPC subnet IDs API parameter: vpcSecuri tyGroupIds CLI options: --vpc-sub net-ids API parameter: vpcSubnet Ids 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 Timestream for InfluxDB DB cluster. Creating a read replica cluster 1176 Amazon Timestream Developer Guide CLI option and Timestream for InfluxDB API parameter CLI options: --failover- mode API parameter: failoverM ode Console setting Setting description Failover mode How your cluster responds to a primary instance failure. You can configure this with the following options: AUTOMATIC : If the primary instance fails, the system automatically promotes a read replica to become the new primary instance. NO_FAILOVER : If the primary instance fails, the system attempts to restore the primary instance without promoting a read replica. The cluster remains unavailable until the primary instance is restored. Important As part of the DB cluster response object, you will receive an influxAuthParametersSecretArn. This will hold an ARN to a Secrets Manager secret in your account. It will only be populated after your InfluxDB DB instances are available. The secret contains Influx authentication parameters provided during the CreateDbInstance process. This is a read-only copy as any updates/modifications/deletions to this secret doesn't impact the created DB instance. If you delete this secret, our API response will still refer to the deleted secret ARN. Creating a read replica cluster 1177 Amazon Timestream Developer Guide Connecting to a Timestream for InfluxDB read replica DB cluster A Timestream for InfluxDB read replica DB cluster has two reachable DB instances instead of a single DB instance. Each connection is handled by a specific DB instance. When you connect to a read replica DB cluster, the hostname and port that you specify point to a fully qualified domain name called an endpoint. The primary (writer) endpoint connects to the writer DB instance of the read replica DB cluster, which supports both read and write operations. The reader endpoint connects to the reader DB instance, which support only read operations. Using endpoints, you can map each connection to the appropriate DB instance based on your use case. For example, to perform administrative or write statements, you can connect to whichever DB instance is the writer DB instance. To perform queries, you can connect to the reader endpoint. For diagnosis or tuning, you can connect to a specific DB instance endpoint, /metrics, to examine details about a specific DB instance. For information about connecting to a DB instance, see Connecting to an Amazon Timestream for InfluxDB DB instance. For more information about connecting to read replica clusters, see the following topics. Types of read replica cluster endpoints An endpoint is represented by a unique identifier that contains a host address. Each Timestream for InfluxDB cluster has: • A cluster endpoint. • A cluster read-only endpoint. • An instance endpoint for each instance in the cluster. Cluster endpoint A cluster endpoint (or writer endpoint) for a read replica cluster connects to the current writer DB instance for that
|
timestream-275
|
timestream.pdf
| 275 |
specific DB instance. For information about connecting to a DB instance, see Connecting to an Amazon Timestream for InfluxDB DB instance. For more information about connecting to read replica clusters, see the following topics. Types of read replica cluster endpoints An endpoint is represented by a unique identifier that contains a host address. Each Timestream for InfluxDB cluster has: • A cluster endpoint. • A cluster read-only endpoint. • An instance endpoint for each instance in the cluster. Cluster endpoint A cluster endpoint (or writer endpoint) for a read replica cluster connects to the current writer DB instance for that DB cluster. This endpoint is the only one that can perform write operations such as: • InfluxDB-specific administrative commands, e.g., creating, modifying, or deleting organizations, users, buckets, tasks, etc. • Writing data to your database cluster. Connecting to a read replica DB cluster 1178 Amazon Timestream Developer Guide You use the cluster endpoint for all write operations on the DB cluster, including writes, upserts, deletes, and all configuration and administrative changes. In addition, you can use the cluster endpoint for read operations, such as queries. If the current writer DB instance of a DB cluster fails, the read replica cluster automatically fails over to one of its replicas, promoting it as the new writer DB instance. During a failover, the DB cluster continues to serve connection requests to the cluster endpoint from the new writer DB instance, with minimal interruption of service. The read replica endpoint that was promoted to writer will stop serving reads until a new replica is deployed. The following example illustrates a cluster endpoint for a read replica cluster: ipvtdwa5se-wmyjrrjko.us-west-2.timestream-influxdb.amazonaws.com Read-only endpoint The read-only endpoint connects to any one of the read replica instances in the cluster. Read replicas will only support read operations, such as Flux or InfluxQL queries; in other words, all operations executed against the /api/v2/query endpoint for Flux queries or /api/query endpoint for InfluxQL v1-compatible queries. By processing those statements on the reader DB instances, this endpoint reduces the overhead on the writer DB instance. It also helps the cluster to handle a higher number of simultaneous queries. The following example illustrates a reader endpoint for a read replica cluster. The read-only intent of a reader endpoint is denoted by the -ro within the cluster endpoint name. ipvtdwa5se-wmyjrrjko-ro.us-west-2.timestream-influxdb.amazonaws.com Instance endpoint An instance endpoint connects to a specific DB instance within a read replica cluster. Each DB instance in a DB cluster has its own unique instance endpoint. Therefore, there is one instance endpoint for the current writer DB instance of the DB cluster (the primary), and there is one instance endpoint for each of the reader DB instances in the DB cluster. The instance endpoint provides direct control over connections to the DB cluster. This control can help you address scenarios where using the cluster endpoint or reader endpoint might not be appropriate. For example, your client application might require more fine-grained load balancing Connecting to a read replica DB cluster 1179 Amazon Timestream Developer Guide based on workload type. In this case, you can configure multiple clients to connect to different reader DB instances in a DB cluster to distribute read workloads. The following example illustrates an instance endpoint for a DB instance in a read replica cluster: mydbinstance-123456789012.us-east-1.timestream-influxdb.amazonaws.com Modifying a read replica cluster for Amazon Timestream for InfluxDB A read replica cluster has a writer DB instance and at least one reader DB instance in separate Availability Zones. Read replica clusters provide high availability, increased capacity for read workloads, and faster failover when compared to Multi-AZ deployments. For more information about read replica clusters, see Overview of Amazon Timestream for InfluxDB read replica clusters. You can modify a read replica cluster to change its settings. Important You can't modify the DB instances within a read replica cluster. All modifications must be done at the DB cluster level. You can modify a read replica cluster using the AWS Management Console, the AWS CLI, or the Amazon Timestream for InfluxDB API. Modify a read replica cluster for Amazon Timestream for InfluxDB Using the AWS Management Console To modify a read replica DB cluster using the console: 1. 2. Sign in to the AWS Management Console and open the Amazon Timestream console. In the navigation pane, choose InfluxDB databases and then choose the read replica cluster you want to modify. 3. Choose Modify. The Modify DB cluster page appears. 4. Choose any of the settings that you want. For information about each setting, see Settings for modifying read replica clusters. 5. After you have made your changes, choose Continue and check the summary of modifications. Modifying a read replica cluster 1180 Amazon Timestream Developer Guide 6. On the confirmation page, review your changes. If they're correct, choose Modify DB cluster to save your
|
timestream-276
|
timestream.pdf
| 276 |
AWS Management Console and open the Amazon Timestream console. In the navigation pane, choose InfluxDB databases and then choose the read replica cluster you want to modify. 3. Choose Modify. The Modify DB cluster page appears. 4. Choose any of the settings that you want. For information about each setting, see Settings for modifying read replica clusters. 5. After you have made your changes, choose Continue and check the summary of modifications. Modifying a read replica cluster 1180 Amazon Timestream Developer Guide 6. On the confirmation page, review your changes. If they're correct, choose Modify DB cluster to save your changes. Alternatively, choose Back to edit your changes or Cancel to cancel your changes. Important Currently Amazon Timestream for InfluxDB only supports Apply Immediately updates for the read replica cluster. If you confirm the changes, your DB cluster will incur downtime while the changes are being applied. Using the AWS CLI To modify a DB instance using the AWS Command Line Interface, use the update-db-cluster command with the following parameters. Replace each user input placeholder with your own information. aws timestream-influxdb update-db-cluster \ --region region \ --db-cluster-id db-cluster-id \ --db-instance-type db.influx.4xlarge \ --port 10000 \ --failover mode NO_FAILOVER Settings for modifying read replica clusters For details about settings that you can use to modify a read replica cluster, see the following table. For more information about the AWS CLI options, see update-db-cluster. Console setting Setting description CLI option and Timestream for InfluxDB API parameter Database port The port number on which InfluxDB accepts connections. CLI option: --port API parameter: port Valid Values: 1024-65535 Modifying a read replica cluster 1181 Amazon Timestream Developer Guide Console setting Setting description CLI option and Timestream for InfluxDB API parameter Default: 8086 Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680. DB instance type The compute and memory capacity of each DB instance CLI option: --db-inst ance-type API parameter: dbInstanc eType in your Timestream for InfluxDB DB cluster, for example db.influx .xlarge . If possible, choose a DB instance class large enough that a typical query working set can be held in memory. When working sets are held in memory, the system can avoid writing to disk, which improves performance. DB cluster parameter group The ID of the DB parameter group to assign to your DB CLI option: --db-para meter-group-identi cluster. DB parameter groups fier specify how the database is configured. For example, DB parameter groups can specify the limit for query concurren cy. API parameter: dbParamet erGroupIdentifier Modifying a read replica cluster 1182 Amazon Timestream Developer Guide Console setting Setting description CLI option and Timestream for InfluxDB API parameter Log exports Configuration for sending InfluxDB engine logs to a CLI option: --log-del ivery-configuration specified S3 bucket. API parameter: logDelive Configuration for S3 bucket ryConfiguration log delivery: s3Configu ration -> (structur e) The name of the S3 bucket to deliver logs to: bucketName -> (string) Indicate whether log delivery to the S3 bucket is enabled: enabled -> (boolean) Shorthand syntax: s3Configuration={b ucketName=string, enabled=boolean} Modifying a read replica cluster 1183 Amazon Timestream Developer Guide CLI option and Timestream for InfluxDB API parameter CLI option: --failover- mode API parameter: failoverM ode Console setting Setting description Failover mode Configure how your cluster responds to a primary instance failure using the following options: AUTOMATIC : If the primary instance fails, the system automatically promotes a read replica to become the new primary instance. NO_FAILOVER : If the primary instance fails, the system attempts to restore the primary instance without promoting a read replica. The cluster remains unavailable until the primary instance is restored. Creating CloudWatch alarms to monitor Amazon Timestream for InfluxDB You can create a CloudWatch alarm that sends an Amazon SNS message when the alarm changes state. An alarm watches a single metric over a time period that you specify. The alarm can also perform one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The action is a notification sent to an Amazon SNS topic or Amazon EC2 Auto Scaling policy. Alarms invoke actions for sustained state changes only. CloudWatch alarms don't invoke actions simply because they are in a particular state. The state must have changed and have been maintained for a specified number of time periods. Creating CloudWatch alarms to monitor Timestream for InfluxDB 1184 Amazon Timestream Developer Guide You can set CloudWatch alarms on any of the available metrics for Timestream for InfluxDB, including CPUUtilization, MemoryUtilization, DiskUtilization, and ReplicaLag. We recommend to start creating DiskUtilization-related alarms for your Timestream for InfluxDB databases, since out-of-storage space issues can turn out to be fairly problematic to InfluxDB. We recommend setting alerts to be sent whenever DiskUtilization goes over approximately 75–80 percent. To set an alarm using the AWS CLI Call put-metric-alarm. For
|
timestream-277
|
timestream.pdf
| 277 |
state must have changed and have been maintained for a specified number of time periods. Creating CloudWatch alarms to monitor Timestream for InfluxDB 1184 Amazon Timestream Developer Guide You can set CloudWatch alarms on any of the available metrics for Timestream for InfluxDB, including CPUUtilization, MemoryUtilization, DiskUtilization, and ReplicaLag. We recommend to start creating DiskUtilization-related alarms for your Timestream for InfluxDB databases, since out-of-storage space issues can turn out to be fairly problematic to InfluxDB. We recommend setting alerts to be sent whenever DiskUtilization goes over approximately 75–80 percent. To set an alarm using the AWS CLI Call put-metric-alarm. For more information, see put-metric-alarm in the AWS CLI Command Reference. To set an alarm using the CloudWatch API Call PutMetricAlarm. For more information, see PutMetricAlarm in the Amazon CloudWatch API Reference. For more information about setting up Amazon SNS topics and creating alarms, see Using Amazon CloudWatch alarms. Tutorial: Create an Amazon CloudWatch alarm for Multi-AZ cluster replica lag for Amazon Timestream for InfluxDB You can create an Amazon CloudWatch alarm that sends an Amazon SNS message when replica lag for a Multi-AZ DB cluster has exceeded a threshold. An alarm watches the ReplicaLag metric over a time period that you specify. The action is a notification sent to an Amazon SNS topic or Amazon EC2 Auto Scaling policy. To set a CloudWatch alarm for Multi-AZ DB cluster replica lag 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Alarms, then All alarms. 3. Choose Create alarm. 4. On the Specify metric and conditions page, choose Select metric. 5. In the search box, enter the name of your DB cluster, select Timestream/InfluxDB, By DbCluster, and then select your cluster. Creating CloudWatch alarms to monitor Timestream for InfluxDB 1185 Amazon Timestream Developer Guide 6. The following image shows the Select metric page with a read replica cluster named inframonitoringcluster selected. Choose the metric you want to create an alarm for, in this case ReplicaLag. Click Select metric. 7. On the Specify metric and conditions page, customize the following fields: Creating CloudWatch alarms to monitor Timestream for InfluxDB 1186 Amazon Timestream Developer Guide a. b. Select a period of time for your calculations in the Period section. Set up the conditions related to your alarm. For Threshold type, you can choose between Static and Anomaly detection. In this case, we will use Static since we know how our workload behaves. Each workload might have different requirements when it comes to what is considered "healthy." c. Select your threshold value. In the case of Static threshold values, these will be in milliseconds. d. Choose Next. 8. On the Configure actions page, in the Notification section, customize the following settings: Creating CloudWatch alarms to monitor Timestream for InfluxDB 1187 Amazon Timestream Developer Guide a. For Alarm state trigger, select In alarm. b. Choose Create new topic in Send a notification to the following SNS topic. c. Enter a unique topic name and a valid email address that will receive the notification. d. Choose Create topic. Scroll down and choose Next. 9. On the Add name and description page, enter an Alarm name and Alarm description. Choose Next. Creating CloudWatch alarms to monitor Timestream for InfluxDB 1188 Amazon Timestream Developer Guide 10. Review your alarm settings on the Preview and create page, and then choose Create alarm. Important To keep your Timestream for InfluxDB cluster in a healthy state, we also recommend monitoring and creating alarms for CPUUtilization and MemoryUtilization that consistently exceed a healthy 85 percent usage and DiskUtilization that exceeds 75 percent. Read replica licensing through AWS Marketplace To use Timestream for InfluxDB read replicas, you will need to activate the Timestream for InfluxDB read replicas add-on license through AWS Marketplace. Once the license is active, you will pay an hourly rate to use read replica clusters. You will only pay for the hours your read replica cluster is active. If you subscribe to the license but have no active Timestream for InfluxDB read replica clusters, you will not be charged. Topics • Read replica licensing terminology • Payments and billing • Subscribing to the InfluxDB read replica add-on on Marketplace listings Read replica licensing through AWS Marketplace 1189 Amazon Timestream Developer Guide Read replica licensing terminology This page uses the following terminology when discussing the Amazon Timestream for InfluxDB integration with AWS Marketplace. SaaS subscription In AWS Marketplace, software-as-a-service (SaaS) products such as the pay-as-you-go license model adopt a usage-based subscription model. InfluxData, the software seller for the read replica add-on, tracks your usage and you pay only for what you use. InfluxData Marketplace fees Fees charged for the InfluxDB read replica add-on software license usage by InfluxData. These service fees are metered through AWS Marketplace and appear on
|
timestream-278
|
timestream.pdf
| 278 |
Marketplace listings Read replica licensing through AWS Marketplace 1189 Amazon Timestream Developer Guide Read replica licensing terminology This page uses the following terminology when discussing the Amazon Timestream for InfluxDB integration with AWS Marketplace. SaaS subscription In AWS Marketplace, software-as-a-service (SaaS) products such as the pay-as-you-go license model adopt a usage-based subscription model. InfluxData, the software seller for the read replica add-on, tracks your usage and you pay only for what you use. InfluxData Marketplace fees Fees charged for the InfluxDB read replica add-on software license usage by InfluxData. These service fees are metered through AWS Marketplace and appear on your AWS bill under the AWS Marketplace section. Amazon Timestream for InfluxDB fees Fees that AWS charges for the Amazon Timestream for InfluxDB services, which excludes licenses when using Timestream for InfluxDB read replica clusters. Fees are metered through the Amazon Timestream for InfluxDB service being used and appear on your AWS bill. Payments and billing Timestream for InfluxDB integrates with AWS Marketplace to offer hourly, pay-as-you-go licenses for the read replica add-on. The read replica Marketplace fees cover the license costs of the read replica add-on software, and the Amazon Timestream fees cover the costs of your Timestream for InfluxDB read replica cluster usage. For information about pricing, see Amazon Timestream pricing. To stop these fees, you must delete any Timestream for InfluxDB read replica clusters. In addition, you can remove your subscriptions to AWS Marketplace for read replica add-on license. If you remove your subscriptions without deleting your read replica clusters, Amazon Timestream will continue to bill you for the use of the read replica clusters. For more information, see Considerations when deleting replicas. You can view bills and manage payments for your Timestream for InfluxDB read replica cluster in the AWS Billing console. Your bills includes two charges: one for your usage of InfluxData's licensed add-on through AWS Marketplace, and one for your usage of Amazon Timestream. For more information about billing, see Understanding your bill in the AWS Billing and Cost Management User Guide. Read replica licensing through AWS Marketplace 1190 Amazon Timestream Developer Guide Subscribing to the InfluxDB read replica add-on on Marketplace listings To use the read replica add-on license through AWS Marketplace, you must use the Amazon Timestream AWS Management Console to subscribe to the InfluxDB read replica add-on. You cannot complete these tasks through the AWS CLI or the Timestream for InfluxDB API. Topics • Subscribe from Amazon Timestream AWS Management Console • Subscribe to the InfluxDB read replica add-on in AWS Marketplace Note If you want to create your read replica cluster by using the AWS CLI or the Timestream for InfluxDB API, you must complete this step first. Subscribe from Amazon Timestream AWS Management Console You can subscribe to the InfluxDB read replica add-on using the Timestream Management Console. Start the Create InfluxDB Database flow and follow the steps. For more information, see Creating a Timestream for InfluxDB read replica cluster. Subscribe to the InfluxDB read replica add-on in AWS Marketplace To use the InfluxDB add-on license with AWS Marketplace, you need to have an active AWS Marketplace subscription for the InfluxDB read replica add-on. You will need to subscribe to a single add-on offer and that will allow you to create any instance type you need in any of the available regions. For information about AWS Marketplace subscriptions, see SaaS products through AWS Marketplace in the AWS Marketplace Buyer Guide. We recommend that you subscribe to InfluxDB in AWS Marketplace before you start creating a DB instance. 1. Navigate to the AWS Marketplace and search for InfluxData. Read replica licensing through AWS Marketplace 1191 Amazon Timestream Developer Guide 2. 3. Select Timestream for InfluxDB Read Replicas (Add-On). Select View purchase options. 4. Review the End User License Agreement and choose Subscribe. Read replica licensing through AWS Marketplace 1192 Amazon Timestream Developer Guide Read replica licensing through AWS Marketplace 1193 Amazon Timestream Developer Guide 5. You can now create your Timestream for InfluxDB read replica cluster using the Timestream Management Console, CLI, or API. Managing DB instances This section covers various aspects of managing Amazon Timestream for InfluxDB instance to ensure optimal performance, availability, and monitoring capabilities. It provides guidance on updating configurations of your database instances, handling multi-AZ deployments, and failover processes. It also explains how to delete database instances and set up log viewing for your InfluxDB instances. Topics • Updating DB instances • Maintaining a DB instance • Deleting a DB instance • Multi-AZ DB instance deployments • Setup to view InfluxDB logs on Timestream Influxdb Instances Updating DB instances You can update the following configuration parameters of your Timestream for InfluxDB instance: • Instance class • Storage type • Allocated storage (increase only) • Deployment type • Parameter group • Log delivery configuration Important We recommend
|
timestream-279
|
timestream.pdf
| 279 |
on updating configurations of your database instances, handling multi-AZ deployments, and failover processes. It also explains how to delete database instances and set up log viewing for your InfluxDB instances. Topics • Updating DB instances • Maintaining a DB instance • Deleting a DB instance • Multi-AZ DB instance deployments • Setup to view InfluxDB logs on Timestream Influxdb Instances Updating DB instances You can update the following configuration parameters of your Timestream for InfluxDB instance: • Instance class • Storage type • Allocated storage (increase only) • Deployment type • Parameter group • Log delivery configuration Important We recommend you test all changes on a test instance before modifying the production instance to understand their impact, especially when upgrading database versions. Managing DB instances 1194 Amazon Timestream Developer Guide Review the impact on your database and applications before updating settings. Some modifications require a DB instance reboot, resulting in downtime. Using the AWS Management Console 1. 2. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console. In the navigation pane, choose InfluxDB Databases, and then choose the DB instance that you want to modify. 3. Choose Modify. 4. On the Modify DB instance page, make the desired changes. 5. Choose Continue and check the summary of modifications. 6. Choose Next. 7. Review your changes. 8. Choose Modify instance to apply your changes. Note These modifications require a reboot of the Influx DB instance and can cause an outage in some cases. Using the AWS Command Line Interface To update a DB instance by using the AWS Command Line Interface, call the update-db- instance command. Specify the DB instance identifier and the values for the options that you want to modify. For information about each option, see Settings for DB instances. Example Example The following code modifies my-db-instance by setting a different db-parameter-group- name. Replace each user input placeholder with your own information. The changes are applied immediately. For Linux, macOS, or Unix: Updating DB instances 1195 Amazon Timestream Developer Guide aws timestream-influxdb update-db-instance \ --identifier my-db-instance \ --db-storage-type desired-storage-type \ --allocated-storage desired-allocated-storage \ --db-instance-type desired-instance-type \ --deployment-type desired-deployment-type \ --db-parameter-group-name new-param-group \ --port 8086 For Windows: aws timestream-influxdb update-db-instance ^ --identifier my-db-instance ^ --db-storage-type desired-storage-type ^ --allocated-storage desired-allocated-storage ^ --db-instance-type desired-instance-type ^ --deployment-type desired-deployment-type ^ --db-parameter-group-name new-param-group --port 8086 Maintaining a DB instance Periodically, Amazon Timestream for InfluxDB performs maintenance on Amazon Timestream for InfluxDB resources. Maintenance most often involves updates to the following resources in your DB instance: • Underlying hardware • Underlying operating system (OS) • Database engine version Updates to the operating system most often occur for security issues. Some maintenance items require that Amazon Timestream for InfluxDB take your DB instance offline for a short time. Maintenance items that require a resource to be offline include required operating system or database patching. Required patching is automatically scheduled only for patches that are related to security and instance reliability. Such patching occurs infrequently, typically once every few months. It seldom requires more than a fraction of your maintenance window. Maintaining a DB instance 1196 Amazon Timestream Developer Guide • Maintenance windows are configured to take place everyday between 12 AM and 4 AM local time for the Region your instance is being hosted. • Customer resources might be patched once a week in any one of the seven maintenance windows in the week. Deleting a DB instance Deleting a DB instance has an effect on instance recoverability, and snapshot availability. Consider the following issues: • If you want to delete all Timestream for InfluxDB resources, note that the DB instances resources incur billing charges. • When the status for a DB instance is deleting, its CA certificate value doesn't appear in the Timestream for InfluxDB console or in output for AWS Command Line Interface commands or Timestream API operations. • The time required to delete a DB instance varies depending on how much data is deleted, and whether a final snapshot is taken. You can delete a DB instance using the AWS Management Console, the AWS Command Line Interface, or the Timestream API. You must provide the name of the DB instance: Using the AWS Management Console 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console. 2. In the navigation pane, choose InfluxDB Databases, and then choose the DB instance that you want to delete. 3. Choose Delete. 4. Enter confirm in the box. 5. Choose Delete. Using the AWS Command Line Interface To find the instance IDs of the DB instances in your account, call the list-db-instances command: Deleting a DB instance 1197 Amazon Timestream Developer Guide aws timestream-influxdb list-db-instances \ --endpoint-url YOUR_ENDPOINT \ --region YOUR_REGION To delete a DB instance by using the AWS CLI, call the delete-db-instance command with the
|
timestream-280
|
timestream.pdf
| 280 |
to the AWS Management Console and open the Amazon Timestream for InfluxDB console. 2. In the navigation pane, choose InfluxDB Databases, and then choose the DB instance that you want to delete. 3. Choose Delete. 4. Enter confirm in the box. 5. Choose Delete. Using the AWS Command Line Interface To find the instance IDs of the DB instances in your account, call the list-db-instances command: Deleting a DB instance 1197 Amazon Timestream Developer Guide aws timestream-influxdb list-db-instances \ --endpoint-url YOUR_ENDPOINT \ --region YOUR_REGION To delete a DB instance by using the AWS CLI, call the delete-db-instance command with the following options: aws timestream-influxdb list-db-instances \ --identifier YOUR_DB_INSTANCE \ Example Example For Linux, macOS, or Unix: aws timestream-influxdb delete-db-instance \ --identifier mydbinstance For Windows: aws timestream-influxdb delete-db-instance ^ --identifier mydbinstance Multi-AZ DB instance deployments Amazon Timestream for InfluxDB provides high availability and failover support for DB instances using Multi-AZ deployments with a single standby DB instance. This type of deployment is called a Multi-AZ DB instance deployment. Amazon Timestream for InfluxDB use the Amazon failover technology. In a Multi-AZ DB instance deployment, Amazon Timestream automatically provisions and maintains a synchronous standby replica in a different Availability Zone. The primary DB instance is synchronously replicated across Availability Zones to a standby replica to provide data redundancy. Running a DB instance with high availability can enhance availability during DB instance failure and Availability Zone disruption. For more information on , see AWS Regions and Availability Zones . Note The high availability option isn't a scaling solution for read-only scenarios. You can't use a standby replica to serve read traffic. Multi-AZ DB instance deployments 1198 Amazon Timestream Developer Guide Using the Amazon Timestream console, you can create a Multi-AZ DB instance deployment by simply specifying Create a standby instance option in the Availability and durability configuration section when creating a DB instance. You can also specify a Multi-AZ DB instance deployment with the AWS Command Line Interface or Amazon Timestream API. Use the create- db-instance or CLI command, or the CreateDBInstance API operation. DB instances using Multi-AZ DB instance deployments can have increased write and commit latency compared to a Single-AZ deployment. This can happen because of the synchronous data replication that occurs. You might have a change in latency if your deployment fails over to the standby replica, although AWS is engineered with low-latency network connectivity between . For production workloads, we recommend that you use IOPS Included storage 12K or 16K IOPS for fast, consistent performance. For more information about DB instance classes, see DB instance classes. Configuring and managing a multi-AZ deployment Timestream for InfluxDB Multi-AZ deployments can only have one standby. When the deployment has one standby DB instance, it's called a Multi-AZ DB instance deployment. A Multi-AZ DB instance deployment has one standby DB instance that provides failover support, but doesn't serve read traffic. Important Your instance must have at least two subnets associated with it to execute Single-AZ to Multi-AZ updates. Once the instance is created, you can't modify its deployment mode from Single-AZ to Multi-AZ . You can use the AWS Management Console to determine whether your DB instance is a Single-AZ or Multi-AZ deployment. Using the AWS Management Console 1. Sign in to the AWS Management Console and open the Amazon Timestream for InfluxDB console. 2. In the navigation pane, choose InfluxDB databases, and then choose DB identifier. A Multi-AZ DB instance deployment has the following characteristics: Multi-AZ DB instance deployments 1199 Amazon Timestream Developer Guide • There is only one row for the DB instance. • The value of Role is Instance or Primary. • The value of Multi-AZ is Yes. Failover process for Amazon Timestream If a planned or unplanned outage of your DB instance results from an infrastructure defect, Amazon Timestream for InfluxDB automatically switches to a standby replica in another Availability Zone if you have turned on Multi-AZ. The time that it takes for the failover to complete depends on the database activity and other conditions at the time the primary DB instance became unavailable. Failover times are typically 60–120 seconds. However, large transactions or a lengthy recovery process can increase failover time. When the failover is complete, it can take additional time for the Timestream console to reflect the new Availability Zone. Note Amazon Timestream handles failovers automatically so you can resume database operations as quickly as possible without administrative intervention. The primary DB instance switches over automatically to the standby replica if any of the conditions described in the following table occurs. Failover reason Description The operating system underlying the Timestream database instance is being A failover was triggered during the maintenan ce window for an OS patch or a security patched in an offline operation. update. The primary host of the Timestream Multi-AZ instance is unhealthy. The Multi-AZ
|
timestream-281
|
timestream.pdf
| 281 |
additional time for the Timestream console to reflect the new Availability Zone. Note Amazon Timestream handles failovers automatically so you can resume database operations as quickly as possible without administrative intervention. The primary DB instance switches over automatically to the standby replica if any of the conditions described in the following table occurs. Failover reason Description The operating system underlying the Timestream database instance is being A failover was triggered during the maintenan ce window for an OS patch or a security patched in an offline operation. update. The primary host of the Timestream Multi-AZ instance is unhealthy. The Multi-AZ DB instance deployment detected an impaired primary DB instance and failed over. The primary host of the Timestream Multi-AZ instance is unreachable due to loss of network connectivity. Timestream monitoring detected a network reachability failure to the primary DB instance and triggered a failover. Multi-AZ DB instance deployments 1200 Amazon Timestream Failover reason Description Developer Guide The Timestream instance was modified by customer. An Timesteam for InfluxDB DB instance modification triggered a failover. For more information, see Updating DB instances. The Timestream Multi-AZ primary instance is busy and unresponsive. The primary DB instance is unresponsive. We recommend that you do the following : * Examine the event for excessive CPU, memory, or swap space usage. * Evaluate your workload to determine whether you're using the appropriate DB instance class. For more information, see DB instance classes. The storage volume underlying the primary host of the Timestream Multi-AZ instance The Multi-AZ DB instance deployment detected a storage issue on the primary DB experienced a failure. instance and failed over. Setting the JVM TTL for DNS name lookups The failover mechanism automatically changes the Domain Name System (DNS) record of the DB instance to point to the standby DB instance. As a result, you need to re-establish any existing connections to your DB instance. In a Java virtual machine (JVM) environment, due to how the Java DNS caching mechanism works, you might need to reconfigure JVM settings. The JVM caches DNS name lookups. When the JVM resolves a host name to an IP address, it caches the IP address for a specified period of time, known as the time-to-live (TTL). Because AWS resources use DNS name entries that occasionally change, we recommend that you configure your JVM with a TTL value of no more than 60 seconds. Doing this makes sure that when a resource's IP address changes, your application can receive and use the resource's new IP address by requerying the DNS. On some Java configurations, the JVM default TTL is set so that it never refreshes DNS entries until the JVM is restarted. Thus, if the IP address for an AWS resource changes while your application is still running, it can't use that resource until you manually restart the JVM and the cached IP information is refreshed. In this case, it's crucial to set the JVM's TTL so that it periodically refreshes its cached IP information. Multi-AZ DB instance deployments 1201 Amazon Timestream Developer Guide You can get the JVM default TTL by retrieving the networkaddress.cache.ttl property value: String ttl = java.security.Security.getProperty("networkaddress.cache.ttl"); Note The default TTL can vary according to the version of your JVM and whether a security manager is installed. Many JVMs provide a default TTL less than 60 seconds. If you're using such a JVM and not using a security manager, you can ignore the rest of this topic. To modify the JVM's TTL, set the networkaddress.cache.ttl property value. Use one of the following methods, depending on your needs: • To set the property value globally for all applications that use the JVM, set networkaddress.cache.ttl in the $JAVA_HOME/jre/lib/security/ java.security file. networkaddress.cache.ttl=60 • To set the property locally for your application only, set networkaddress.cache.ttl in your application's initialization code before any network connections are established. java.security.Security.setProperty("networkaddress.cache.ttl" , "60"); Setup to view InfluxDB logs on Timestream Influxdb Instances By default InfluxDB generates logs that go to stdout. For more information, see Manage InfluxDB logs To view InfluxDB logs generated from the Instance you have created through Timestream InfluxDB, we provide the opportunity to provide hourly logs. These logs will go to a specified S3 bucket that you must create before creating your instance. • Before creating the instance, the provided Amazon S3 bucket must also give Timestream- InfluxDB permission to send logs to this bucket by providing a bucket policy with Timestream InfluxDB Service Principal as following (replace {BUCKET_NAME} with the actual name of your Amazon S3 bucket: Setup to view InfluxDB Logs on Timestream Influxdb Instances 1202 Amazon Timestream Developer Guide { "Version": "2012-10-17", "Id": "PolicyForInfluxLogs", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "timestream-influxdb.amazonaws.com" }, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::{BUCKET_NAME}/InfluxLogs/*" } ] } • The bucket provided must be in the same account and same Region of your
|
timestream-282
|
timestream.pdf
| 282 |
before creating your instance. • Before creating the instance, the provided Amazon S3 bucket must also give Timestream- InfluxDB permission to send logs to this bucket by providing a bucket policy with Timestream InfluxDB Service Principal as following (replace {BUCKET_NAME} with the actual name of your Amazon S3 bucket: Setup to view InfluxDB Logs on Timestream Influxdb Instances 1202 Amazon Timestream Developer Guide { "Version": "2012-10-17", "Id": "PolicyForInfluxLogs", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "timestream-influxdb.amazonaws.com" }, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::{BUCKET_NAME}/InfluxLogs/*" } ] } • The bucket provided must be in the same account and same Region of your created Timestream InfluxDB instance Here is the command you can call to make an instance to receive influx logs: aws timestream-influxdb create-db-instance \ --name myinfluxDbinstance \ --allocated-storage 400 \ --db-instance-type db.influx.4xlarge \ --vpc-subnet-ids subnetid1 subnetid2 --vpc-security-group-ids mysecuritygroup \ --username masterawsuser \ --password \ --db-storage-type InfluxIOIncludedT2 Here is the format of this parameter. -- log-delivery-configuration { "S3Configuration": { "BucketName": "string", "Enabled": true|false } } Setup to view InfluxDB Logs on Timestream Influxdb Instances 1203 Amazon Timestream Developer Guide • This field is not required and logging is not enabled by default. • Not setting this field is the same as not having logs enabled. • Logs will be sent to specified bucket with a prefix of InfluxLogs/. • After creating the instance, you can modify the log delivery configuration with the update-db- instance API command. InfluxDB offers different types of logs. These can be configured by setting the InfluxDB Parameters. Use the flux-log-enabled and log-level parameters to configure the type of logs that is emitted from the instance. For more information, see Supported parameters and parameter values. Adding tags and labels to resources You can label Amazon Timestream for InfluxDB resources using tags. Tags let you categorize your resources in different ways—for example, by purpose, owner, environment, or other criteria. Tags can help you do the following: • Quickly identify a resource based on the tags that you assigned to it. • See AWS bills broken down by tags. Tagging is supported by AWS services like Amazon Elastic Compute Cloud (Amazon EC2), Amazon Simple Storage Service (Amazon S3), Timestream for InfluxDB, and more. Efficient tagging can provide cost insights by enabling you to create reports across services that carry a specific tag. Finally, it is good practice to follow optimal tagging strategies. For information, see AWS Tagging Strategies. Tagging restrictions Each tag consists of a key and a value, both of which you define. The following restrictions apply: • Each Timestream for InfluxDB DB instance can have only one tag with the same key. If you try to add an existing tag, the existing tag value is updated to the new value. • A value acts as a descriptor within a tag category. In Timestream for InfluxDB the value cannot be empty or null. • Tag keys and values are case sensitive. • The maximum key length is 128 Unicode characters. Tagging resources 1204 Amazon Timestream Developer Guide • The maximum value length is 256 Unicode characters. • The allowed characters are letters, white space, and numbers, plus the following special characters: + - = . _ : / • The maximum number of tags per resource is 50. • AWS-assigned tag names and values are automatically assigned the aws: prefix, which you can't assign. AWS-assigned tag names don't count toward the tag limit of 50. User-assigned tag names have the prefix user: in the cost allocation report. • You can't backdate the application of a tag. Security best practices for Timestream for InfluxDB Optimize writes to InfluxDB As any other time series database, InfluxDB is built to be able to ingest and process data in real- time. To keep the system performing at its best we recommend following optimizations when writing data to InfluxDB: • Batch Writes: When writing data to InfluxDB, write data in batches to minimize the network overhead related to every write request. The optimal batch size is 5000 lines of line protocol per write request. To write multiple lines in one request, each line of line protocol must be delimited by a new line (\n). • Sort tags by key: Before writing data points to InfluxDB, sort tags by key in lexicographic order. measurement,tagC=therefore,tagE=am,tagA=i,tagD=i,tagB=think fieldKey=fieldValue 1562020262 # Optimized line protocol example with tags sorted by key measurement,tagA=i,tagB=think,tagC=therefore,tagD=i,tagE=am fieldKey=fieldValue 1562020262 • Use the coarsest time precision possible: – InfluxDB writes data in nanosecond precision, however if your data isn’t collected in nanoseconds, there is no need to write at that precision. For better performance, use the coarsest precision possible for timestamps. You can specify the write precision when: • When using the SDK you can specify the WritePrecision when setting the time attribute of your point. For more information on InfluxDB client libraries, see the InfluxDB Documentation.
|
timestream-283
|
timestream.pdf
| 283 |
sort tags by key in lexicographic order. measurement,tagC=therefore,tagE=am,tagA=i,tagD=i,tagB=think fieldKey=fieldValue 1562020262 # Optimized line protocol example with tags sorted by key measurement,tagA=i,tagB=think,tagC=therefore,tagD=i,tagE=am fieldKey=fieldValue 1562020262 • Use the coarsest time precision possible: – InfluxDB writes data in nanosecond precision, however if your data isn’t collected in nanoseconds, there is no need to write at that precision. For better performance, use the coarsest precision possible for timestamps. You can specify the write precision when: • When using the SDK you can specify the WritePrecision when setting the time attribute of your point. For more information on InfluxDB client libraries, see the InfluxDB Documentation. Best practices for Timestream for InfluxDB 1205 Amazon Timestream Developer Guide • When using Telegraf, you configure the time precision in the Telegraf agent configuration. Precision is specified as an interval with an integer + unit (e.g. 0s,10ms,2us,4s). Valid time units are “ns”, “us”, “ms”, and “s”. [agent] interval ="10s" metric_batch_size="5000" precision = "0s" • Use gzip compression: – Use gzip compression to speed up writes to InfluxDB and reduce network bandwidth. Benchmarks have shown up to a 5x speed improvement when data is compressed. • When using Telegraf, in the Influxdb_v2 output plugin configuration in your telegraf.conf, set the content_encoding option to gzip: [[outputs.influxdb_v2]] urls = ["http://localhost:8086"] # ... content_encoding = "gzip" • When using client libraries, each InfluxDB client library provides options for compressing write requests or enforces compression by default. The method for enabling compression is different for each library. For specific instructions, see the InfluxDB Documentation • When using the InfluxDB API /api/v2/write endpoint to write data, compress the data with gzip and set the Content-Encoding header to gzip. Design for performance Design your schema for simpler and more performance queries. The following guidelines will ensure that your schema will be easy to query and maximize query performance: • Design to query: Choose measurements, tag keys, and field keys that are easy to query. To achieve this goal, follow these principles: • Use measurements that have a simple name and accurately describe the schema. • Avoid using the same name for a tag key and field key within the same schema. • Avoid using reserved Flux keywords and special characters in tag and field keys. • Tags store metadata that describe the fields and are common across many data points. Design for performance 1206 Amazon Timestream Developer Guide • Fields store unique or highly variable data, usually numeric data points. • Measurements and keys should not contain data, but used to either aggregate or describe data. Data will be stored in tag and field values. • Keep your time series cardinality under control High series cardinality is one of the main causes of decreased write and read performance in InfluxDB. In the context of InfluxDB high cardinality refers to the presence of a very large number of unique tag values. Tags values are indexed in InfluxDB which means that a very high number of unique values will generate a larger index which can slow down data ingestion and query performance. To better understand and resolve potential high cardinality related issues you can follow these steps: • Understand the causes of high cardinality • Measure the cardinality of your buckets • Take action to resolve high cardinality • Causes of high series cardinality InfluxDB indexes the data based on measurements and tags to speed up data reads. Each set of indexed data elements forms a series key. Tags containing highly variable information like unique IDs, hashes, and random strings lead to a large number of series, also known as high series cardinality. High series cardinality is the primary driver of high memory usage in InfluxDB. • Measuring series cardinality If you experience performance slowdowns or see an ever increasing memory usage in your Timestream for InfluxDB instance, we recommend measureing the series cardinality of your buckets. InfluxDB provides functions that allows you to measure series cardinality both in Flux and InfluxQL. • In Flux use the function influxdb.cardinality() • In FluxQL use the SHOW SERIES CARDINALITY command In both cases the engine will return the number of unique series keys in your data. Keep in mind that is it not recommended to have more than 10 million series keys on any of your Timestream for InfluxDB instances. • Causes of high series cardinality If you encounter that any of your buckets have high cardinality there are a few correcting steps you can take to fix it: • Review your tags: Ensure that your workloads don’t generate cases were tags have unique values for most entries. This could happen in cases where the number of unique tag values Design for performance 1207 Amazon Timestream Developer Guide always grows over time, or if log type messages are being written to the database where every message would have an unique
|
timestream-284
|
timestream.pdf
| 284 |
series keys on any of your Timestream for InfluxDB instances. • Causes of high series cardinality If you encounter that any of your buckets have high cardinality there are a few correcting steps you can take to fix it: • Review your tags: Ensure that your workloads don’t generate cases were tags have unique values for most entries. This could happen in cases where the number of unique tag values Design for performance 1207 Amazon Timestream Developer Guide always grows over time, or if log type messages are being written to the database where every message would have an unique combination of timestamp, tags etc. You can use the following Flux code to help you figure out which Tags are contributing most to your high cardinality issues: // Count unique values for each tag in a bucketimport "influxdata/influxdb/schema" cardinalityByTag = (bucket) => schema.tagKeys(bucket: bucket) |> map( fn: (r) => ({ tag: r._value, _value: if contains(set: ["_stop", "_start"], value: r._value) then 0 else (schema.tagValues(bucket: bucket, tag: r._value) |> count() |> findRecord(fn: (key) => true, idx: 0))._value, }), ) |> group(columns: ["tag"]) |> sum() cardinalityByTag(bucket: "amzn-s3-demo-bucket") If you’re experiencing very high cardinality, the query above may time out. If you experience a timeout, run the queries below – one at a time. Generate a list of tags: // Generate a list of tagsimport "influxdata/influxdb/schema" schema.tagKeys(bucket: "amzn-s3-demo-bucket") Count unique tag values for each tag: // Run the following for each tag to count the number of unique tag valuesimport "influxdata/influxdb/schema" tag = "example-tag-key" schema.tagValues(bucket: "amzn-s3-demo-bucket1", tag: tag) Design for performance 1208 Amazon Timestream |> count() Developer Guide We recommend that you run these at different points in time to identify which tag is growing faster. • Improve your schema: Follow the modeling recommendations discussed in our Security best practices for Timestream for InfluxDB. • Remove or aggregate older data to reduce cardinality: Consider whether or not your use cases needs all the data that is causing your high cardinality issues. If this data is not longer needed or accessed frequently you can aggregate it, delete it or export it to another engine such as Timestream for Live Analytics for long term storage and analysis. Troubleshooting Warning of "dev" version not recognized The warning 'WARN: Couldn't parse version "dev" reported by server, assuming latest backup/ restore APIs are supported' may be displayed during migration. This warning can be ignored. Migration failed during restoration stage In the event of a failed migration during the restoration stage, users can use the --retry- restore-dir flag to re-attempt the restoration. Use the --retry-restore-dir flag with a path to a previously backed-up directory to skip the backup stage and retry the restoration stage. The created backup directory used for a migration will be indicated if a migration fails during restoration. Possible reasons for a restore failing include: • Invalid InfluxDB destination token – A bucket existing in the destination instance with the same name as in the source instance. For individual bucket migrations use the --dest-bucket option to set a unique name for the migrated bucket • Connectivity failure, either with the source or destination hosts or with an optional S3 bucket. Troubleshooting 1209 Amazon Timestream Developer Guide Amazon Timestream for InfluxDB basic operational guidelines Following are basic operational guidelines that everyone should follow when working with Amazon Timestream for InfluxDB. Note that the Amazon Timestream for InfluxDB Service Level Agreement requires that you follow these guidelines: • Use metrics to monitor your memory, CPU, and storage usage. You can set up Amazon CloudWatch to notify you when usage patterns change or when you approach the capacity of your deployment. This way, you can maintain system performance and availability. • Scale up your DB instance when you are approaching storage capacity limits. You should have some buffer in storage and memory to accommodate unforeseen increases in demand from your applications. Keep in mind that at this time, you will need to create a new instance and migrate your data to achieve this. • If your database workload requires more I/O than you have provisioned, recovery after a failover or database failure will be slow. To increase the I/O capacity of a DB instance, do any or all of the following: • Migrate to a different DB instance with higher I/O capacity. • If you are already using Influx IOPS Included storage storage, provision a storage type with higher IOPS Included. • If your client application is caching the Domain Name Service (DNS) data of your DB instances, set a time-to-live (TTL) value of less than 30 seconds. The underlying IP address of a DB instance can change after a failover. Caching the DNS data for an extended time can thus lead to connection failures. Your application might try to connect to an IP address that's no longer in service.
|
timestream-285
|
timestream.pdf
| 285 |
following: • Migrate to a different DB instance with higher I/O capacity. • If you are already using Influx IOPS Included storage storage, provision a storage type with higher IOPS Included. • If your client application is caching the Domain Name Service (DNS) data of your DB instances, set a time-to-live (TTL) value of less than 30 seconds. The underlying IP address of a DB instance can change after a failover. Caching the DNS data for an extended time can thus lead to connection failures. Your application might try to connect to an IP address that's no longer in service. DB instance RAM recommendations An Amazon Timestream for InfluxDB performance best practice is to allocate enough RAM so that your working set resides almost completely in memory. The working set is the data and indexes that are frequently in use on your instance. The more you use the DB instance, the more the working set will grow. Amazon Timestream for InfluxDB basic operational guidelines 1210 Amazon Timestream Developer Guide Security in Timestream for InfluxDB Cloud security at AWS is the highest priority. As an AWS customer, you benefit from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. The effectiveness of our security is regularly tested and verified by third-party auditors as part of the AWS compliance programs. To learn about the compliance programs that apply to Timestream for InfluxDB, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your organization's requirements, and applicable laws and regulations. This documentation will help you understand how to apply the shared responsibility model when using Timestream for InfluxDB. The following topics show you how to configure Timestream for InfluxDB to meet your security and compliance objectives. You'll also learn how to use other AWS services that can help you to monitor and secure your Timestream for InfluxDB resources. Topics • Overview • Database authentication with Amazon Timestream for InfluxDB • How Amazon Timestream for InfluxDB uses secrets • Data protection in Timestream for InfluxDB • Identity and Access Management for Amazon Timestream for InfluxDB • Logging and monitoring in Timestream for InfluxDB • Compliance validation for Amazon Timestream for InfluxDB • Resilience in Amazon Timestream for InfluxDB • Infrastructure security in Amazon Timestream for InfluxDB • Configuration and vulnerability analysis in Timestream for InfluxDB Security 1211 Amazon Timestream Developer Guide • Incident response in Timestream for InfluxDB • Amazon Timestream for InfluxDB API and interface VPC endpoints (AWS PrivateLink) • Security best practices for Timestream for InfluxDB Overview This documentation helps you understand how to apply the shared responsibility model when using Amazon Timestream for InfluxDB. The following topics show you how to configure Amazon Timestream for InfluxDB to meet your security and compliance objectives. You also learn how to use other AWS services that help you monitor and secure your Amazon Timestream for InfluxDB resources. You can manage access to your Amazon Timestream for InfluxDB resources and your databases on a DB instance. The method you use to manage access depends on what type of task the user needs to perform with Amazon Timestream for InfluxDB: • Run your DB instance in a Virtual Private Cloud (VPC) based on the Amazon VPC service for network access control. • Use AWS Identity and Access Management (IAM) policies to assign permissions that determine who is allowed to manage Amazon Timestream for InfluxDB resources. For example, you can use IAM to determine who is allowed to create, describe, modify, and delete DB instances, tag resources, or modify security groups. • Use security groups to control what IP addresses or Amazon EC2 instances can connect to your databases on a DB instance. When you first create a DB instance, it's only accessible through rules specified by an associated security group. • Use Secure Socket Layer (SSL) or Transport Layer Security (TLS) connections with your DB instances. • Use the security features of your InfluxDB engine to control who can log in to the databases on a DB instance. These features work just as if the database was on your local network. For more information, see Security in Timestream for InfluxDB. Note You have to configure security only for your use cases. You don't have to configure security access for processes that
|
timestream-286
|
timestream.pdf
| 286 |
instance. When you first create a DB instance, it's only accessible through rules specified by an associated security group. • Use Secure Socket Layer (SSL) or Transport Layer Security (TLS) connections with your DB instances. • Use the security features of your InfluxDB engine to control who can log in to the databases on a DB instance. These features work just as if the database was on your local network. For more information, see Security in Timestream for InfluxDB. Note You have to configure security only for your use cases. You don't have to configure security access for processes that Amazon Timestream for InfluxDB manages. These include creating Overview 1212 Amazon Timestream Developer Guide backups, replicating data between a primary DB instance and a read replica, and other processes. Topics • General security General security Topics • Permissions • Network access • Dependencies • S3 buckets Permissions InfluxDB users should be granted least-privilege permissions. Only tokens granted to specific users, instead of operator tokens, should be used during migration. Timestream for InfluxDB uses IAM permissions to control user permissions. We recommend users be granted access to the specific actions and resources that they require. For more information, see Grant least privilege access. Network access The Influx migration script can function locally, migrating data between two InfluxDB instances on the same system, but it is assumed that the primary use case for migrations will be migrating data across the network, either a local or public network. With this comes security considerations. The Influx migration script will, by default, verify TLS certificates for instances with TLS enabled: we recommend that users enable TLS in their InfluxDB instances and do not use the --skip-verify option for the script. We recommend you use an allow-list to restrict network traffic to be from sources you are expecting. You can do this by limiting network traffic to the InfluxDB instances only from known IPs. Overview 1213 Amazon Timestream Dependencies Developer Guide The latest major versions of all dependencies should be used, including Influx CLI, InfluxDB, Python, the Requests module, and optional dependencies such as mountpoint-s3 and rclone. S3 buckets If S3 buckets are used as a temporary storage for migration, we recommend enabling TLS, versioning, and disabling public access. Using S3 buckets for migration 1. Open the AWS Management Console, navigate to Amazon Simple Storage Service and then choose Buckets. 2. Choose the bucket you wish to use. 3. Choose the Permissions tab. 4. Under Block public access (bucket settings), choose Edit. 5. Check Block all public access. 6. Choose Save changes. 7. Under Bucket policy, choose Edit. 8. Enter the following, replacing <example-bucket> with your bucket name, to enforce the use of TLS version 1.2 or later for connections: { "Version": "2012-10-17", "Statement": [ { "Sid": "EnforceTLSv12orHigher", "Principal": { "AWS": "*" }, "Action": [ "s3:*" ], "Effect": "Deny", "Resource": [ "arn:aws:s3:::<example bucket>/*", "arn:aws:s3:::<example bucket>" ], "Condition": { Overview 1214 Amazon Timestream Developer Guide "NumericLessThan": { "s3:TlsVersion": 1.2 } } } ] } 9. Choose Save changes. 10. Choose the Properties tab. 11. Under Bucket Versioning, choose Edit. 12. Check Enable. 13. Choose Save changes. For information about Amazon S3 bucket best security practices, see Security best practices for Amazon Simple Storage Service. Database authentication with Amazon Timestream for InfluxDB Amazon Timestream for InfluxDB supports two ways to authenticate database users. Password and access Token database authentication use different methods of authenticating to the database. Therefore, a specific user can log in to a database using only one authentication method. In both cases InfluxDB performs all administration of user accounts and API tokens. Password authentication During the InfluxDB DB instance creation process, you created an organization, user and password. The user has permissions to manage everything in your Timestream for InfluxDB DB instance. With this username and password combination you will be able to LogIn into your instance using the InfluxUI and also use the InfluxCLI to generate an operator token. An operator token is required to create users, delete buckets , organizations etc. For more information, see Database authentication options. API tokens InfluxDB API tokens ensure secure interaction between InfluxDB and external tools such as clients or applications. An API token belongs to a specific user and identifies InfluxDB permissions within the user’s organization. Database authentication with Amazon Timestream for InfluxDB 1215 Amazon Timestream Developer Guide There are three types of API tokens in InfluxDB: • Operator Token: Grants full read and write access to all organizations and all organization resources in InfluxDB OSS 2.x. Some operations, for example, retrieving the server configuration, require operator permissions. To create an operator token manually with the InfluxDB UI, api/ v2 API, or Influx CLI after the setup process is completed, you must use an existing operator token or your username and password. To create a new operator
|
timestream-287
|
timestream.pdf
| 287 |
user and identifies InfluxDB permissions within the user’s organization. Database authentication with Amazon Timestream for InfluxDB 1215 Amazon Timestream Developer Guide There are three types of API tokens in InfluxDB: • Operator Token: Grants full read and write access to all organizations and all organization resources in InfluxDB OSS 2.x. Some operations, for example, retrieving the server configuration, require operator permissions. To create an operator token manually with the InfluxDB UI, api/ v2 API, or Influx CLI after the setup process is completed, you must use an existing operator token or your username and password. To create a new operator token without using an existing one, see the influxd recovery auth CLI. Important Because operator tokens have full read and write access to all organizations in the database, we recommend creating an All-Access token for each organization and using those to manage InfluxDB. This helps to prevent accidental interactions across organizations. • All-Access API Token: Grants full read and write access to all resources in an organization. • Read/Write Tokens: Grants read access, write access, or both to specific buckets in an organization. All InfluxDb tokens are long lived tokens with no set expiration date, so it is not recommended to use your operator or all access tokens to sent monitoring data from your clients or Telegraf agents neither to embed them in your dashboarding applications. For these applications create read/write tokens with just the necessary permissions to get the job done. Fo more information on how to create influxDB token, see Create a token. Secrets InfluxDB operator tokens are generated on instance setup; other kinds of tokens, such as all-access and read/write tokens, can be created using the Influx CLI, Influx v2 API, or the Timestream for InfluxDB Multi-user rotation function. See Manage API tokens for how to generate, view, assign, and delete tokens. We recommend that you rotate Timestream for InfluxDB tokens often using AWS Secrets Manager and store tokens via environment variables. See Use Tokens for token usage in environment variables and Rotating the secret for how to rotate Timestream for InfluxDB users and tokens. See also: Database authentication with Amazon Timestream for InfluxDB 1216 Amazon Timestream Developer Guide • Infrastructure security in Amazon Timestream for InfluxDB • Security best practices for Timestream for InfluxDB How Amazon Timestream for InfluxDB uses secrets Timestream for InfluxDB supports username and password authentication through the user interface, and token credentials for least privilege client and application connections. Timestream for InfluxDB users have allAccess permissions within their organization while tokens can have any set of permissions. Following best practices for secure API token management, users should be created to manage tokens for fine-grain access within an organization. Additional information on admin best practices with Timestream for InfluxDB can be found in the Influxdata documentation. AWS Secrets Manager is a secret storage service that you can use to protect database credentials, API keys, and other secret information. Then in your code, you can replace hardcoded credentials with an API call to Secrets Manager. This helps ensure that the secret can't be compromised by someone examining your code, because the secret isn't there. For an overview of Secrets Manager, see What is AWS Secrets Manager. When you create a database instance, Timestream for InfluxDB automatically creates an admin secret for you to use with the multi-user rotation AWS Lambda function. In order to rotate Timestream for InfluxDB users and tokens, you must create a new secret by hand for each user or token you wish to rotate. Each secret can be configured to rotate on a schedule with the use of a Lambda function. The process to setup a new rotating secret consists of uploading the Lambda function code, configuring the Lambda role, defining the new secret, and configuring the secret rotation schedule. What's in the secret When you store Timestream for InfluxDB user credentials in the secret, use the following format. Single-user: { "engine": "<required: must be set to 'timestream-influxdb'>", "username": "<required: username>", "password": "<required: password>", "dbIdentifier": "<required: DB identifier>" } How Timestream for InfluxDB uses secrets 1217 Amazon Timestream Developer Guide When you create a Timestream for InfluxDB instance, an admin secret is automatically stored in Secrets Manager with credentials to be used with the multi-user Lambda function. Set the adminSecretArn to the Authentication Properties Secret Manager ARN value found on the DB instance summary page or to the ARN of an admin secret. To create a new admin secret you must already have the associated credentials and the credentials must have admin privileges. When you store Timestream for InfluxDB token credentials in the secret, use the following format. Multi-user: { "engine": "<required: must be set to 'timestream-influxdb'>", "org": "<required: organization to associate token with>", "adminSecretArn": "<required: ARN of the admin secret>", "type": "<required: allAccess or operator or custom>", "dbIdentifier": "<required:
|
timestream-288
|
timestream.pdf
| 288 |
be used with the multi-user Lambda function. Set the adminSecretArn to the Authentication Properties Secret Manager ARN value found on the DB instance summary page or to the ARN of an admin secret. To create a new admin secret you must already have the associated credentials and the credentials must have admin privileges. When you store Timestream for InfluxDB token credentials in the secret, use the following format. Multi-user: { "engine": "<required: must be set to 'timestream-influxdb'>", "org": "<required: organization to associate token with>", "adminSecretArn": "<required: ARN of the admin secret>", "type": "<required: allAccess or operator or custom>", "dbIdentifier": "<required: DB identifier>", "token": "<required unless generating a new token: token being rotated>", "writeBuckets": "<optional: list of bucketIDs for custom type token, must be input within plaintext panel, for example ['id1','id2']>", "readBuckets": "<optional: list of bucketIDs for custom type token, must be input within plaintext panel, for example ['id1','id2']>", "permissions": "<optional: list of permissions for custom type token, must be input within plaintext panel, for example ['write-tasks','read-tasks']>" } When you store Timestream for InfluxDB admin credentials in the secret, use the following format: Admin secret: { "engine": "<required: must be set to 'timestream-influxdb'>", "username": "<required: username>", "password": "<required: password>", "dbIdentifier": "<required: DB identifier>", "organization": "<optional: initial organization>", "bucket": "<optional: initial bucket>" } To turn on automatic rotation for the secret, the secret must be in the correct JSON structure. See Rotating the secret for how to rotate Timestream for InfluxDB secrets. How Timestream for InfluxDB uses secrets 1218 Amazon Timestream Modifying the secret Developer Guide The credentials generated during the Timestream for InfluxDB instance creation process are stored in a Secrets Manager secret in your account. The GetDbInstance response object contains an influxAuthParametersSecretArn which holds the Amazon Resource Name (ARN) to such secret. The secret will only be populated after your Timestream for InfluxDB instance is available. This is a READONLY copy as any updates/modifications/deletions to this secret doesn't impact the created DB instance. If you delete this secret, the API response will still refer to the deleted secret ARN. To create a new token in the Timestream for InfluxDB instance rather than store existing token credentials, you can create non-operator tokens by leaving the token value blank in the secret and using the multi-user rotation function with the AUTHENTICATION_CREATION_ENABLED Lambda environment variable set to true. If you create a new token, the permissions defined in the secret are assigned to the token and cannot be altered after the first successful rotation. For more information on rotating secrets, see Rotating AWS Secrets Manager Secrets. If a secret is deleted, the associated user or token in the Timestream for InfluxDB instance will not be deleted. Rotating the secret You use the Timestream for InfluxDB single- and multi-user rotation Lambda functions to rotate Timestream for InfluxDB user and token credentials. Use the single-user Lambda function to rotate user credentials for your Timestream for InfluxDB instance, and use the multi-user Lambda function to rotate token credentials for your Timestream for InfluxDB instance. Rotating users and tokens with the single- and multi-user Lambda functions is optional. Timestream for InfluxDB credentials never expire and any exposed credentials pose a risk for malicious actions against your DB instance. The advantage of rotating Timestream for InfluxDB credentials with Secrets Manager is an added security layer which limits the attack vector of exposed credentials to the window of time until the next rotation cycle. If no rotation mechanism is in place for your DB instance, any exposed credentials will be valid until they are manually deleted. You can configure Secrets Manager to automatically rotate secrets for you according to a schedule that you specify. This enables you to replace long-term secrets with short-term ones, which helps to significantly reduce the risk of compromise. For more information on rotating secrets with Secrets Manager, see Rotate AWS Secrets Manager Secrets. How Timestream for InfluxDB uses secrets 1219 Amazon Timestream Rotating users Developer Guide When you rotate users with the single-user Lambda function, a new random password will be assigned to the user after each rotation. For more information on how to enable automatic rotation, see Set up automatic rotation for non-database AWS Secrets Manager secrets. Rotating admin secrets To rotate an admin secret you use the single-user rotation function. You need to add the engine and dbIdentifier values to the secret since those values are not automatically populated on DB initialization. See What's in the secret for the complete secret template. To locate an admin secret for a Timestream for InfluxDB instance you use the admin secret ARN from the Timestream for InfluxDB instance summary page. It is recommended that you rotate all Timestream for InfluxDB admin secrets since admin users have elevated permissions for the Timestream for InfluxDB instance. Lambda rotation function You can rotate a Timestream for InfluxDB user
|
timestream-289
|
timestream.pdf
| 289 |
admin secret you use the single-user rotation function. You need to add the engine and dbIdentifier values to the secret since those values are not automatically populated on DB initialization. See What's in the secret for the complete secret template. To locate an admin secret for a Timestream for InfluxDB instance you use the admin secret ARN from the Timestream for InfluxDB instance summary page. It is recommended that you rotate all Timestream for InfluxDB admin secrets since admin users have elevated permissions for the Timestream for InfluxDB instance. Lambda rotation function You can rotate a Timestream for InfluxDB user with the single-user rotation function by using the What's in the secret with a new secret and adding the required fields for your Timestream for InfluxDB user. For more information on secret rotation Lambda functions, see Rotation by Lambda function. You can rotate a Timestream for InfluxDB user with the single-user rotation function by using the What's in the secret with a new secret and adding the required fields for your Timestream for InfluxDB user. For more information on secret rotation Lambda functions, see Rotation by Lambda function. The single user rotation function authenticates with the Timestream for InfluxDB DB instance using the credentials defined in the secret, then generates a new random password and sets the new password for the user. For more information on secret rotation Lambda functions, see Rotation by Lambda function. Lambda function execution role permissions Use the following IAM policy as the role for the single-user Lambda function. The policy gives the Lambda function the required permissions to perform a secret rotation for Timestream for InfluxDB users. How Timestream for InfluxDB uses secrets 1220 Amazon Timestream Developer Guide Replace all items listed below in the IAM policy with values from your AWS account: • {rotating_secret_arn} — The ARN for the secret being rotated can be found in the Secrets Manager secret details. • {db_instance_arn} — The Timestream for InfluxDB instance ARN can be found on the Timestream for InfluxDB instance summary page. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:DescribeSecret", "secretsmanager:GetSecretValue", "secretsmanager:PutSecretValue", "secretsmanager:UpdateSecretVersionStage" ], "Resource": "{rotating_secret_arn}" }, { "Effect": "Allow", "Action": [ "secretsmanager:GetRandomPassword" ], "Resource": "*" }, { "Action": [ "timestream-influxdb:GetDbInstance" ], "Resource": "{db_instance_arn}", "Effect": "Allow" } ] } Rotating tokens You can rotate a Timestream for InfluxDB token with the multi-user rotation function by using the What's in the secret with a new secret and adding the required fields for your Timestream How Timestream for InfluxDB uses secrets 1221 Amazon Timestream Developer Guide for InfluxDB token. For more information on secret rotation Lambda functions, see Rotation by Lambda function. You can rotate a Timestream for InfluxDB token by using the Timestream for InfluxDB multi-user Lambda function. Set the AUTHENTICATION_CREATION_ENABLED environment variable to true in the Lambda configuration to enable token creation. To create a new token, use the What's in the secret for your secret value. Omit the token key-value pair in the new secret and set the type to allAccess, or define the specific permissions and set the type to custom. The rotation function will create a new token during the first rotation cycle. You can't change the token permissions by editing the secret after rotation and any subsequent rotations will use the permissions that are set in the DB instance. Lambda rotation function The multi-user rotation function rotates token credentials by creating a new permission identical token using the admin credentials in the admin secret. The Lambda function validates the token value in the secret before creating the replacement token, storing the new token value in the secret, and deleting the old token. If the Lambda function is creating a new token it will first validate that the AUTHENTICATION_CREATION_ENABLED environment variable is set to true, that there is no token value in the secret, and that the token type is not type operator. Lambda function execution role permissions Use the following IAM policy as the role for the multi-user Lambda function. The policy gives the Lambda function the required permissions to perform a secret rotation for Timestream for InfluxDB tokens. Replace all items listed below in the IAM policy with values from your AWS account: • {rotating_secret_arn} — The ARN for the secret being rotated can be found in the Secrets Manager secret details. • {authentication_properties_admin_secret_arn} — The Timestream for InfluxDB admin secret ARN can be found on the Timestream for InfluxDB instance summary page. • {db_instance_arn} — The Timestream for InfluxDB instance ARN can be found on the Timestream for InfluxDB instance summary page. { "Version": "2012-10-17", How Timestream for InfluxDB uses secrets 1222 Amazon Timestream Developer Guide "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:DescribeSecret", "secretsmanager:GetSecretValue", "secretsmanager:PutSecretValue", "secretsmanager:UpdateSecretVersionStage" ], "Resource": "{rotating_secret_arn}" }, { "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": "{authentication_properties_admin_secret_arn}" }, { "Effect": "Allow", "Action": [
|
timestream-290
|
timestream.pdf
| 290 |
ARN for the secret being rotated can be found in the Secrets Manager secret details. • {authentication_properties_admin_secret_arn} — The Timestream for InfluxDB admin secret ARN can be found on the Timestream for InfluxDB instance summary page. • {db_instance_arn} — The Timestream for InfluxDB instance ARN can be found on the Timestream for InfluxDB instance summary page. { "Version": "2012-10-17", How Timestream for InfluxDB uses secrets 1222 Amazon Timestream Developer Guide "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:DescribeSecret", "secretsmanager:GetSecretValue", "secretsmanager:PutSecretValue", "secretsmanager:UpdateSecretVersionStage" ], "Resource": "{rotating_secret_arn}" }, { "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": "{authentication_properties_admin_secret_arn}" }, { "Effect": "Allow", "Action": [ "secretsmanager:GetRandomPassword" ], "Resource": "*" }, { "Action": [ "timestream-influxdb:GetDbInstance" ], "Resource": "{db_instance_arn}", "Effect": "Allow" } ] } Data protection in Timestream for InfluxDB The AWS shared responsibility model applies to data protection in Amazon Timestream for InfluxDB. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and management tasks for the AWS services that you use. For more information about data privacy, Data protection 1223 Amazon Timestream Developer Guide see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with Timestream for InfluxDB or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. For more detailed information on Timestream for InfluxDB data protection topics like Encryption at Rest and Key Management, select any of the available topics below. Topics • Encryption at rest • Encryption in transit Data protection 1224 Amazon Timestream Encryption at rest Developer Guide Timestream for InfluxDB encryption at rest provides enhanced security by encrypting all your data at rest using encryption keys stored in AWS Key Management Service (AWS KMS). This functionality helps reduce the operational burden and complexity involved in protecting sensitive data. With encryption at rest, you can build security-sensitive applications that meet strict encryption compliance and regulatory requirements. • Encryption is turned on by default on your Timestream for InfluxDB DB instance, and cannot be turned off. The industry standard AES-256 encryption algorithm is the default encryption algorithm used. • AWS KMS is used for encryption at rest in Timestream for InfluxDB. • You don't need to modify your DB instance client applications to use encryption. Encryption in transit All your Timestream for InfluxDB data is encrypted in transit. By default, all communications to and from Timestream for InfluxDB are protected by using Transport Layer Security (TLS) encryption. Traffic to and from Amazon Timestream for InfluxDB is secured using supported TLS versions 1.2 or 1.3. Identity and Access Management for Amazon Timestream for InfluxDB AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Timestream for InfluxDB resources. IAM is an AWS service that you can use with no additional charge. Topics • Authenticating with identities • Managing access using policies
|
timestream-291
|
timestream.pdf
| 291 |
Timestream for InfluxDB are protected by using Transport Layer Security (TLS) encryption. Traffic to and from Amazon Timestream for InfluxDB is secured using supported TLS versions 1.2 or 1.3. Identity and Access Management for Amazon Timestream for InfluxDB AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Timestream for InfluxDB resources. IAM is an AWS service that you can use with no additional charge. Topics • Authenticating with identities • Managing access using policies • How Amazon Timestream for InfluxDB works with IAM • Identity-based policy examples for Amazon Timestream for InfluxDB • Troubleshooting Amazon Timestream for InfluxDB identity and access Identity and Access Management 1225 Amazon Timestream Developer Guide • Controlling access to a DB instance in a VPC • Using service-linked roles for Amazon Timestream for InfluxDB • AWS managed policies for Amazon Timestream for InfluxDB • Connecting to Timestream for InfluxDB through a VPC endpoint Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating Identity and Access Management 1226 Amazon Timestream Developer Guide IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with
|
timestream-292
|
timestream.pdf
| 292 |
IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource Identity and Access Management 1227 Amazon Timestream Developer Guide (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their Identity and Access Management 1228 Amazon Timestream Developer Guide permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies
|
timestream-293
|
timestream.pdf
| 293 |
access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their Identity and Access Management 1228 Amazon Timestream Developer Guide permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Identity and Access Management 1229 Amazon Timestream Developer Guide Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are
|
timestream-294
|
timestream.pdf
| 294 |
– SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. Identity and Access Management 1230 Amazon Timestream Developer Guide • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon Timestream for InfluxDB works with IAM IAM features you can use with Amazon Timestream for InfluxDB IAM feature Timestream for InfluxDB support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys ACLs ABAC (tags in policies) Temporary credentials Principal permissions Service roles Service-linked roles Yes No Yes Yes No No Yes Yes Yes No Yes Identity and Access Management 1231 Amazon Timestream Developer Guide To get a high-level view of how Timestream for InfluxDB and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for Timestream for InfluxDB Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for Timestream for InfluxDB To view examples of Timestream for InfluxDB identity-based policies, see Identity-based policy examples for Amazon Timestream for InfluxDB. Resource-based policies within Timestream for InfluxDB Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access Identity and Access Management 1232 Amazon Timestream Developer Guide to a principal in the same account, no additional identity-based policy is required. For more
|
timestream-295
|
timestream.pdf
| 295 |
another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access Identity and Access Management 1232 Amazon Timestream Developer Guide to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for Timestream for InfluxDB Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of Timestream for InfluxDB actions, see Actions, resources and condition keys for Amazon Timestream for InfluxDB in the Service Authorization Reference. Policy actions in Timestream for InfluxDB use the following prefix before the action: timestream-influxdb To specify multiple actions in a single statement, separate them with commas. "Action": [ "timestream-influxdb:action1", "timestream-influxdb:action2" ] You can specify multiple actions using wildcards (*). For example, to specify all actions that begin with the word Describe, include the following action: "Action": "timestream-influxdb:Describe*" Policy resources for Timestream for InfluxDB Supports policy resources: Yes Identity and Access Management 1233 Amazon Timestream Developer Guide Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of Timestream for InfluxDB resource types and their ARNs, see Resource types defined by Amazon Timestream for InfluxDB in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions, resources and condition keys for Amazon Timestream for InfluxDB. Policy condition keys for Timestream for InfluxDB Supports service-specific policy condition keys: No Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. Identity and Access Management 1234 Amazon Timestream Developer Guide AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. Access control lists (ACLs) in Timestream for InfluxDB Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Attribute-based access control (ABAC) with Timestream for InfluxDB Supports ABAC (tags in policies): Yes Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called
|
timestream-296
|
timestream.pdf
| 296 |
service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. Access control lists (ACLs) in Timestream for InfluxDB Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Attribute-based access control (ABAC) with Timestream for InfluxDB Supports ABAC (tags in policies): Yes Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. For more information about ABAC, see Define permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using Temporary credentials with Timestream for InfluxDB Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. Identity and Access Management 1235 Amazon Timestream Developer Guide You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions for Timestream for InfluxDB Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for Timestream for InfluxDB Supports service roles: No A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break Timestream for InfluxDB functionality. Edit service roles only when Timestream for InfluxDB provides guidance to do so. Identity and Access Management 1236 Amazon Timestream Developer Guide Service-linked roles for Timestream for InfluxDB Supports service-linked roles: Yes A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. Identity-based policy examples for Amazon Timestream for InfluxDB By default, users and roles don't have permission to create or modify Timestream for InfluxDB resources. They also can't
|
timestream-297
|
timestream.pdf
| 297 |
action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. Identity-based policy examples for Amazon Timestream for InfluxDB By default, users and roles don't have permission to create or modify Timestream for InfluxDB resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types defined by Timestream for InfluxDB, including the format of the ARNs for each of the resource types, see Actions, resources, and condition Keys for Amazon Timestream for InfluxDB in the Service Authorization Reference. Topics • Policy best practices • Using the Timestream for InfluxDB console • Allow users to view their own permissions • Accessing one Amazon S3 bucket • Allowing all operations • Create, describe, delete and update a DB instance Identity and Access Management 1237 Amazon Timestream Policy best practices Developer Guide Identity-based policies determine whether someone can create, access, or delete Timestream for InfluxDB resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Identity and Access Management 1238 Amazon Timestream Developer Guide Using the Timestream for InfluxDB console To access the Amazon Timestream for InfluxDB console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the Timestream for InfluxDB resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API
|
timestream-298
|
timestream.pdf
| 298 |
console To access the Amazon Timestream for InfluxDB console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the Timestream for InfluxDB resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. To ensure that users and roles can still use the Timestream for InfluxDB console, also attach the Timestream for InfluxDB ConsoleAccess or ReadOnly AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", Identity and Access Management 1239 Amazon Timestream Developer Guide "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ] } Accessing one Amazon S3 bucket In this example, you want to grant an IAM user in your AWS account access to one of your Amazon S3 buckets, amzn-s3-demo-bucket. You also want to allow the user to add, update, and delete objects. In addition to granting the s3:PutObject, s3:GetObject, and s3:DeleteObject permissions to the user, the policy also grants the s3:ListAllMyBuckets, s3:GetBucketLocation, and s3:ListBucket permissions. These are the additional permissions required by the console. Also, the s3:PutObjectAcl and the s3:GetObjectAcl actions are required to be able to copy, cut, and paste objects in the console. For an example walkthrough that grants permissions to users and tests them using the console, see An example walkthrough: Using user policies to control access to your bucket. { "Version":"2012-10-17", "Statement":[ { "Sid":"ListBucketsInConsole", "Effect":"Allow", "Action":[ "s3:ListAllMyBuckets" ], "Resource":"arn:aws:s3:::*" }, { "Sid":"ViewSpecificBucketInfo", "Effect":"Allow", "Action":[ Identity and Access Management 1240 Amazon Timestream Developer Guide "s3:ListBucket", "s3:GetBucketLocation" ], "Resource":"arn:aws:s3:::amzn-s3-demo-bucket" }, { "Sid":"ManageBucketContents", "Effect":"Allow", "Action":[ "s3:PutObject", "s3:PutObjectAcl", "s3:GetObject", "s3:GetObjectAcl", "s3:DeleteObject" ], "Resource":"arn:aws:s3:::amzn-s3-demo-bucket/*" } ] } Allowing all operations The following is a sample policy that allows all operations in Timestream for InfluxDB. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "timestream-influxdb:*" ], "Resource": "*" } ] } Create, describe, delete and update a DB instance The following sample policy allows a user to create, describe, delete and update a DB instance sampleDB: { Identity and Access Management 1241 Amazon Timestream Developer Guide "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "timestream-influxdb:CreateDbInstance", "timestream-influxdb:GetDbInstance", "timestream-influxdb:DeleteDbInstance", "timestream-influxdb:UpdateDbInstance" ], "Resource": "arn:aws:timestream-influxdb:us-east-1:<account_ID>:dbinstance/ sampleDB" } ] } Troubleshooting Amazon Timestream for InfluxDB identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with Timestream for InfluxDB and IAM. Topics • I am not authorized to perform an action in Timestream for InfluxDB • I want to allow people outside of my AWS account to access my Timestream for InfluxDB resources I am not authorized to perform an action in Timestream for InfluxDB If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance. Your administrator is the person that provided you with your user name and password. The following example error occurs when the mateojackson user tries to use the console to view details about a fictional my-example-widget resource but does not have the fictional timestream-influxdb:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: timestream-influxdb:GetWidget on resource: my-example-widget Identity and Access Management 1242 Amazon Timestream Developer Guide In this case, Mateo asks his administrator to update his policies to allow him to access the my- example-widget resource using the timestream-influxdb:GetWidget action. I want to allow people outside of my AWS account to access my Timestream for InfluxDB resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • Controlling access to a DB instance in a VPC • To learn whether Timestream for InfluxDB supports these features, see How Amazon Timestream for InfluxDB works
|
timestream-299
|
timestream.pdf
| 299 |
outside of my AWS account to access my Timestream for InfluxDB resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • Controlling access to a DB instance in a VPC • To learn whether Timestream for InfluxDB supports these features, see How Amazon Timestream for InfluxDB works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see How IAM roles differ from resource-based policies in the IAM User Guide. Controlling access to a DB instance in a VPC Using Amazon Virtual Private Cloud (Amazon VPC), you can launch AWS resources, such as Amazon Timestream for InfluxDB DB instances, into a virtual private cloud (VPC). When you use Amazon VPC, you have control over your virtual networking environment. You can choose your own IP address range, create subnets, and configure routing and access control lists. A VPC security group controls access to DB instances inside a VPC. Each VPC security group rule enables a specific source to access a DB instance in a VPC that is associated with that VPC security group. The source can be a range of addresses (for example, 203.0.113.0/24), or another VPC security group. By specifying a VPC security group as the source, you allow incoming traffic from all instances (typically application servers) that use the source VPC security group. Before attempting Identity and Access Management 1243 Amazon Timestream Developer Guide to connect to your DB instance, configure your VPC for your use case. The following are common scenarios for accessing a DB instance in a VPC: A DB instance in a VPC accessed by an Amazon EC2 instance in the same VPC A common use of a DB instance in a VPC is to share data with an application server that is running in an EC2 instance in the same VPC. The EC2 instance might run a web server with an application that interacts with the DB instance. A DB instance in a VPC accessed by an EC2 instance in a different VPC In some cases, your DB instance is in a different VPC from the EC2 instance that you're using to access it. If so, you can use VPC peering to access the DB instance. A DB instance in a VPC accessed by a client application through the internet To access a DB instance in a VPC from a client application through the internet, you configure a VPC with a single public subnet and use the public subnets to create the DB instance. You also configure an internet gateway in the VPC to enable communication over the internet. To connect to a DB instance from outside of its VPC, the DB instance must be publicly accessible. Also, access must be granted using the inbound rules of the DB instance's security group, and other requirements must be met. For more information on VPC security groups, see Control traffic to your AWS resources using security groups in the Amazon Virtual Private Cloud User Guide. For details on how to connect to a Timestream for InfluxDB DB instance, see Connecting to an Amazon Timestream for InfluxDB DB instance. Security group scenario A common use of a DB instance in a VPC is to share data with an application server running in an Amazon EC2 instance in the same VPC, which is accessed by a client application outside the VPC. For this scenario, you use the Timestream for InfluxDB and VPC pages on the AWS Management Console or the Timestream for InfluxDB and EC2 API operations to create the necessary instances and security groups: 1. Create a VPC security group (for example, sg-0123ec2example) and define inbound rules that use the IP addresses of the client application as the source. This security group allows your client application to connect to EC2 instances in a VPC that uses this security group. Identity and Access Management 1244 Amazon Timestream Developer Guide 2. Create an EC2 instance for the application and add the EC2 instance
|
timestream-300
|
timestream.pdf
| 300 |
this scenario, you use the Timestream for InfluxDB and VPC pages on the AWS Management Console or the Timestream for InfluxDB and EC2 API operations to create the necessary instances and security groups: 1. Create a VPC security group (for example, sg-0123ec2example) and define inbound rules that use the IP addresses of the client application as the source. This security group allows your client application to connect to EC2 instances in a VPC that uses this security group. Identity and Access Management 1244 Amazon Timestream Developer Guide 2. Create an EC2 instance for the application and add the EC2 instance to the VPC security group (sg-0123ec2example) that you created in the previous step. 3. Create a second VPC security group (for example, sg-6789rdsexample) and create a new rule by specifying the VPC security group that you created in step 1 (sg-0123ec2example) as the source. 4. Create a new DB instance and add the DB instance to the VPC security group (sg-6789rdsexample) that you created in the previous step. When you create the DB, use the same port number as the one specified for the VPC security group (sg-6789rdsexample) rule that you created in step 3. Creating a VPC security group You can create a VPC security group for a DB instance by using the VPC console. For information about creating a security group, see Create a security group for your VPC in the Amazon Virtual Private Cloud User Guide. Associating a security group with a DB instance Once a Timestream for InfluxDB DB instance has been created, you will not be able to associate it to new security groups since changes to these configurations are not currently supported. Using service-linked roles for Amazon Timestream for InfluxDB Amazon Timestream for InfluxDB uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to an AWS service, such as Amazon Timestream for InfluxDB. Amazon Timestream for InfluxDB service-linked roles are predefined by Amazon Timestream for InfluxDB. They include all the permissions that the service requires to call AWS services on behalf of your dbinstances. A service-linked role makes setting up Amazon Timestream for InfluxDB easier because you don’t have to manually add the necessary permissions. The roles already exist within your AWS account but are linked to Amazon Timestream for InfluxDB use cases and have predefined permissions. Only Amazon Timestream for InfluxDB can assume these roles, and only these roles can use the predefined permissions policy. You can delete the roles only after first deleting their related resources. This protects your Amazon Timestream for InfluxDB resources because you can't inadvertently remove necessary permissions to access the resources. Identity and Access Management 1245 Amazon Timestream Developer Guide For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-Linked Role column. Choose a Yes with a link to view the service-linked role documentation for that service. Contents • Service-Linked Role Permissions for Amazon Timestream for InfluxDB • Creating a Service-Linked Role (IAM) • Editing the Description of a Service-Linked Role for Amazon Timestream for InfluxDB • Editing a Service-Linked Role Description (IAM Console) • Editing a Service-Linked Role Description (IAM CLI) • Editing a Service-Linked Role Description (IAM API) • Deleting a Service-Linked Role for Amazon Timestream for InfluxDB • Cleaning Up a Service-Linked Role • Deleting a Service-Linked Role (IAM Console) • Deleting a Service-Linked Role (IAM CLI) • Deleting a Service-Linked Role (IAM API) • Supported Regions for Amazon Timestream for InfluxDB Service-Linked Roles Service-Linked Role Permissions for Amazon Timestream for InfluxDB Amazon Timestream for InfluxDB uses the service-linked role named AmazonTimestreamInfluxDBServiceRolePolicy – This policy allows Timestream for InfluxDB to manage AWS resources on your behalf as necessary for managing your clusters. The AmazonTimestreamInfluxDBServiceRolePolicy service-linked role permissions policy allows Amazon Timestream for InfluxDB to complete the following actions on the specified resources: { "Version": "2012-10-17", "Statement": [ { "Sid": "DescribeNetworkStatement", "Effect": "Allow", "Action": [ "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:DescribeNetworkInterfaces" Identity and Access Management 1246 Developer Guide Amazon Timestream ], "Resource": "*" }, { "Sid": "CreateEniInSubnetStatement", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInterface" ], "Resource": [ "arn:aws:ec2:*:*:subnet/*", "arn:aws:ec2:*:*:security-group/*" ] }, { "Sid": "CreateEniStatement", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInterface" ], "Resource": "arn:aws:ec2:*:*:network-interface/*", "Condition": { "Null": { "aws:RequestTag/AmazonTimestreamInfluxDBManaged": "false" } } }, { "Sid": "CreateTagWithEniStatement", "Effect": "Allow", "Action": [ "ec2:CreateTags" ], "Resource": "arn:aws:ec2:*:*:network-interface/*", "Condition": { "Null": { "aws:RequestTag/AmazonTimestreamInfluxDBManaged": "false" }, "StringEquals": { "ec2:CreateAction": [ "CreateNetworkInterface" ] } } Identity and Access Management 1247 Developer Guide Amazon Timestream }, { "Sid": "ManageEniStatement", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInterfacePermission", "ec2:DeleteNetworkInterface" ], "Resource": "arn:aws:ec2:*:*:network-interface/*", "Condition": { "Null": { "aws:ResourceTag/AmazonTimestreamInfluxDBManaged": "false" } } }, { "Sid": "PutCloudWatchMetricsStatement", "Effect": "Allow", "Action": [ "cloudwatch:PutMetricData" ], "Condition": { "StringEquals": { "cloudwatch:namespace": [ "AWS/Timestream/InfluxDB", "AWS/Usage" ] } }, "Resource": [
|
timestream-301
|
timestream.pdf
| 301 |
}, { "Sid": "CreateEniStatement", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInterface" ], "Resource": "arn:aws:ec2:*:*:network-interface/*", "Condition": { "Null": { "aws:RequestTag/AmazonTimestreamInfluxDBManaged": "false" } } }, { "Sid": "CreateTagWithEniStatement", "Effect": "Allow", "Action": [ "ec2:CreateTags" ], "Resource": "arn:aws:ec2:*:*:network-interface/*", "Condition": { "Null": { "aws:RequestTag/AmazonTimestreamInfluxDBManaged": "false" }, "StringEquals": { "ec2:CreateAction": [ "CreateNetworkInterface" ] } } Identity and Access Management 1247 Developer Guide Amazon Timestream }, { "Sid": "ManageEniStatement", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInterfacePermission", "ec2:DeleteNetworkInterface" ], "Resource": "arn:aws:ec2:*:*:network-interface/*", "Condition": { "Null": { "aws:ResourceTag/AmazonTimestreamInfluxDBManaged": "false" } } }, { "Sid": "PutCloudWatchMetricsStatement", "Effect": "Allow", "Action": [ "cloudwatch:PutMetricData" ], "Condition": { "StringEquals": { "cloudwatch:namespace": [ "AWS/Timestream/InfluxDB", "AWS/Usage" ] } }, "Resource": [ "*" ] }, { "Sid": "ManageSecretStatement", "Effect": "Allow", "Action": [ "secretsmanager:CreateSecret", "secretsmanager:DeleteSecret" ], "Resource": [ "arn:aws:secretsmanager:*:*:secret:READONLY-InfluxDB-auth-parameters-*" ], "Condition": { Identity and Access Management 1248 Amazon Timestream "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } Developer Guide } } ] } To allow an IAM entity to create AmazonTimestreamInfluxDBServiceRolePolicy service-linked roles Add the following policy statement to the permissions for that IAM entity: { "Effect": "Allow", "Action": [ "iam:CreateServiceLinkedRole", "iam:PutRolePolicy" ], "Resource": "arn:aws:iam::*:role/aws-service-role/ timestreamforinfluxdb.amazonaws.com/AmazonTimestreamInfluxDBServiceRolePolicy*", "Condition": {"StringLike": {"iam:AWSServiceName": "timestreamforinfluxdb.amazonaws.com"}} } To allow an IAM entity to delete AmazonTimestreamInfluxDBServiceRolePolicy service-linked roles Add the following policy statement to the permissions for that IAM entity: { "Effect": "Allow", "Action": [ "iam:DeleteServiceLinkedRole", "iam:GetServiceLinkedRoleDeletionStatus" ], "Resource": "arn:aws:iam::*:role/aws-service-role/ timestreamforinfluxdb.amazonaws.com/AmazonTimestreamInfluxDBServiceRolePolicy*", "Condition": {"StringLike": {"iam:AWSServiceName": "timestreamforinfluxdb.amazonaws.com"}} } Identity and Access Management 1249 Amazon Timestream Developer Guide Alternatively, you can use an AWS managed policy to provide full access to Amazon Timestream for InfluxDB. Creating a Service-Linked Role (IAM) You don't need to manually create a service-linked role. When you create a DB instance, Amazon Timestream for InfluxDB creates the service-linked role for you. If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you create a DB instance, Amazon Timestream for InfluxDB creates the service-linked role for you again. Editing the Description of a Service-Linked Role for Amazon Timestream for InfluxDB Amazon Timestream for InfluxDB does not allow you to edit the AmazonTimestreamInfluxDBServiceRolePolicy service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. Editing a Service-Linked Role Description (IAM Console) You can use the IAM console to edit a service-linked role description. To edit the description of a service-linked role (console) 1. In the left navigation pane of the IAM console, choose Roles. 2. Choose the name of the role to modify. 3. 4. To the far right of Role description, choose Edit. Enter a new description in the box and choose Save. Editing a Service-Linked Role Description (IAM CLI) You can use IAM operations from the AWS Command Line Interface to edit a service-linked role description. To change the description of a service-linked role (CLI) 1. (Optional) To view the current description for a role, use the AWS CLI for IAM operation get- role. Identity and Access Management 1250 Amazon Timestream Example Developer Guide $ aws iam get-role --role-name AmazonTimestreamInfluxDBServiceRolePolicy Use the role name, not the ARN, to refer to roles with the CLI operations. For example, if a role has the following ARN: arn:aws:iam::123456789012:role/myrole, refer to the role as myrole. 2. To update a service-linked role's description, use the AWS CLI for IAM operation update- role-description. Linux and MacOS $ aws iam update-role-description \ --role-name AmazonTimestreamInfluxDBServiceRolePolicy \ --description "new description" Windows $ aws iam update-role-description ^ --role-name AmazonTimestreamInfluxDBServiceRolePolicy ^ --description "new description" Editing a Service-Linked Role Description (IAM API) You can use the IAM API to edit a service-linked role description. To change the description of a service-linked role (API) 1. (Optional) To view the current description for a role, use the IAM API operation GetRole. Example https://iam.amazonaws.com/ ?Action=GetRole &RoleName=AmazonTimestreamInfluxDBServiceRolePolicy &Version=2010-05-08 &AUTHPARAMS 2. To update a role's description, use the IAM API operation UpdateRoleDescription. Identity and Access Management 1251 Amazon Timestream Example Developer Guide https://iam.amazonaws.com/ ?Action=UpdateRoleDescription &RoleName=AmazonTimestreamInfluxDBServiceRolePolicy &Version=2010-05-08 &Description="New description" Deleting a Service-Linked Role for Amazon Timestream for InfluxDB If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up your service-linked role before you can delete it. Amazon Timestream for InfluxDB does not delete the service-linked role for you. Cleaning Up a Service-Linked Role Before you can use IAM to delete a service-linked role, first confirm that the role has no resources (clusters) associated with it. To check whether the service-linked role has an active session in the IAM console 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. 2. In the left navigation pane of the IAM console, choose Roles.
|
timestream-302
|
timestream.pdf
| 302 |
is not actively monitored or maintained. However, you must clean up your service-linked role before you can delete it. Amazon Timestream for InfluxDB does not delete the service-linked role for you. Cleaning Up a Service-Linked Role Before you can use IAM to delete a service-linked role, first confirm that the role has no resources (clusters) associated with it. To check whether the service-linked role has an active session in the IAM console 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. 2. In the left navigation pane of the IAM console, choose Roles. Then choose the name (not the check box) of the AmazonTimestreamInfluxDBServiceRolePolicy role. 3. On the Summary page for the selected role, choose the Access Advisor tab. 4. On the Access Advisor tab, review recent activity for the service-linked role. Deleting a Service-Linked Role (IAM Console) You can use the IAM console to delete a service-linked role. To delete a service-linked role (console) 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. Identity and Access Management 1252 Amazon Timestream Developer Guide 2. 3. 4. In the left navigation pane of the IAM console, choose Roles. Then select the check box next to the role name that you want to delete, not the name or row itself. For Role actions at the top of the page, choose Delete role. In the confirmation page, review the service last accessed data, which shows when each of the selected roles last accessed an AWS service. This helps you to confirm whether the role is currently active. If you want to proceed, choose Yes, Delete to submit the service-linked role for deletion. 5. Watch the IAM console notifications to monitor the progress of the service-linked role deletion. Because the IAM service-linked role deletion is asynchronous, after you submit the role for deletion, the deletion task can succeed or fail. If the task fails, you can choose View details or View Resources from the notifications to learn why the deletion failed. Deleting a Service-Linked Role (IAM CLI) You can use IAM operations from the AWS Command Line Interface to delete a service-linked role. To delete a service-linked role (CLI) 1. If you don't know the name of the service-linked role that you want to delete, enter the following command. This command lists the roles and their Amazon Resource Names (ARNs) in your account. $ aws iam get-role --role-name role-name Use the role name, not the ARN, to refer to roles with the CLI operations. For example, if a role has the ARN arn:aws:iam::123456789012:role/myrole, you refer to the role as myrole. 2. Because a service-linked role cannot be deleted if it is being used or has associated resources, you must submit a deletion request with the delete-service-linked-role command. That request can be denied if these conditions are not met. You must capture the deletion-task-id from the response to check the status of the deletion task. Enter the following to submit a service- linked role deletion request. $ aws iam delete-service-linked-role --role-name role-name 3. Run the get-service-linked-role-deletion-status command to check the status of the deletion task. Identity and Access Management 1253 Amazon Timestream Developer Guide $ aws iam get-service-linked-role-deletion-status --deletion-task-id deletion-task- id The status of the deletion task can be NOT_STARTED, IN_PROGRESS, SUCCEEDED, or FAILED. If the deletion fails, the call returns the reason that it failed so that you can troubleshoot. Deleting a Service-Linked Role (IAM API) You can use the IAM API to delete a service-linked role. To delete a service-linked role (API) 1. To submit a deletion request for a service-linked roll, call DeleteServiceLinkedRole. In the request, specify a role name. Because a service-linked role cannot be deleted if it is being used or has associated resources, you must submit a deletion request. That request can be denied if these conditions are not met. You must capture the DeletionTaskId from the response to check the status of the deletion task. 2. To check the status of the deletion, call GetServiceLinkedRoleDeletionStatus. In the request, specify the DeletionTaskId. The status of the deletion task can be NOT_STARTED, IN_PROGRESS, SUCCEEDED, or FAILED. If the deletion fails, the call returns the reason that it failed so that you can troubleshoot. Supported Regions for Amazon Timestream for InfluxDB Service-Linked Roles Amazon Timestream for InfluxDB supports using service-linked roles in all of the Regions where the service is available. For more information, see AWS service endpoints. AWS managed policies for Amazon Timestream for InfluxDB To add permissions to users, groups, and roles, it is easier to use AWS managed policies than to write policies yourself. It takes time and expertise to create IAM customer managed policies that provide your team with only the permissions they need. To get started quickly, you can use our Identity
|
timestream-303
|
timestream.pdf
| 303 |
it failed so that you can troubleshoot. Supported Regions for Amazon Timestream for InfluxDB Service-Linked Roles Amazon Timestream for InfluxDB supports using service-linked roles in all of the Regions where the service is available. For more information, see AWS service endpoints. AWS managed policies for Amazon Timestream for InfluxDB To add permissions to users, groups, and roles, it is easier to use AWS managed policies than to write policies yourself. It takes time and expertise to create IAM customer managed policies that provide your team with only the permissions they need. To get started quickly, you can use our Identity and Access Management 1254 Amazon Timestream Developer Guide AWS managed policies. These policies cover common use cases and are available in your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. AWS services maintain and update AWS managed policies. You can't change the permissions in AWS managed policies. Services occasionally add additional permissions to an AWS managed policy to support new features. This type of update affects all identities (users, groups, and roles) where the policy is attached. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services do not remove permissions from an AWS managed policy, so policy updates won't break your existing permissions. Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For a list and descriptions of job function policies, see AWS managed policies for job functions in the IAM User Guide. AWS managed policy: AmazonTimestreamInfluxDBServiceRolePolicy You cannot attach the AmazonTimestreamInfluxDBServiceRolePolicy AWS managed policy to identities in your account. This policy is part of the AWS TimestreamforInfluxDB service-linked role. This role allows the service to manage network interfaces and security groups in your account. Timestream for InfluxDB uses the permissions in this policy to manage EC2 security groups and network interfaces. This is required to manage Timestream for InfluxDB DB instances. To review this policy in JSON format, see AmazonTimestreamInfluxDBServiceRolePolicy. AWS-managed policies for Amazon Timestream for InfluxDB AWS addresses many common use cases by providing standalone IAM policies that are created and administered by AWS. Managed policies grant necessary permissions for common use cases so Identity and Access Management 1255 Amazon Timestream Developer Guide you can avoid having to investigate what permissions are needed. For more information, see AWS Managed Policies in the IAM User Guide. The following AWS managed policies, which you can attach to users in your account, are specific to Timestream for InfluxDB: AmazonTimestreamInfluxDBFullAccess You can attach the AmazonTimestreamInfluxDBFullAccess policy to your IAM identities. This policy grants administrative permissions that allow full access to all Timestream for InfluxDB resources. You can also create your own custom IAM policies to allow permissions for Amazon Timestream for InfluxDB API actions. You can attach these custom policies to the IAM users or groups that require those permissions. To review this policy in JSON format, see AmazonTimestreamInfluxDBFullAccess. AmazonTimestreamInfluxDBFullAccessWithoutMarketplaceAccess You can attach the AmazonTimestreamInfluxDBFullAccessWithoutMarketplaceAccess policy to your IAM identities. This policy grants administrative permissions that allow full access to all Timestream for InfluxDB resources, excluding any marketplace-related actions. You can also create your own custom IAM policies to allow permissions for Timestream for InfluxDB API actions. You can attach these custom policies to the IAM users or groups that require those permissions. To review this policy in JSON format, see AmazonTimestreamInfluxDBFullAccessWithoutMarketplaceAccess. Timestream for InfluxDB updates to AWS managed policies View details about updates to AWS managed policies for Timestream for InfluxDB since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the Timestream for InfluxDB Document history page. Identity and Access Management 1256 Amazon Timestream Developer Guide Change Description Date AmazonTimestreamIn fluxDBFullAccess – Update to Amazon Timestream for InfluxDB updated the 4/16/2025 an existing policy existing managed policy AmazonTimestreamIn fluxDBFullAccess adds necessary permissions that to access Marketplace APIs for managing subscription required for creating and updating Timestream for InfluxDB cluster resources. AmazonTimestreamIn fluxDBFullAccessWithoutMark Amazon Timestream for InfluxDB added a new policy 04/16/2025 etplaceAccess – New policy to provide administrative access to manage Amazon Timestream for InfluxDB instances and parameter groups except marketplace operations. AmazonTimestreamIn fluxDBFullAccess – Update to Amazon Timestream for InfluxDB updated the existing 2/17/2025 an existing policy managed policy AmazonTim estreamInfluxDBFul lAccess to also provide full administrative access to create, update, delete, and list Amazon Timestream InfluxDB clusters. AmazonTimestreamIn fluxDBFullAccess – Update to an existing policy Added the ec2:Descr ibeRouteTables action to the existing AmazonTim 10/08/2024 estreamInfluxDBFul Identity and Access Management 1257 Amazon Timestream Developer Guide Change Description Date
|
timestream-304
|
timestream.pdf
| 304 |
AmazonTimestreamIn fluxDBFullAccessWithoutMark Amazon Timestream for InfluxDB added a new policy 04/16/2025 etplaceAccess – New policy to provide administrative access to manage Amazon Timestream for InfluxDB instances and parameter groups except marketplace operations. AmazonTimestreamIn fluxDBFullAccess – Update to Amazon Timestream for InfluxDB updated the existing 2/17/2025 an existing policy managed policy AmazonTim estreamInfluxDBFul lAccess to also provide full administrative access to create, update, delete, and list Amazon Timestream InfluxDB clusters. AmazonTimestreamIn fluxDBFullAccess – Update to an existing policy Added the ec2:Descr ibeRouteTables action to the existing AmazonTim 10/08/2024 estreamInfluxDBFul Identity and Access Management 1257 Amazon Timestream Developer Guide Change Description Date lAccess managed policy. This action is used for describing your route tables AWS managed policy: AmazonTimestreamIn Amazon Timestream for InfluxDB added a new policy 03/14/2024 fluxDBServiceRolePolicy – that allows the service to New policy manage network interfaces and security groups in your account. AmazonTimestreamIn fluxDBFullAccess – New policy Amazon Timestream for InfluxDB added a new policy 03/14/2024 to provide full administr ative access to create, update, delete and list Amazon Timestream InfluxDB instances and create and list parameter groups. Connecting to Timestream for InfluxDB through a VPC endpoint You can connect directly to Timestream for InfluxDB through a private interface endpoint in your virtual private cloud (VPC). When you use an interface VPC endpoint, communication between your VPC and Timestream for InfluxDB is conducted entirely within the AWS network. Timestream for InfluxDB supports Amazon Virtual Private Cloud (Amazon VPC) endpoints powered by AWS PrivateLink. Each VPC endpoint is represented by one or more Elastic Network Interfaces (ENIs) with private IP addresses in your VPC subnets. The interface VPC endpoint connects your VPC directly to Timestream for InfluxDB without an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. The instances in your VPC do not need public IP addresses to communicate with Timestream for InfluxDB. Regions Identity and Access Management 1258 Amazon Timestream Developer Guide Timestream for InfluxDB supports VPC endpoints and VPC endpoint policies in all AWS Regions in which Timestream for InfluxDB is supported. Topics • Considerations for Timestream for InfluxDB VPC endpoints • Creating a VPC endpoint for Timestream for InfluxDB • Connecting to an Timestream for InfluxDB VPC endpoint • Controlling access to a VPC endpoint • Using a VPC endpoint in a policy statement • Logging your VPC endpoint Considerations for Timestream for InfluxDB VPC endpoints Before you set up an interface VPC endpoint for Timestream for InfluxDB, review the Interface endpoint properties and limitations topic in the AWS PrivateLink Guide. Timestream for InfluxDB support for a VPC endpoint includes the following. • You can use your VPC endpoint to call all Timestream for InfluxDB API operations from your VPC. • You can use AWS CloudTrail logs to audit your use of Timestream for InfluxDB resources through the VPC endpoint. For details, see Logging your VPC endpoint. Creating a VPC endpoint for Timestream for InfluxDB You can create a VPC endpoint for Timestream for InfluxDB by using the Amazon VPC console or the Amazon VPC API. For more information, see Create an interface endpoint in the AWS PrivateLink Guide. • To create a VPC endpoint for Timestream for InfluxDB, use the following service name: com.amazonaws.region.timestream-influxdb For example, in the US West (Oregon) Region (us-west-2), the service name would be: com.amazonaws.us-west-2.timestream-influxdb Identity and Access Management 1259 Amazon Timestream Developer Guide To make it easier to use the VPC endpoint, you can enable a private DNS name for your VPC endpoint. If you select the Enable DNS Name option, the standard Timestream for InfluxDB DNS hostname resolves to your VPC endpoint. For example, https://timestream-influxdb.us- west-2.amazonaws.com would resolve to a VPC endpoint connected to service name com.amazonaws.us-west-2.timestream-influxdb. This option makes it easier to use the VPC endpoint. The AWS SDKs and AWS CLI use the standard Timestream for InfluxDB DNS hostname by default, so you do not need to specify the VPC endpoint URL in applications and commands. For more information, see Accessing a service through an interface endpoint in the AWS PrivateLink Guide. Connecting to an Timestream for InfluxDB VPC endpoint You can connect to Timestream for InfluxDB through the VPC endpoint by using an AWS SDK, the AWS CLI or AWS Tools for PowerShell. To specify the VPC endpoint, use its DNS name. If you enabled private hostnames when you created your VPC endpoint, you do not need to specify the VPC endpoint URL in your CLI commands or application configuration. The standard Timestream for InfluxDB DNS hostname resolves to your VPC endpoint. The AWS CLI and SDKs use this hostname by default, so you can begin using the VPC endpoint to connect to an Timestream for InfluxDB regional endpoint without changing anything in your scripts and applications. To use private hostnames, the enableDnsHostnames and enableDnsSupport attributes of your VPC must be set to
|
timestream-305
|
timestream.pdf
| 305 |
To specify the VPC endpoint, use its DNS name. If you enabled private hostnames when you created your VPC endpoint, you do not need to specify the VPC endpoint URL in your CLI commands or application configuration. The standard Timestream for InfluxDB DNS hostname resolves to your VPC endpoint. The AWS CLI and SDKs use this hostname by default, so you can begin using the VPC endpoint to connect to an Timestream for InfluxDB regional endpoint without changing anything in your scripts and applications. To use private hostnames, the enableDnsHostnames and enableDnsSupport attributes of your VPC must be set to true. To set these attributes, use the ModifyVpcAttribute operation. For details, see View and update DNS attributes for your VPC in the Amazon VPC User Guide. Controlling access to a VPC endpoint To control access to your VPC endpoint for Timestream for InfluxDB, attach a VPC endpoint policy to your VPC endpoint. The endpoint policy determines whether principals can use the VPC endpoint to call Timestream for InfluxDB operations on Timestream for InfluxDB resources. You can create a VPC endpoint policy when you create your endpoint, and you can change the VPC endpoint policy at any time. Use the VPC management console, or the CreateVpcEndpoint or ModifyVpcEndpoint operations. You can also create and change a VPC endpoint policy by using an AWS CloudFormation template. For help using the VPC management console, see Create an interface endpoint and Modifying an interface endpoint in the AWS PrivateLink Guide. Identity and Access Management 1260 Amazon Timestream Note Developer Guide Timestream for InfluxDB supports VPC endpoint policies beginning in July 2020. VPC endpoints for Timestream for InfluxDB that were created before that date have the default VPC endpoint policy, but you can change it at any time. Topics • About VPC endpoint policies • Default VPC endpoint policy • Creating a VPC endpoint policy • Viewing a VPC endpoint policy About VPC endpoint policies For an Timestream for InfluxDB request that uses a VPC endpoint to be successful, the principal requires permissions from two sources: • A IAM policy must give principal permission to call the operation on the resource. • A VPC endpoint policy must give the principal permission to use the endpoint to make the request. Default VPC endpoint policy Every VPC endpoint has a VPC endpoint policy, but you are not required to specify the policy. If you don't specify a policy, the default endpoint policy allows all operations by all principals on all resources over the endpoint. However, for Timestream for InfluxDB resources, the principal must also have permission to call the operation from an IAM policy Therefore, in practice, the default policy says that if a principal has permission to call an operation on a resource, they can also call it by using the endpoint. { "Statement": [ { "Action": "*", "Effect": "Allow", Identity and Access Management 1261 Amazon Timestream "Principal": "*", "Resource": "*" } ] } Developer Guide To allow principals to use the VPC endpoint for only a subset of their permitted operations, create or update the VPC endpoint policy. Creating a VPC endpoint policy A VPC endpoint policy determines whether a principal has permission to use the VPC endpoint to perform operations on a resource. For Timestream for InfluxDB resources, the principal must also have permission to perform the operations from a IAM policy, Each VPC endpoint policy statement requires the following elements: • The principal that can perform actions • The actions that can be performed • The resources on which actions can be performed The policy statement doesn't specify the VPC endpoint. Instead, it applies to any VPC endpoint to which the policy is attached. For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. AWS CloudTrail logs all operations that use the VPC endpoint. Viewing a VPC endpoint policy To view the VPC endpoint policy for an endpoint, use the VPC management console or the DescribeVpcEndpoints operation. The following AWS CLI command gets the policy for the endpoint with the specified VPC endpoint ID. Before using this command, replace the example endpoint ID with a valid one from your account. $ aws ec2 describe-vpc-endpoints \ --query 'VpcEndpoints[?VpcEndpointId==`vpc-endpoint-id`].[PolicyDocument]' Identity and Access Management 1262 Amazon Timestream --output text Using a VPC endpoint in a policy statement Developer Guide You can control access to Timestream for InfluxDB resources and operations when the request comes from VPC or uses a VPC endpoint. To do so, use one of the following global condition keys in a IAM policy. • Use the aws:sourceVpce condition key to grant or restrict access based on the VPC endpoint. • Use the aws:sourceVpc condition key to grant or restrict access based on the VPC that hosts the private endpoint. Note Use caution when creating key policies
|
timestream-306
|
timestream.pdf
| 306 |
'VpcEndpoints[?VpcEndpointId==`vpc-endpoint-id`].[PolicyDocument]' Identity and Access Management 1262 Amazon Timestream --output text Using a VPC endpoint in a policy statement Developer Guide You can control access to Timestream for InfluxDB resources and operations when the request comes from VPC or uses a VPC endpoint. To do so, use one of the following global condition keys in a IAM policy. • Use the aws:sourceVpce condition key to grant or restrict access based on the VPC endpoint. • Use the aws:sourceVpc condition key to grant or restrict access based on the VPC that hosts the private endpoint. Note Use caution when creating key policies and IAM policies based on your VPC endpoint. If a policy statement requires that requests come from a particular VPC or VPC endpoint, requests from integrated AWS services that use an Timestream for InfluxDB resource on your behalf might fail. Also, the aws:sourceIP condition key is not effective when the request comes from an Amazon VPC endpoint. To restrict requests to a VPC endpoint, use the aws:sourceVpce or aws:sourceVpc condition keys. For more information, see Identity and access management for VPC endpoints and VPC endpoint services in the AWS PrivateLink Guide. You can use these global condition keys to control access to operations like CreateDbInstance that don't depend on any particular resource. Logging your VPC endpoint AWS CloudTrail logs all operations that use the VPC endpoint. When a request to Timestream for InfluxDB uses a VPC endpoint, the VPC endpoint ID appears in the AWS CloudTrail log entry that records the request. You can use the endpoint ID to audit the use of your Timestream for InfluxDB VPC endpoint. However, your CloudTrail logs don't include operations requested by principals in other accounts or requests for Timestream for InfluxDB operations on Timestream for InfluxDB resources and aliases in other accounts. Also, to protect your VPC, requests that are denied by a VPC endpoint policy, but otherwise would have been allowed, are not recorded in AWS CloudTrail. Identity and Access Management 1263 Amazon Timestream Developer Guide Logging and monitoring in Timestream for InfluxDB Monitoring is an important part of maintaining the reliability, availability, and performance of Timestream for InfluxDB and your AWS solutions. You should collect monitoring data from all of the parts of your AWS solution so that you can more easily debug a multi-point failure if one occurs. However, before you start monitoring Timestream for InfluxDB, you should create a monitoring plan that includes answers to the following questions: • What are your monitoring goals? • What resources will you monitor? • How often will you monitor these resources? • What monitoring tools will you use? • Who will perform the monitoring tasks? • Who should be notified when something goes wrong? The next step is to establish a baseline for normal Timestream for InfluxDB performance in your environment, by measuring performance at various times and under different load conditions. As you monitor Timestream for InfluxDB, store historical monitoring data so that you can compare it with current performance data, identify normal performance patterns and performance anomalies, and devise methods to address issues. To establish a baseline, you should, at a minimum, monitor the following items: • System errors, so that you can determine whether any requests resulted in an error. Topics • Monitoring tools • Logging Timestream for InfluxDB API calls with AWS CloudTrail Monitoring tools AWS provides various tools that you can use to monitor Timestream for InfluxDB. You can configure some of these tools to do the monitoring for you, while some of the tools require manual intervention. We recommend that you automate monitoring tasks as much as possible. Topics Logging and monitoring 1264 Amazon Timestream • Automated monitoring tools • Manual monitoring tools Automated monitoring tools Developer Guide You can use the following automated monitoring tools to watch Timestream for InfluxDB and report when something is wrong: • Amazon CloudWatch Alarms – Watch a single metric over a time period that you specify, and perform one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The action is a notification sent to an Amazon Simple Notification Service (Amazon SNS) topic or Amazon EC2 Auto Scaling policy. CloudWatch alarms do not invoke actions simply because they are in a particular state; the state must have changed and been maintained for a specified number of periods. For more information, see Monitoring with Amazon CloudWatch. Manual monitoring tools Another important part of monitoring Timestream for InfluxDB involves manually monitoring those items that the CloudWatch alarms don't cover. The Timestream for InfluxDB, CloudWatch, Trusted Advisor, and other AWS Management Console dashboards provide an at-a-glance view of the state of your AWS environment. • The CloudWatch home page shows the following: • Current alarms and status • Graphs of
|
timestream-307
|
timestream.pdf
| 307 |
Scaling policy. CloudWatch alarms do not invoke actions simply because they are in a particular state; the state must have changed and been maintained for a specified number of periods. For more information, see Monitoring with Amazon CloudWatch. Manual monitoring tools Another important part of monitoring Timestream for InfluxDB involves manually monitoring those items that the CloudWatch alarms don't cover. The Timestream for InfluxDB, CloudWatch, Trusted Advisor, and other AWS Management Console dashboards provide an at-a-glance view of the state of your AWS environment. • The CloudWatch home page shows the following: • Current alarms and status • Graphs of alarms and resources • Service health status In addition, you can use CloudWatch to do the following: • Create customized dashboards to monitor the services you care about • Graph metric data to troubleshoot issues and discover trends • Search and browse all your AWS resource metrics • Create and edit alarms to be notified of problems Logging Timestream for InfluxDB API calls with AWS CloudTrail Logging and monitoring 1265 Amazon Timestream Developer Guide Timestream for InfluxDB is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Timestream for InfluxDB. CloudTrail captures Data Definition Language (DDL) API calls for Timestream for InfluxDB as events. The calls that are captured include calls from the Timestream for InfluxDB console and code calls to the Timestream for InfluxDB API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon Simple Storage Service (Amazon S3) bucket, including events for Timestream for InfluxDB. If you don't configure a trail, you can still view the most recent events on the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to Timestream for InfluxDB, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. Timestream for InfluxDB information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Timestream for InfluxDB, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing Events with CloudTrail Event History. For an ongoing record of events in your AWS account, including events for Timestream for InfluxDB, create a trail. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following topics in the AWS CloudTrail User Guide: • Overview for Creating a Trail • CloudTrail Supported Services and Integrations • Configuring Amazon SNS Notifications for CloudTrail • Receiving CloudTrail Log Files from Multiple Regions • Receiving CloudTrail Log Files from Multiple Accounts • Logging data events Every event or log entry contains information about who generated the request. The identity information helps you determine the following: Logging and monitoring 1266 Amazon Timestream Developer Guide • Whether the request was made with root or AWS Identity and Access Management (IAM) user credentials • Whether the request was made with temporary security credentials for a role or federated user • Whether the request was made by another AWS service For more information, see the CloudTrail userIdentity Element. Compliance validation for Amazon Timestream for InfluxDB Third-party auditors assess the security and compliance of Amazon Timestream for InfluxDB as part of multiple AWS compliance programs. These include the following: • GDPR • HIPAA • PCI • SOC Resilience in Amazon Timestream for InfluxDB The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Amazon Timestream for InfluxDB periodically takes internal backups and retains them for 24 hours to support availability and durability. Snapshots are taken during deletes and retained for 30 days to support restores. To access or use these, file a ticket at AWS support. You can create your instance
|
timestream-308
|
timestream.pdf
| 308 |
redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Amazon Timestream for InfluxDB periodically takes internal backups and retains them for 24 hours to support availability and durability. Snapshots are taken during deletes and retained for 30 days to support restores. To access or use these, file a ticket at AWS support. You can create your instance with Multi-AZ recovery capabilities. For more information, see Multi- AZ DB instance deployments. Compliance validation 1267 Amazon Timestream Developer Guide Infrastructure security in Amazon Timestream for InfluxDB As a managed service, Amazon Timestream for InfluxDB is protected by the AWS global network security procedures that are described in the Amazon Web Services: Overview of Security Processes whitepaper. You use AWS published control plane API calls to access Timestream for InfluxDB through the network. For more information, see Control planes and data planes. Clients must support Transport Layer Security (TLS) 1.2 or later. We recommend TLS 1.2 or 1.3. Clients must also support cipher suites with perfect forward secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Timestream for InfluxDB is architected so that your traffic is isolated to the specific AWS Region that your Timestream for InfluxDB instance resides in. Security groups Security groups control the access that traffic has in and out of a DB instance. By default, network access is turned off to a DB instance. You can specify rules in a security group that allow access from an IP address range, port, or security group. After ingress rules are configured, the same rules apply to all DB instances that are associated with that security group. For more information, see Controlling access to a DB instance in a VPC. Configuration and vulnerability analysis in Timestream for InfluxDB Configuration and IT controls are a shared responsibility between AWS and you, our customer. For more information, see the AWS shared responsibility model. In addition to the shared responsibility model, Timestream for InfluxDB users should be aware of the following: • It is the customer responsibility to patch their client applications with the relevant client side dependencies. • Customers should consider penetration testing if appropriate (see https://aws.amazon.com/ security/penetration-testing/.) Infrastructure security 1268 Amazon Timestream Developer Guide Incident response in Timestream for InfluxDB Amazon Timestream for InfluxDB service incidents are reported in the Personal Health Dashboard. You can learn more about the dashboard and AWS Health here. Timestream for InfluxDB supports reporting using AWS CloudTrail. For more information, see Logging Timestream for InfluxDB API calls with AWS CloudTrail. Amazon Timestream for InfluxDB API and interface VPC endpoints (AWS PrivateLink) You can establish a private connection between your VPC and Amazon Amazon Timestream for InfluxDB control plane API endpoints by creating an interface VPC endpoint. Interface endpoints are powered by AWS PrivateLink. AWS PrivateLink allows you to privately access Amazon Timestream for InfluxDB API operations without an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. Instances in your VPC don't need public IP addresses to communicate with Amazon Timestream for InfluxDB API endpoints. Your instances also don't need public IP addresses to use any of the available Timestream for InfluxDB API operations. Traffic between your VPC and Amazon Timestream for InfluxDB doesn't leave the Amazon network. Each interface endpoint is represented by one or more elastic network interfaces in your subnets. For more information on elastic network interfaces, see Elastic network interfaces in the Amazon EC2 User Guide. • For more information about VPC endpoints, see Interface VPC endpoints (AWS PrivateLink) in the Amazon VPC User Guide. • For more information about Timestream for InfluxDB API operations, see Timestream for InfluxDB API operations. After you create an interface VPC endpoint, if you enable private DNS hostnames for the endpoint, the default Timestream for InfluxDB endpoint (https://timestream- influxb.Region.amazonaws.com) resolves to your VPC endpoint. If you do not enable private DNS hostnames, Amazon VPC provides a DNS endpoint name that you can use in the following format: VPC_Endpoint_ID.timestream-influxb.Region.vpce.amazonaws.com For more information, see Interface VPC Endpoints (AWS PrivateLink) in the Amazon VPC User Guide. Timestream for InfluxDB supports making calls to all of its API Actions inside your VPC. Incident response 1269 Amazon Timestream Note Developer Guide Private DNS hostnames can be enabled for only one
|
timestream-309
|
timestream.pdf
| 309 |
After you create an interface VPC endpoint, if you enable private DNS hostnames for the endpoint, the default Timestream for InfluxDB endpoint (https://timestream- influxb.Region.amazonaws.com) resolves to your VPC endpoint. If you do not enable private DNS hostnames, Amazon VPC provides a DNS endpoint name that you can use in the following format: VPC_Endpoint_ID.timestream-influxb.Region.vpce.amazonaws.com For more information, see Interface VPC Endpoints (AWS PrivateLink) in the Amazon VPC User Guide. Timestream for InfluxDB supports making calls to all of its API Actions inside your VPC. Incident response 1269 Amazon Timestream Note Developer Guide Private DNS hostnames can be enabled for only one VPC endpoint in the VPC. If you want to create an additional VPC endpoint then private DNS hostname should be disabled for it. Considerations for VPC endpoints Before you set up an interface VPC endpoint for Amazon Timestream for InfluxDB API endpoints, ensure that you review Interface endpoint properties and limitations in the Amazon VPC User Guide. All Timestream for InfluxDB API operations that are relevant to managing Amazon Timestream for InfluxDB resources are available from your VPC using AWS PrivateLink. VPC endpoint policies are supported for Timestream for InfluxDB API endpoints. By default, full access to Timestream for InfluxDB API operations is allowed through the endpoint. For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. Creating an interface VPC endpoint for the Timestream for InfluxDB API You can create a VPC endpoint for the Amazon Timestream for InfluxDB API using either the Amazon VPC console or the AWS CLI. For more information, see Creating an interface endpoint in the Amazon VPC User Guide. After you create an interface VPC endpoint, you can enable private DNS host names for the endpoint. When you do, the default Amazon Timestream for InfluxDB endpoint (https:// timestream-influxb.Region.amazonaws.com) resolves to your VPC endpoint. For more information, see Accessing a service through an interface endpoint in the Amazon VPC User Guide. Creating a VPC endpoint policy for the Amazon Timestream for InfluxDB API You can attach an endpoint policy to your VPC endpoint that controls access to the Timestream for InfluxDB API. The policy specifies the following: • The principal that can perform actions. • The actions that can be performed. • The resources on which actions can be performed. For more information, see Controlling access to services with VPC endpoints in the Amazon VPC User Guide. Amazon Timestream for InfluxDB API and interface VPC endpoints (AWS PrivateLink) 1270 Amazon Timestream Developer Guide Example VPC endpoint policy for Timestream for InfluxDB API actions The following is an example of an endpoint policy for the Timestream for InfluxDB API. When attached to an endpoint, this policy grants access to the listed Timestream for InfluxDB API actions for all principals on all resources. { "Statement": [{ "Principal": "*", "Effect": "Allow", "Action": [ "timestream-influxb:CreateDbInstance", "timestream-influxb:UpdateDbInstance" ], "Resource": "*" }] } Example VPC endpoint policy that denies all access from a specified AWS account The following VPC endpoint policy denies AWS account 123456789012 all access to resources using the endpoint. The policy allows all actions from other accounts. { "Statement": [{ "Action": "*", "Effect": "Allow", "Resource": "*", "Principal": "*" }, { "Action": "*", "Effect": "Deny", "Resource": "*", "Principal": { "AWS": [ "123456789012" ] } } ] } Amazon Timestream for InfluxDB API and interface VPC endpoints (AWS PrivateLink) 1271 Amazon Timestream Developer Guide Security best practices for Timestream for InfluxDB Amazon Timestream for InfluxDB provides a number of security features to consider as you develop and implement your own security policies. The following best practices are general guidelines and don’t represent a complete security solution. Because these best practices might not be appropriate or sufficient for your environment, treat them as helpful considerations rather than prescriptions. Implement least privilege access When granting permissions, you decide who is getting what permissions to which Timestream for InfluxDB resources. You enable specific actions that you want to allow on those resources. Therefore you should grant only the permissions that are required to perform a task. Implementing least privilege access is fundamental in reducing security risk and the impact that could result from errors or malicious intent. Use IAM roles Producer and client applications must have valid credentials to access Timestream for InfluxDB DB instances. You should not store AWS credentials directly in a client application or in an Amazon S3 bucket. These are long-term credentials that are not automatically rotated and could have a significant business impact if they are compromised. Instead, you should use an IAM role to manage temporary credentials for your producer and client applications to access Timestream for InfluxDB DB instances. When you use a role, you don't have to use long-term credentials (such as a user name and password or access keys) to access other resources. For more information, see
|
timestream-310
|
timestream.pdf
| 310 |
valid credentials to access Timestream for InfluxDB DB instances. You should not store AWS credentials directly in a client application or in an Amazon S3 bucket. These are long-term credentials that are not automatically rotated and could have a significant business impact if they are compromised. Instead, you should use an IAM role to manage temporary credentials for your producer and client applications to access Timestream for InfluxDB DB instances. When you use a role, you don't have to use long-term credentials (such as a user name and password or access keys) to access other resources. For more information, see the following topics in the IAM User Guide: • IAM Roles • Common Scenarios for Roles: Users, Applications, and Services Use AWS Identity and Access Management (IAM) accounts to control access to Amazon Timestream for InfluxDB API operations, especially operations that create, modify, or delete Amazon Timestream for InfluxDB resources. Such resources include DB instances, security groups, and parameter groups. Security best practices 1272 Amazon Timestream Developer Guide • Create an individual user for each person who manages Amazon Timestream for InfluxDB resources, including yourself. Don't use AWS root credentials to manage Amazon Timestream for InfluxDB resources. • Grant each user the minimum set of permissions required to perform his or her duties. • Use IAM groups to effectively manage permissions for multiple users. • Rotate your IAM credentials regularly. • Configure AWS Secrets Manager to automatically rotate the secrets for Amazon Timestream for InfluxDB. For more information, see Rotating your AWS Secrets Manager secrets in the AWS Secrets Manager User Guide. You can also retrieve the credential from AWS Secrets Manager programmatically. For more information, see Retrieving the secret value in the AWS Secrets Manager User Guide. • Secure your Timestream for InfluxDB influx API tokens by using the API tokens. Implement Server-Side Encryption in Dependent Resources Data at rest and data in transit can be encrypted in Timestream for InfluxDB. For more information, see Encryption in transit. Use CloudTrail to Monitor API Calls Timestream for InfluxDB is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Timestream for InfluxDB. Using the information collected by CloudTrail, you can determine the request that was made to Timestream for InfluxDB, the IP address from which the request was made, who made the request, when it was made, and additional details. For more information, see the section called “Logging Timestream for LiveAnalytics API calls with AWS CloudTrail”. Amazon Timestream for InfluxDB supports control plane CloudTrail events, but not data plane. For more information, see Control planes and data planes. Public accessibility When you launch a DB instance inside a virtual private cloud (VPC) based on the Amazon VPC service, you can turn on or off public accessibility for that DB instance. To designate whether the DB instance that you create has a DNS name that resolves to a public IP address, you use the Public Security best practices 1273 Amazon Timestream Developer Guide accessibility parameter. By using this parameter, you can designate whether there is public access to the DB instance If your DB instance is in a VPC but isn't publicly accessible, you can also use an AWS Site-to-Site VPN connection or an AWS Direct Connect connection to access it from a private network. If your DB instance is publicly accessible, be sure to take steps to prevent or help mitigate denial of service related threats. For more information, see Introduction to denial of service attacks and Protecting networks. Working with other services Amazon Timestream for InfluxDB integrates with a variety of AWS services and popular third-party tools. All services and tools compatible with open-source InfluxDB should work seamlessly with Timestream for InfluxDB. Among those we would like to note: Topics • InfluxDB portals • DBeaver • Grafana InfluxDB portals Amazon Timestream for InfluxDB, based on InfluxDB 2.7 Open Source, utilizes long-lived access tokens for authentication. Organizations with stringent security requirements can enhance their token management through custom implementation of rotation and expiration mechanisms. For environments requiring advanced security protocols, especially those with public internet- exposed API endpoints, implementing additional token management strategies becomes essential. You can address these security considerations through Ockam’s InfluxDB portals, which provide comprehensive token management capabilities for InfluxDB deployments. InfluxDB portals allow you to establish a private connection, with enhanced authentication and authorization controls, between any InfluxDB client and Amazon Timestream for InfluxDB API endpoints by creating an InfluxDB portal powered by Ockam. Portals enable you to: • Privately access Amazon Timestream for InfluxDB API operations over mutually authenticated and encrypted connections without the need for a VPN or AWS Direct Connect connection. Working with other services 1274 Amazon Timestream Developer Guide • Automatically distribute and rotate short-lived least privilege API tokens to
|
timestream-311
|
timestream.pdf
| 311 |
these security considerations through Ockam’s InfluxDB portals, which provide comprehensive token management capabilities for InfluxDB deployments. InfluxDB portals allow you to establish a private connection, with enhanced authentication and authorization controls, between any InfluxDB client and Amazon Timestream for InfluxDB API endpoints by creating an InfluxDB portal powered by Ockam. Portals enable you to: • Privately access Amazon Timestream for InfluxDB API operations over mutually authenticated and encrypted connections without the need for a VPN or AWS Direct Connect connection. Working with other services 1274 Amazon Timestream Developer Guide • Automatically distribute and rotate short-lived least privilege API tokens to InfluxDB clients. The built-in lease manager significantly reduces the risk associated with using the default InfluxDB approach of long-lived access tokens by dynamically assigning each client a unique access token with a short time-to-live (TTL). • Have cryptographic guarantees of data privacy, data integrity, and authenticity thanks to the mutually authenticated end-to-end encryption. Amazon Timestream for InfluxDB endpoints do not need public IP addresses. All clients automatically get unique short-lived API tokens. Traffic between your InfluxDB and clients is encrypted using unique encryption keys per client. For more information on using InfluxDB Portals for secure connectivity and enhanced authentication, see Ockam’s guide to Secure token management for Amazon Timestream for InfluxDB. DBeaver DBeaver is a free universal SQL client that can be used to manage any database that has a JDBC driver. It is widely used among developers and database administrators because of its robust data viewing, editing, and management capabilities. Using DBeaver's cloud connectivity options, you can connect DBeaver to Amazon Timestream for InfluxDB natively. DBeaver provides a comprehensive and intuitive interface to work with time series data directly from within a DBeaver application. Using your credentials, it also gives you full access to any queries that you could execute from another query interface. It even lets you create graphs for better understanding and visualization of query results. To configure your DBeaver client to connect to your Timestream for InfluxDB DB instance or cluster, refer to DBeaver's guide to InfluxDB configuration. Grafana Use Amazon Managed Grafana, Grafana, or Grafana Cloud to visualize data from your Timestream for InfluxDB instance. DBeaver 1275 Amazon Timestream Connect to Grafana Important Developer Guide The instructions in this guide require Grafana Cloud or Grafana 10.3+. 1. Create your Timestream for InfluxDB DB instance or Timestream for InfluxDB DB cluster. 2. Create an Amazon Managed Grafana workspace, sign up for Grafana Cloud, or download and install Grafana. 3. Visit your Amazon Managed Grafana, Grafana Cloud user interface (UI) or, if running Grafana locally, start Grafana and visit http://localhost:3000 in your browser. 4. In the left navigation of the Grafana UI, open the Connections section and select Add new connection. 5. Select InfluxDB from the list of available data sources and click Add new data source. 6. On the Data Source configuration page, enter a name for your InfluxDB data source. 7. In the Query Language dropdown list, select one of the query languages supported by InfluxDB 2.7 (Flux or InfluxQL). Important SQL is only supported in InfluxDB 3. Configure Grafana to use Flux With Flux selected as the query language in your InfluxDB data source, configure your InfluxDB connection: 1. In the HTTP section, enter your InfluxDB URL in the URL field. https://your-timestream-for-influxdb-endpoint:8086 2. In the InfluxDB Details section, enter the following: • In Organization: Your InfluxDB organization name or ID. • In Token: Your InfluxDB API token. Grafana 1276 Amazon Timestream Developer Guide • In Default Bucket: The default bucket to use in Flux queries. • In Min time interval: The Grafana minimum time interval. The default is 10 seconds. • In Max series: The maximum number of series or tables Grafana will process. The default is 1,000. Grafana 1277 Amazon Timestream Developer Guide Grafana 1278 Amazon Timestream Developer Guide 3. Click Save & test. Grafana attempts to connect to the InfluxDB 2.7 data source and returns the results of the test. Configure Grafana to use InfluxQL To query InfluxDB 2.7 with InfluxQL, find your use case below and then complete the instructions to configure Grafana. New install of InfluxDB 2.7: To configure Grafana to use InfluxQL with a new install of InfluxDB 2.7, do the following: 1. Authenticate with InfluxDB 2.7 tokens. 2. Manually create DBRP mappings. Manual migration from InfluxDB 1.x to 2.7: To configure Grafana to use InfluxQL when you have manually migrated from InfluxDB 1.x to InfluxDB 2.7, do the following: 1. If your InfluxDB 1.x instance required authentication, create v1-compatible authentication credentials to match your previous 1.x username and password. Otherwise, use InfluxDB v2 token authentication. 2. Manually create DBRP mappings. With InfluxQL selected as the query language in your InfluxDB data source, configure your InfluxDB connection: 1. In the HTTP section, enter your InfluxDB URL in the URL
|
timestream-312
|
timestream.pdf
| 312 |
do the following: 1. Authenticate with InfluxDB 2.7 tokens. 2. Manually create DBRP mappings. Manual migration from InfluxDB 1.x to 2.7: To configure Grafana to use InfluxQL when you have manually migrated from InfluxDB 1.x to InfluxDB 2.7, do the following: 1. If your InfluxDB 1.x instance required authentication, create v1-compatible authentication credentials to match your previous 1.x username and password. Otherwise, use InfluxDB v2 token authentication. 2. Manually create DBRP mappings. With InfluxQL selected as the query language in your InfluxDB data source, configure your InfluxDB connection: 1. In the HTTP section, enter your InfluxDB URL in the URL field. https://your-timestream-for-influxdb-endpoint:8086 2. In the Custom HTTP Headers section, enter the following: • Select Add header. Provide your InfluxDB API token: • In Header, enter Authorization. • In Value, use the Token schema and provide your InfluxDB API token. For example, Token y0uR5uP3rSecr3tT0k3n. 3. In the InfluxDB Details section, enter the following: Grafana 1279 Amazon Timestream Developer Guide • In Database: The database name mapped to your InfluxDB 2.7 bucket. • In User and Password: The username and password associated with your InfluxDB 1.x compatibility authorization. • In HTTP Method: Select GET. 4. Click Save & test. Grafana attempts to connect to the InfluxDB 2.7 data source and returns the results of the test. Grafana 1280 Amazon Timestream Query and visualize data Developer Guide After configuring your InfluxDB connection, you can use Grafana and Flux to query and visualize time series data stored in your InfluxDB instance. For more information about using Grafana, see the Grafana technical documentation. If you are just learning Flux, see Get started with Flux. API reference For a complete list and details of Amazon Timestream for InfluxDB APIs, see Amazon Timestream for InfluxDB APIs. For error codes common to all AWS services, see the AWS Support section. Document history Change Description Date Amazon Timestream for LiveAnalytics will no longer Amazon Timestream for LiveAnalytics will no longer be open to new customers be open to new customers starting June 20, 2025. starting on 6/20/2025. If May 20, 2025 you would like to use the service, please sign up prior to 06/20/2025. For capabilities similar to Amazon Timestrea m for LiveAnalytics, explore Amazon Timestream for InfluxDB. This policy grants administr ative permissions that allow full access to all Timestrea m for InfluxDB resources , excluding any marketpla ce-related actions. For more information see AWS April 16, 2025 AmazonTimestreamIn fluxDBFullAccessWi thoutMarketplaceAc cess – New policy API reference 1281 Amazon Timestream Developer Guide managed policies for Amazon Timestream for InfluxDB. AmazonTimestreamIn – fluxDBFullAccess Update to an existing policy Amazon Timestream for InfluxDB has added to the existing AmazonTim April 16, 2025 AmazonTimestreamIn – fluxDBFullAccess Update to an existing policy Documentation-only update Amazon Timestream now supports query insights estreamInfluxDBFul lAccess managed policy. For more information, see AWS managed policies for Amazon Timestream for InfluxDB. Amazon Timestream for InfluxDB has added access to create, update, delete, and list Amazon Timestrea m InfluxDB clusters to the existing AmazonTim estreamInfluxDBFul lAccess managed policy. For more information, see AWS managed policies for Amazon Timestream for InfluxDB. Updated the Quotas topic to segregate the default quotas and system limits. Timestream now includes support for the query insights feature that helps you optimize your queries, improve their performance, and reduce costs. February 17, 2025 October 22, 2024 October 22, 2024 Document history 1282 Amazon Timestream Developer Guide Amazon Timestream for InfluxDB update to an existing Amazon Timestream for InfluxDB has added the October 8, 2024 policy. AmazonTimestreamIn – fluxDBFullAccess Update to an existing policy ec2:DescribeRouteT ables action to the existing AmazonTimestreamIn fluxDBFullAccess managed policy for describin g your route tables. For more information, see AWS managed policies for Amazon Timestream for InfluxDB. Amazon Timestream for InfluxDB has added the ec2:DescribeRouteT ables action to the existing AmazonTimestreamIn fluxDBFullAccess managed policy. This action is used for describing your route tables. See AmazonTim estreamInfluxDBFullAccess. September 12, 2024 AmazonTimestreamRe Timestream for LiveAnalytics June 3, 2024 adOnlyAccess to an existing policy – Update has added the DescribeA ccountSettings permission to the AmazonTim estreamReadOnlyAcc ess managed policy for describing AWS account settings. Document history 1283 Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics now supports Amazon Timestream for LiveAnalytics now includes Timestream Compute Units support for Timestream April 29, 2024 (TCUs) New policies added March 14, 2024 Compute Units (TCUs) to measure the compute capacity allocated for your query needs. Amazon Timestream for InfluxDB added two new policies: One that allows the service to manage network interfaces and security groups in your account. For more information, see AmazonTim estreamInfluxDBServiceRoleP olicy. Another that provide full administrative access to create, update, delete and list Amazon Timestream InfluxDB instances and create and list parameter groups. For more information, see AmazonTim estreamInfluxDBFullAccess. Amazon Timestream for InfluxDB is now generally available. This documentation covers the initial release
|
timestream-313
|
timestream.pdf
| 313 |
Compute Units support for Timestream April 29, 2024 (TCUs) New policies added March 14, 2024 Compute Units (TCUs) to measure the compute capacity allocated for your query needs. Amazon Timestream for InfluxDB added two new policies: One that allows the service to manage network interfaces and security groups in your account. For more information, see AmazonTim estreamInfluxDBServiceRoleP olicy. Another that provide full administrative access to create, update, delete and list Amazon Timestream InfluxDB instances and create and list parameter groups. For more information, see AmazonTim estreamInfluxDBFullAccess. Amazon Timestream for InfluxDB is now generally available. This documentation covers the initial release of Amazon Timestream for InfluxDB. March 14, 2024 Document history 1284 Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics Query Amazon Timestream for LiveAnalytics now publishes events are available in AWS Query API data events to AWS September 12, 2023 CloudTrail Amazon Timestream for LiveAnalytics UNLOAD CloudTrail. Customers can audit all Query API requests made in their AWS accounts, and see information such as which IAM User/Role made the request, when the request was made, which databases and tables were queried, and the request's Query ID. Amazon Timestream for LiveAnalytics now supports UNLOAD to export query results to S3. May 12, 2023 Amazon Timestream for LiveAnalytics update to an Batch load permissions added to a managed policy. February 24, 2023 existing policy. Amazon Timestream for LiveAnalytics batch load. Amazon Timestream for LiveAnalytics now supports batch load functionality. February 24, 2023 Amazon Timestream for LiveAnalytics now supports AWS Backup. Amazon Timestream for LiveAnalytics now supports AWS Backup. December 14, 2022 Amazon Timestream for LiveAnalytics updates to AWS managed policies New information about AWS managed policies and Amazon Timestream for LiveAnalytics, including updates to existing managed policies. November 29, 2021 Document history 1285 Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics supports Amazon Timestream for LiveAnalytics now supports scheduled queries running a query on your November 29, 2021 Amazon Timestream for LiveAnalytics supports magnetic store. behalf, based on a schedule. Amazon Timestream for LiveAnalytics now supports using magnetic storage for your table writes. November 29, 2021 Amazon Timestream for LiveAnalytics multi-measure Amazon Timestream for LiveAnalytics now supports November 29, 2021 records. a more compact format for storing your time-series data. Amazon Timestream for LiveAnalytics updates to AWS New information about AWS managed policies and May 24, 2021 managed policies Amazon Timestream for LiveAnalytics, including updates to existing managed policies. Amazon Timestream for LiveAnalytics is now available Amazon Timestream for LiveAnalytics is now generally April 23, 2021 in the Europe (Frankfurt) available in the Europe region. (Frankfurt) region (eu- central-1 ). Amazon Timestream for LiveAnalytics now supports VPC endpoints (AWS PrivateLi nk). Amazon Timestream for LiveAnalytics now supports the use of VPC endpoints (AWS PrivateLink). March 23, 2021 Amazon Timestream now supports cross table queries. You can use Amazon Timestream for LiveAnalytics to run cross table queries. February 10, 2021 Document history 1286 Amazon Timestream Developer Guide Amazon Timestream for LiveAnalytics now supports Amazon Timestream for LiveAnalytics now supports enhanced query execution enhanced query execution statistics. statistics, such as amount of data scanned. February 10, 2021 Amazon Timestream for LiveAnalytics now supports You can use Amazon Timestream for LiveAnaly advanced time series tics to run SQL queries February 10, 2021 functions. with advanced time series functions, such as derivatives, integrals, and correlations. Amazon Timestream for LiveAnalytics is now HIPAA, You can now use Amazon Timestream for LiveAnalytics ISO, and PCI compliant. for workloads that require January 27, 2021 HIPAA, ISO, and PCI-compl iant infrastructure. Amazon Timestream for LiveAnalytics now supports You can now use Telegraf, the open-source, plugin-dr open-source Telegraf and iven server agent for collectin November 25, 2020 Grafana. g and reporting metrics, and Grafana, the open-sour ce analytics and monitorin g platform for databases, with Amazon Timestream for LiveAnalytics. Amazon Timestream for LiveAnalytics is now generally available. This documentation covers the initial release of Amazon Timestream for LiveAnalytics. September 30, 2020 Document history 1287
|
TimestreamInfluxDB-API-001
|
TimestreamInfluxDB-API.pdf
| 1 |
API Reference Timestream for InfluxDB API Version 2023-01-27 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Timestream for InfluxDB API Reference Timestream for InfluxDB: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Timestream for InfluxDB Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CreateDbCluster ............................................................................................................................................ 3 Request Syntax ........................................................................................................................................ 3 Request Parameters ................................................................................................................................ 3 Response Syntax ...................................................................................................................................... 9 Response Elements ................................................................................................................................. 9 Errors .......................................................................................................................................................... 9 See Also .................................................................................................................................................. 10 CreateDbInstance ........................................................................................................................................ 12 Request Syntax ...................................................................................................................................... 12 Request Parameters .............................................................................................................................. 12 Response Syntax ................................................................................................................................... 17 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 22 See Also .................................................................................................................................................. 23 CreateDbParameterGroup ........................................................................................................................ 25 Request Syntax ...................................................................................................................................... 25 Request Parameters .............................................................................................................................. 25 Response Syntax ................................................................................................................................... 26 Response Elements ............................................................................................................................... 26 Errors ....................................................................................................................................................... 27 See Also .................................................................................................................................................. 28 DeleteDbCluster .......................................................................................................................................... 30 Request Syntax ...................................................................................................................................... 30 Request Parameters .............................................................................................................................. 30 Response Syntax ................................................................................................................................... 30 Response Elements ............................................................................................................................... 30 Errors ....................................................................................................................................................... 31 See Also .................................................................................................................................................. 32 DeleteDbInstance ....................................................................................................................................... 33 Request Syntax ...................................................................................................................................... 33 Request Parameters .............................................................................................................................. 33 Response Syntax ................................................................................................................................... 33 API Version 2023-01-27 iii Timestream for InfluxDB API Reference Response Elements ............................................................................................................................... 34 Errors ....................................................................................................................................................... 38 See Also .................................................................................................................................................. 39 GetDbCluster ............................................................................................................................................... 40 Request Syntax ...................................................................................................................................... 40 Request Parameters .............................................................................................................................. 40 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 41 Errors ....................................................................................................................................................... 45 See Also .................................................................................................................................................. 45 GetDbInstance ............................................................................................................................................. 47 Request Syntax ...................................................................................................................................... 47 Request Parameters .............................................................................................................................. 47 Response Syntax ................................................................................................................................... 47 Response Elements ............................................................................................................................... 48 Errors ....................................................................................................................................................... 52 See Also .................................................................................................................................................. 53 GetDbParameterGroup .............................................................................................................................. 54 Request Syntax ...................................................................................................................................... 54 Request Parameters .............................................................................................................................. 54 Response Syntax ................................................................................................................................... 54 Response Elements ............................................................................................................................... 54 Errors ....................................................................................................................................................... 56 See Also .................................................................................................................................................. 56 ListDbClusters .............................................................................................................................................. 58 Request Syntax ...................................................................................................................................... 58 Request Parameters .............................................................................................................................. 58 Response Syntax ................................................................................................................................... 59 Response Elements ............................................................................................................................... 59 Errors ....................................................................................................................................................... 60 See Also .................................................................................................................................................. 60 ListDbInstances ........................................................................................................................................... 62 Request Syntax ...................................................................................................................................... 62 Request Parameters .............................................................................................................................. 62 Response Syntax ................................................................................................................................... 63 Response Elements ............................................................................................................................... 63 API Version 2023-01-27 iv Timestream for InfluxDB API Reference Errors ....................................................................................................................................................... 64 See Also .................................................................................................................................................. 64 ListDbInstancesForCluster ......................................................................................................................... 66 Request Syntax ...................................................................................................................................... 66 Request Parameters .............................................................................................................................. 66 Response Syntax ................................................................................................................................... 67 Response Elements ............................................................................................................................... 67 Errors ....................................................................................................................................................... 68 See Also .................................................................................................................................................. 69 ListDbParameterGroups ............................................................................................................................ 70 Request Syntax ...................................................................................................................................... 70 Request Parameters .............................................................................................................................. 70 Response Syntax ................................................................................................................................... 71 Response Elements ............................................................................................................................... 71 Errors ....................................................................................................................................................... 71 See Also .................................................................................................................................................. 72 ListTagsForResource ................................................................................................................................... 74 Request Syntax ...................................................................................................................................... 74 Request Parameters .............................................................................................................................. 74 Response Syntax ................................................................................................................................... 74 Response Elements ............................................................................................................................... 74 Errors ....................................................................................................................................................... 75 See Also .................................................................................................................................................. 75 TagResource ................................................................................................................................................. 77 Request Syntax ...................................................................................................................................... 77 Request Parameters .............................................................................................................................. 77 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 See Also .................................................................................................................................................. 78 UntagResource ............................................................................................................................................ 80 Request Syntax ...................................................................................................................................... 80 Request Parameters .............................................................................................................................. 80 Response Elements ............................................................................................................................... 81 Errors ....................................................................................................................................................... 81 See Also .................................................................................................................................................. 81 UpdateDbCluster ........................................................................................................................................ 82 API Version 2023-01-27 v Timestream for InfluxDB API Reference Request Syntax ...................................................................................................................................... 82 Request Parameters .............................................................................................................................. 82 Response Syntax ................................................................................................................................... 84 Response Elements ............................................................................................................................... 84 Errors ....................................................................................................................................................... 84 See Also .................................................................................................................................................. 85 UpdateDbInstance ...................................................................................................................................... 86 Request Syntax ...................................................................................................................................... 86 Request Parameters .............................................................................................................................. 86 Response Syntax ................................................................................................................................... 88 Response Elements ............................................................................................................................... 89 Errors ....................................................................................................................................................... 93 See Also .................................................................................................................................................. 94 Data Types ..................................................................................................................................... 95 DbClusterSummary .................................................................................................................................... 96 Contents .................................................................................................................................................. 96 See Also .................................................................................................................................................. 98 DbInstanceForClusterSummary ............................................................................................................. 100 Contents ............................................................................................................................................... 100 See Also ................................................................................................................................................ 103 DbInstanceSummary ............................................................................................................................... 104 Contents ............................................................................................................................................... 104 See Also ................................................................................................................................................ 106 DbParameterGroupSummary ................................................................................................................ 108 Contents ............................................................................................................................................... 108 See Also ................................................................................................................................................ 109 Duration ..................................................................................................................................................... 110 Contents ............................................................................................................................................... 110 See Also ................................................................................................................................................ 110 InfluxDBv2Parameters ............................................................................................................................. 111 Contents ............................................................................................................................................... 111 See Also ................................................................................................................................................ 119 LogDeliveryConfiguration ....................................................................................................................... 121 Contents ............................................................................................................................................... 121 See Also ................................................................................................................................................ 121 Parameters ................................................................................................................................................. 122 API Version 2023-01-27 vi Timestream for InfluxDB API Reference Contents ............................................................................................................................................... 122 See Also ................................................................................................................................................ 122 S3Configuration ....................................................................................................................................... 123 Contents ............................................................................................................................................... 123 See Also ................................................................................................................................................ 123 Common Parameters ................................................................................................................... 124 Common Errors ............................................................................................................................ 127 API Version 2023-01-27 vii Timestream for InfluxDB Welcome API Reference 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. This document was last published on May 21, 2025. API Version 2023-01-27 1 Timestream for InfluxDB Actions The following actions are supported: • CreateDbCluster • CreateDbInstance • CreateDbParameterGroup • DeleteDbCluster •
|
TimestreamInfluxDB-API-002
|
TimestreamInfluxDB-API.pdf
| 2 |
2023-01-27 vii Timestream for InfluxDB Welcome API Reference 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. This document was last published on May 21, 2025. API Version 2023-01-27 1 Timestream for InfluxDB Actions The following actions are supported: • CreateDbCluster • CreateDbInstance • CreateDbParameterGroup • DeleteDbCluster • DeleteDbInstance • GetDbCluster • GetDbInstance • GetDbParameterGroup • ListDbClusters • ListDbInstances • ListDbInstancesForCluster • ListDbParameterGroups • ListTagsForResource • TagResource • UntagResource • UpdateDbCluster • UpdateDbInstance API Reference API Version 2023-01-27 2 API Reference Timestream for InfluxDB CreateDbCluster Creates a new Timestream for InfluxDB cluster. Request Syntax { "allocatedStorage": number, "bucket": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "failoverMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "organization": "string", "password": "string", "port": number, "publiclyAccessible": boolean, "tags": { "string" : "string" }, "username": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. allocatedStorage The amount of storage to allocate for your DB storage type in GiB (gibibytes). CreateDbCluster API Version 2023-01-27 3 Timestream for InfluxDB Type: Integer API Reference Valid Range: Minimum value of 20. Maximum value of 15360. Required: Yes bucket 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. Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: ^[^_"][^"]*$ Required: No dbInstanceType The Timestream for InfluxDB DB instance type to run InfluxDB on. Type: String Valid 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 Required: Yes dbParameterGroupIdentifier 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. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: No Request Parameters API Version 2023-01-27 4 Timestream for InfluxDB dbStorageType API Reference 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 Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Required: No deploymentType Specifies the type of cluster to create. Type: String Valid Values: MULTI_NODE_READ_REPLICAS Required: Yes failoverMode Specifies the behavior of failure recovery when the primary node of the cluster fails. Type: String Valid Values: AUTOMATIC | NO_FAILOVER Required: No logDeliveryConfiguration Configuration for sending InfluxDB engine logs to a specified S3 bucket. Type: LogDeliveryConfiguration object Required: No Request Parameters API Version 2023-01-27 5 Timestream for InfluxDB name API Reference 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. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ Required: Yes networkType 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. Type: String Valid Values: IPV4 | DUAL Required: No organization The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No password 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 Secrets Manager in your account. Request Parameters API Version 2023-01-27 6 Timestream for InfluxDB Type: String API Reference Length Constraints: Minimum length of 8. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes port 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 Type: Integer Valid Range: Minimum value of 1024. Maximum value of
|
TimestreamInfluxDB-API-003
|
TimestreamInfluxDB-API.pdf
| 3 |
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 Secrets Manager in your account. Request Parameters API Version 2023-01-27 6 Timestream for InfluxDB Type: String API Reference Length Constraints: Minimum length of 8. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes port 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 Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No publiclyAccessible Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC. Type: Boolean Required: No tags A list of key-value pairs to associate with the DB instance. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Request Parameters API Version 2023-01-27 7 Timestream for InfluxDB Required: No username API Reference 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 AWS Secrets Manager in your account. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No vpcSecurityGroupIds A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^sg-[a-z0-9]+$ Required: Yes vpcSubnetIds 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. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^subnet-[a-z0-9]+$ Required: Yes Request Parameters API Version 2023-01-27 8 API Reference Timestream for InfluxDB Response Syntax { "dbClusterId": "string", "dbClusterStatus": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. dbClusterId A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbClusterStatus The status of the DB cluster. Type: String Valid Values: CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 ConflictException The request conflicts with an existing resource in Timestream for InfluxDB. Response Syntax API Version 2023-01-27 9 Timestream for InfluxDB HTTP Status Code: 400 InternalServerException API Reference The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ServiceQuotaExceededException The request exceeds the service quota. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2023-01-27 10 Timestream for InfluxDB • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 11 API Reference Timestream for InfluxDB CreateDbInstance Creates a new Timestream for InfluxDB DB instance. Request Syntax { "allocatedStorage": number, "bucket": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "organization": "string", "password": "string", "port": number, "publiclyAccessible": boolean, "tags": { "string" : "string" }, "username": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. allocatedStorage The amount of storage to allocate for your DB storage type in GiB (gibibytes). CreateDbInstance API Version 2023-01-27 12 Timestream for InfluxDB
|
TimestreamInfluxDB-API-004
|
TimestreamInfluxDB-API.pdf
| 4 |
{ "allocatedStorage": number, "bucket": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "organization": "string", "password": "string", "port": number, "publiclyAccessible": boolean, "tags": { "string" : "string" }, "username": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. allocatedStorage The amount of storage to allocate for your DB storage type in GiB (gibibytes). CreateDbInstance API Version 2023-01-27 12 Timestream for InfluxDB Type: Integer API Reference Valid Range: Minimum value of 20. Maximum value of 15360. Required: Yes bucket 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. Type: String Length Constraints: Minimum length of 2. Maximum length of 64. Pattern: ^[^_"][^"]*$ Required: No dbInstanceType The Timestream for InfluxDB DB instance type to run InfluxDB on. Type: String Valid 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 Required: Yes dbParameterGroupIdentifier 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. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: No Request Parameters API Version 2023-01-27 13 Timestream for InfluxDB dbStorageType API Reference 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 Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Required: No deploymentType Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Type: String Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY Required: No logDeliveryConfiguration Configuration for sending InfluxDB engine logs to a specified S3 bucket. Type: LogDeliveryConfiguration object Required: No name 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. Type: String Request Parameters API Version 2023-01-27 14 Timestream for InfluxDB API Reference Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ Required: Yes networkType 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. Type: String Valid Values: IPV4 | DUAL Required: No organization The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No password 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 Secrets Manager in your account. Type: String Length Constraints: Minimum length of 8. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes Request Parameters API Version 2023-01-27 15 Timestream for InfluxDB port API Reference 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 Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No publiclyAccessible Configures the DB instance with a public IP to facilitate access. Type: Boolean Required: No tags A list of key-value pairs to associate with the DB instance. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No username 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. Request Parameters API Version 2023-01-27 16 Timestream for InfluxDB Type: String API Reference Length Constraints: Minimum length of 1.
|
TimestreamInfluxDB-API-005
|
TimestreamInfluxDB-API.pdf
| 5 |
length of 0. Maximum length of 256. Required: No username 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. Request Parameters API Version 2023-01-27 16 Timestream for InfluxDB Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No vpcSecurityGroupIds A list of VPC security group IDs to associate with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^sg-[a-z0-9]+$ Required: Yes vpcSubnetIds 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. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^subnet-[a-z0-9]+$ Required: Yes Response Syntax { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", Response Syntax API Version 2023-01-27 17 Timestream for InfluxDB API Reference "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. allocatedStorage The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. arn The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Response Elements API Version 2023-01-27 18 Timestream for InfluxDB API Reference 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}$ availabilityZone The Availability Zone in which the DB instance resides. Type: String dbClusterId Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbInstanceType The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid 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 dbParameterGroupIdentifier The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbStorageType The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Response Elements API Version 2023-01-27 19 Timestream for InfluxDB deploymentType API Reference Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Type: String Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY endpoint The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ influxAuthParametersSecretArn 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. Type: String instanceMode Specifies the DbInstance's role in the cluster. Type: String Valid Values: PRIMARY | STANDBY | REPLICA logDeliveryConfiguration Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: LogDeliveryConfiguration object Response Elements API Version 2023-01-27 20 Timestream for InfluxDB name API Reference The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ networkType 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. Type: String Valid Values: IPV4 | DUAL port The port number on which InfluxDB accepts connections. The default value is 8086. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. publiclyAccessible Indicates if the DB instance has a public IP to facilitate access. Type: Boolean secondaryAvailabilityZone The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String status The status of the DB instance. Response Elements API Version 2023-01-27 21 Timestream for InfluxDB Type: String API Reference Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING |
|
TimestreamInfluxDB-API-006
|
TimestreamInfluxDB-API.pdf
| 6 |
IPv6 protocols. Type: String Valid Values: IPV4 | DUAL port The port number on which InfluxDB accepts connections. The default value is 8086. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. publiclyAccessible Indicates if the DB instance has a public IP to facilitate access. Type: Boolean secondaryAvailabilityZone The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String status The status of the DB instance. Response Elements API Version 2023-01-27 21 Timestream for InfluxDB Type: String API Reference Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE vpcSecurityGroupIds A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^sg-[a-z0-9]+$ vpcSubnetIds A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^subnet-[a-z0-9]+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 ConflictException The request conflicts with an existing resource in Timestream for InfluxDB. HTTP Status Code: 400 Errors API Version 2023-01-27 22 Timestream for InfluxDB InternalServerException API Reference The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ServiceQuotaExceededException The request exceeds the service quota. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2023-01-27 23 Timestream for InfluxDB • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 24 Timestream for InfluxDB API Reference CreateDbParameterGroup Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances. Request Syntax { "description": "string", "name": "string", "parameters": { ... }, "tags": { "string" : "string" } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. description A description of the DB parameter group. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: No name The name of the DB parameter group. The name must be unique per customer and per region. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ Required: Yes CreateDbParameterGroup API Version 2023-01-27 25 Timestream for InfluxDB parameters API Reference A list of the parameters that comprise the DB parameter group. Type: Parameters object Note: This object is a Union. Only one member of this object can be specified or returned. Required: No tags A list of key-value pairs to associate with the DB parameter group. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax { "arn": "string", "description": "string", "id": "string", "name": "string", "parameters": { ... } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn The Amazon Resource Name (ARM) of the DB parameter group. Response Syntax API Version 2023-01-27 26 Timestream for InfluxDB Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ description The description of the DB parameter group. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ name The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ parameters A list of the parameters that comprise the DB parameter group. Type: Parameters object Note: This object is a Union. Only one member of this object can be specified or returned.
|
TimestreamInfluxDB-API-007
|
TimestreamInfluxDB-API.pdf
| 7 |
^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}$ description The description of the DB parameter group. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ name The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ parameters A list of the parameters that comprise the DB parameter group. Type: Parameters object Note: This object is a Union. Only one member of this object can be specified or returned. Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2023-01-27 27 Timestream for InfluxDB AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 ConflictException API Reference The request conflicts with an existing resource in Timestream for InfluxDB. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ServiceQuotaExceededException The request exceeds the service quota. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2023-01-27 28 API Reference Timestream for InfluxDB • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 29 API Reference Timestream for InfluxDB DeleteDbCluster Deletes a Timestream for InfluxDB cluster. Request Syntax { "dbClusterId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. dbClusterId Service-generated unique identifier of the DB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes Response Syntax { "dbClusterStatus": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeleteDbCluster API Version 2023-01-27 30 Timestream for InfluxDB dbClusterStatus The status of the DB cluster. Type: String API Reference Valid Values: CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 ConflictException The request conflicts with an existing resource in Timestream for InfluxDB. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. Errors API Version 2023-01-27 31 Timestream for InfluxDB HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 32 API Reference Timestream for InfluxDB DeleteDbInstance Deletes a Timestream for InfluxDB DB instance. Request Syntax { "identifier": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. identifier The id of the DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes Response Syntax { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", DeleteDbInstance API Version 2023-01-27 33 Timestream for InfluxDB API Reference "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200
|
TimestreamInfluxDB-API-008
|
TimestreamInfluxDB-API.pdf
| 8 |
DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes Response Syntax { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", DeleteDbInstance API Version 2023-01-27 33 Timestream for InfluxDB API Reference "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. allocatedStorage The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. arn The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Response Elements API Version 2023-01-27 34 API Reference Timestream for InfluxDB availabilityZone The Availability Zone in which the DB instance resides. Type: String dbClusterId Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbInstanceType The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid 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 dbParameterGroupIdentifier The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbStorageType The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 deploymentType Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Response Elements API Version 2023-01-27 35 Timestream for InfluxDB Type: String API Reference Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY endpoint The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ influxAuthParametersSecretArn 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. Type: String instanceMode Specifies the DbInstance's role in the cluster. Type: String Valid Values: PRIMARY | STANDBY | REPLICA logDeliveryConfiguration Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: LogDeliveryConfiguration object name The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Response Elements API Version 2023-01-27 36 Timestream for InfluxDB Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ networkType 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. Type: String Valid Values: IPV4 | DUAL port The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. publiclyAccessible Indicates if the DB instance has a public IP to facilitate access. Type: Boolean secondaryAvailabilityZone The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String status The status of the DB instance. Type: String Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE Response Elements API Version 2023-01-27 37 Timestream for InfluxDB vpcSecurityGroupIds API Reference A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^sg-[a-z0-9]+$ vpcSubnetIds A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^subnet-[a-z0-9]+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 ConflictException The request conflicts with an existing resource in Timestream for InfluxDB. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 Errors API Version 2023-01-27 38 API Reference Timestream for InfluxDB ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy
|
TimestreamInfluxDB-API-009
|
TimestreamInfluxDB-API.pdf
| 9 |
common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 ConflictException The request conflicts with an existing resource in Timestream for InfluxDB. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 Errors API Version 2023-01-27 38 API Reference Timestream for InfluxDB ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 39 Timestream for InfluxDB GetDbCluster Retrieves information about a Timestream for InfluxDB cluster. API Reference Request Syntax { "dbClusterId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. dbClusterId Service-generated unique identifier of the DB cluster to retrieve. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes Response Syntax { "allocatedStorage": number, "arn": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "failoverMode": "string", "id": "string", "influxAuthParametersSecretArn": "string", GetDbCluster API Version 2023-01-27 40 Timestream for InfluxDB API Reference "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "readerEndpoint": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. allocatedStorage The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. arn The Amazon Resource Name (ARN) of the DB cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ dbInstanceType The Timestream for InfluxDB instance type that InfluxDB runs on. Response Elements API Version 2023-01-27 41 Timestream for InfluxDB Type: String API Reference Valid 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 dbParameterGroupIdentifier The ID of the DB parameter group assigned to your DB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbStorageType The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 deploymentType Deployment type of the DB cluster. Type: String Valid Values: MULTI_NODE_READ_REPLICAS endpoint The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations. Type: String failoverMode The configured failover mode for the DB cluster. Type: String Valid Values: AUTOMATIC | NO_FAILOVER Response Elements API Version 2023-01-27 42 Timestream for InfluxDB id API Reference Service-generated unique identifier of the DB cluster to retrieve. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ influxAuthParametersSecretArn 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. Type: String logDeliveryConfiguration Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: LogDeliveryConfiguration object name Customer-supplied name of the Timestream for InfluxDB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ networkType 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. Type: String Valid Values: IPV4 | DUAL port The port number on which InfluxDB accepts connections. Response Elements API Version 2023-01-27 43 Timestream for InfluxDB Type: Integer API Reference Valid Range: Minimum value of 1024. Maximum value of 65535. publiclyAccessible Indicates if the DB cluster has a public IP to facilitate access from outside the VPC. Type: Boolean readerEndpoint The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations. Type: String status The status of the DB cluster. Type: String Valid Values: CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED vpcSecurityGroupIds A list of VPC security group IDs associated with the DB cluster. Type: Array of strings Array Members: Minimum
|
TimestreamInfluxDB-API-010
|
TimestreamInfluxDB-API.pdf
| 10 |
Elements API Version 2023-01-27 43 Timestream for InfluxDB Type: Integer API Reference Valid Range: Minimum value of 1024. Maximum value of 65535. publiclyAccessible Indicates if the DB cluster has a public IP to facilitate access from outside the VPC. Type: Boolean readerEndpoint The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations. Type: String status The status of the DB cluster. Type: String Valid Values: CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED vpcSecurityGroupIds A list of VPC security group IDs associated with the DB cluster. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^sg-[a-z0-9]+$ vpcSubnetIds A list of VPC subnet IDs associated with the DB cluster. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^subnet-[a-z0-9]+$ Response Elements API Version 2023-01-27 44 Timestream for InfluxDB Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2023-01-27 45 Timestream for InfluxDB • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 46 API Reference Timestream for InfluxDB GetDbInstance Returns a Timestream for InfluxDB DB instance. Request Syntax { "identifier": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. identifier The id of the DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes Response Syntax { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", GetDbInstance API Version 2023-01-27 47 Timestream for InfluxDB API Reference "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. allocatedStorage The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. arn The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Response Elements API Version 2023-01-27 48 API Reference Timestream for InfluxDB availabilityZone The Availability Zone in which the DB instance resides. Type: String dbClusterId Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbInstanceType The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid 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 dbParameterGroupIdentifier The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbStorageType The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 deploymentType Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Response Elements API Version 2023-01-27 49 Timestream for InfluxDB Type: String API Reference Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY endpoint The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ influxAuthParametersSecretArn 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.
|
TimestreamInfluxDB-API-011
|
TimestreamInfluxDB-API.pdf
| 11 |
deployed as Single-AZ or with a MultiAZ Standby for High availability. Response Elements API Version 2023-01-27 49 Timestream for InfluxDB Type: String API Reference Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY endpoint The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ influxAuthParametersSecretArn 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. Type: String instanceMode Specifies the DbInstance's role in the cluster. Type: String Valid Values: PRIMARY | STANDBY | REPLICA logDeliveryConfiguration Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: LogDeliveryConfiguration object name The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Response Elements API Version 2023-01-27 50 Timestream for InfluxDB Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ networkType 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. Type: String Valid Values: IPV4 | DUAL port The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. publiclyAccessible Indicates if the DB instance has a public IP to facilitate access. Type: Boolean secondaryAvailabilityZone The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String status The status of the DB instance. Type: String Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE Response Elements API Version 2023-01-27 51 Timestream for InfluxDB vpcSecurityGroupIds API Reference A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^sg-[a-z0-9]+$ vpcSubnetIds A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^subnet-[a-z0-9]+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 Errors API Version 2023-01-27 52 Timestream for InfluxDB ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. API Reference HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 53 Timestream for InfluxDB API Reference GetDbParameterGroup Returns a Timestream for InfluxDB DB parameter group. Request Syntax { "identifier": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. identifier The id of the DB parameter group. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes Response Syntax { "arn": "string", "description": "string", "id": "string", "name": "string", "parameters": { ... } } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetDbParameterGroup API Version 2023-01-27 54 Timestream for InfluxDB API Reference The following data is returned in JSON format by the service. arn The Amazon Resource Name (ARN) of the DB parameter group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ description A description of the DB parameter group. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ name The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ parameters The parameters that comprise the DB parameter
|
TimestreamInfluxDB-API-012
|
TimestreamInfluxDB-API.pdf
| 12 |
arn The Amazon Resource Name (ARN) of the DB parameter group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ description A description of the DB parameter group. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ name The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ parameters The parameters that comprise the DB parameter group. Type: Parameters object Response Elements API Version 2023-01-27 55 Timestream for InfluxDB API Reference Note: This object is a Union. Only one member of this object can be specified or returned. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2023-01-27 56 API Reference Timestream for InfluxDB • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 57 Timestream for InfluxDB ListDbClusters Returns a list of Timestream for InfluxDB DB clusters. API Reference Request Syntax { "maxResults": number, "nextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. maxResults 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation. Type: String Length Constraints: Minimum length of 1. Required: No ListDbClusters API Version 2023-01-27 58 API Reference Timestream for InfluxDB Response Syntax { "items": [ { "allocatedStorage": number, "arn": "string", "dbInstanceType": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "name": "string", "networkType": "string", "port": number, "readerEndpoint": "string", "status": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. items A list of Timestream for InfluxDB cluster summaries. Type: Array of DbClusterSummary objects nextToken Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length Constraints: Minimum length of 1. Response Syntax API Version 2023-01-27 59 Timestream for InfluxDB Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2023-01-27 60 Timestream for InfluxDB • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 61 Timestream for InfluxDB ListDbInstances Returns a list of Timestream for InfluxDB DB instances. API Reference Request Syntax { "maxResults": number, "nextToken": "string" } Request Parameters For information about the parameters that are common to all actions,
|
TimestreamInfluxDB-API-013
|
TimestreamInfluxDB-API.pdf
| 13 |
SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2023-01-27 60 Timestream for InfluxDB • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 61 Timestream for InfluxDB ListDbInstances Returns a list of Timestream for InfluxDB DB instances. API Reference Request Syntax { "maxResults": number, "nextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. maxResults 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation. Type: String Length Constraints: Minimum length of 1. Required: No ListDbInstances API Version 2023-01-27 62 API Reference Timestream for InfluxDB Response Syntax { "items": [ { "allocatedStorage": number, "arn": "string", "dbInstanceType": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "name": "string", "networkType": "string", "port": number, "status": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. items A list of Timestream for InfluxDB DB instance summaries. Type: Array of DbInstanceSummary objects nextToken Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length Constraints: Minimum length of 1. Response Syntax API Version 2023-01-27 63 Timestream for InfluxDB Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2023-01-27 64 Timestream for InfluxDB • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 65 Timestream for InfluxDB API Reference ListDbInstancesForCluster Returns a list of Timestream for InfluxDB clusters. Request Syntax { "dbClusterId": "string", "maxResults": number, "nextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. dbClusterId Service-generated unique identifier of the DB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes maxResults 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ListDbInstancesForCluster API Version 2023-01-27 66 Timestream for InfluxDB nextToken API Reference The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation. Type: String Length Constraints: Minimum length of 1. Required: No Response Syntax { "items": [ { "allocatedStorage": number, "arn": "string", "dbInstanceType": "string", "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "instanceMode": "string", "name": "string", "networkType": "string", "port": number, "status": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. items A list of Timestream for InfluxDB instance summaries belonging to the cluster. Response Syntax API Version 2023-01-27 67 Timestream for InfluxDB API Reference Type: Array of DbInstanceForClusterSummary objects nextToken Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length
|
TimestreamInfluxDB-API-014
|
TimestreamInfluxDB-API.pdf
| 14 |
"id": "string", "instanceMode": "string", "name": "string", "networkType": "string", "port": number, "status": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. items A list of Timestream for InfluxDB instance summaries belonging to the cluster. Response Syntax API Version 2023-01-27 67 Timestream for InfluxDB API Reference Type: Array of DbInstanceForClusterSummary objects nextToken Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length Constraints: Minimum length of 1. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 Errors API Version 2023-01-27 68 Timestream for InfluxDB See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 69 Timestream for InfluxDB API Reference ListDbParameterGroups Returns a list of Timestream for InfluxDB DB parameter groups. Request Syntax { "maxResults": number, "nextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. maxResults 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. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation. Type: String Length Constraints: Minimum length of 1. Required: No ListDbParameterGroups API Version 2023-01-27 70 API Reference Timestream for InfluxDB Response Syntax { "items": [ { "arn": "string", "description": "string", "id": "string", "name": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. items A list of Timestream for InfluxDB DB parameter group summaries. Type: Array of DbParameterGroupSummary objects nextToken Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off. Type: String Length Constraints: Minimum length of 1. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. Response Syntax API Version 2023-01-27 71 Timestream for InfluxDB HTTP Status Code: 400 InternalServerException API Reference The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 72 Timestream for InfluxDB API Reference See Also API Version 2023-01-27 73 Timestream for InfluxDB API Reference ListTagsForResource A list of tags applied to the resource. Request Syntax { "resourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceArn The Amazon Resource Name (ARN) of the tagged resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Required: Yes Response Syntax { "tags": {
|
TimestreamInfluxDB-API-015
|
TimestreamInfluxDB-API.pdf
| 15 |
• AWS SDK for Ruby V3 See Also API Version 2023-01-27 72 Timestream for InfluxDB API Reference See Also API Version 2023-01-27 73 Timestream for InfluxDB API Reference ListTagsForResource A list of tags applied to the resource. Request Syntax { "resourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceArn The Amazon Resource Name (ARN) of the tagged resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Required: Yes Response Syntax { "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. ListTagsForResource API Version 2023-01-27 74 Timestream for InfluxDB API Reference The following data is returned in JSON format by the service. tags A list of tags used to categorize and track resources. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python Errors API Version 2023-01-27 75 Timestream for InfluxDB • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 76 Timestream for InfluxDB TagResource API Reference Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources. Request Syntax { "resourceArn": "string", "tags": { "string" : "string" } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceArn The Amazon Resource Name (ARN) of the tagged resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Required: Yes tags A list of tags used to categorize and track resources. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. TagResource API Version 2023-01-27 77 Timestream for InfluxDB API Reference Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ServiceQuotaExceededException The request exceeds the service quota. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python Response Elements API Version 2023-01-27 78 Timestream for InfluxDB • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 79 API Reference Timestream for InfluxDB UntagResource Removes the tag from the specified resource. Request Syntax { "resourceArn": "string", "tagKeys": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceArn The Amazon Resource Name (ARN) of the tagged resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Required: Yes tagKeys The keys used to identify the tags. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes UntagResource API Version 2023-01-27 80 Timestream for InfluxDB Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following:
|
TimestreamInfluxDB-API-016
|
TimestreamInfluxDB-API.pdf
| 16 |
number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes UntagResource API Version 2023-01-27 80 Timestream for InfluxDB Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Response Elements API Version 2023-01-27 81 API Reference Timestream for InfluxDB UpdateDbCluster Updates a Timestream for InfluxDB cluster. Request Syntax { "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "failoverMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "port": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. dbClusterId Service-generated unique identifier of the DB cluster to update. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes dbInstanceType Update the DB cluster to use the specified DB instance Type. Type: String UpdateDbCluster API Version 2023-01-27 82 Timestream for InfluxDB API Reference Valid 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 Required: No dbParameterGroupIdentifier Update the DB cluster to use the specified DB parameter group. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: No failoverMode Update the DB cluster's failover behavior. Type: String Valid Values: AUTOMATIC | NO_FAILOVER Required: No logDeliveryConfiguration The log delivery configuration to apply to the DB cluster. Type: LogDeliveryConfiguration object Required: No port Update the DB cluster to use the specified port. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No Request Parameters API Version 2023-01-27 83 Timestream for InfluxDB Response Syntax { "dbClusterStatus": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. dbClusterStatus The status of the DB cluster. Type: String Valid Values: CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 ConflictException The request conflicts with an existing resource in Timestream for InfluxDB. HTTP Status Code: 400 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 Response Syntax API Version 2023-01-27 84 API Reference Timestream for InfluxDB ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 85 API Reference Timestream for InfluxDB UpdateDbInstance Updates a Timestream for InfluxDB DB instance. Request Syntax { "allocatedStorage": number, "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", "dbStorageType": "string", "deploymentType": "string", "identifier": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "port": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. allocatedStorage The amount of storage to allocate for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. Required: No dbInstanceType The Timestream for InfluxDB DB instance type to run InfluxDB on. Type: String UpdateDbInstance API Version 2023-01-27 86 Timestream for InfluxDB API Reference Valid 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 Required: No dbParameterGroupIdentifier The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured.
|
TimestreamInfluxDB-API-017
|
TimestreamInfluxDB-API.pdf
| 17 |
the following data in JSON format. allocatedStorage The amount of storage to allocate for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. Required: No dbInstanceType The Timestream for InfluxDB DB instance type to run InfluxDB on. Type: String UpdateDbInstance API Version 2023-01-27 86 Timestream for InfluxDB API Reference Valid 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 Required: No dbParameterGroupIdentifier 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. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: No dbStorageType The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Required: No deploymentType Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Type: String Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY Required: No identifier The id of the DB instance. Request Parameters API Version 2023-01-27 87 Timestream for InfluxDB Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes logDeliveryConfiguration Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: LogDeliveryConfiguration object Required: No port 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 Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No Response Syntax { "allocatedStorage": number, "arn": "string", "availabilityZone": "string", "dbClusterId": "string", "dbInstanceType": "string", "dbParameterGroupIdentifier": "string", Response Syntax API Version 2023-01-27 88 Timestream for InfluxDB API Reference "dbStorageType": "string", "deploymentType": "string", "endpoint": "string", "id": "string", "influxAuthParametersSecretArn": "string", "instanceMode": "string", "logDeliveryConfiguration": { "s3Configuration": { "bucketName": "string", "enabled": boolean } }, "name": "string", "networkType": "string", "port": number, "publiclyAccessible": boolean, "secondaryAvailabilityZone": "string", "status": "string", "vpcSecurityGroupIds": [ "string" ], "vpcSubnetIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. allocatedStorage The amount of storage allocated for your DB storage type (in gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. arn The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Response Elements API Version 2023-01-27 89 Timestream for InfluxDB API Reference 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}$ availabilityZone The Availability Zone in which the DB instance resides. Type: String dbClusterId Specifies the DbCluster to which this DbInstance belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbInstanceType The Timestream for InfluxDB instance type that InfluxDB runs on. Type: String Valid 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 dbParameterGroupIdentifier The id of the DB parameter group assigned to your DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ dbStorageType The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Response Elements API Version 2023-01-27 90 Timestream for InfluxDB deploymentType API Reference Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. Type: String Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY endpoint The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Type: String id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ influxAuthParametersSecretArn 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. Type: String instanceMode Specifies the DbInstance's role in the cluster. Type: String Valid Values: PRIMARY | STANDBY | REPLICA logDeliveryConfiguration Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Type: LogDeliveryConfiguration object Response Elements API Version 2023-01-27 91 Timestream for InfluxDB name API Reference This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ networkType 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. Type: String Valid Values: IPV4 | DUAL port The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value
|
TimestreamInfluxDB-API-018
|
TimestreamInfluxDB-API.pdf
| 18 |
2023-01-27 91 Timestream for InfluxDB name API Reference This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ networkType 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. Type: String Valid Values: IPV4 | DUAL port The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. publiclyAccessible Indicates if the DB instance has a public IP to facilitate access. Type: Boolean secondaryAvailabilityZone The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. Type: String status The status of the DB instance. Response Elements API Version 2023-01-27 92 Timestream for InfluxDB Type: String API Reference Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE vpcSecurityGroupIds A list of VPC security group IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^sg-[a-z0-9]+$ vpcSubnetIds A list of VPC subnet IDs associated with the DB instance. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^subnet-[a-z0-9]+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 ConflictException The request conflicts with an existing resource in Timestream for InfluxDB. HTTP Status Code: 400 Errors API Version 2023-01-27 93 Timestream for InfluxDB InternalServerException API Reference The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found or does not exist. HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2023-01-27 94 Timestream for InfluxDB Data Types API Reference The Timestream InfluxDB API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • DbClusterSummary • DbInstanceForClusterSummary • DbInstanceSummary • DbParameterGroupSummary • Duration • InfluxDBv2Parameters • LogDeliveryConfiguration • Parameters • S3Configuration API Version 2023-01-27 95 Timestream for InfluxDB DbClusterSummary Describes a summary of a Timestream for InfluxDB cluster. API Reference Contents arn The Amazon Resource Name (ARN) of the DB cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Required: Yes id Service-generated unique identifier of the DB cluster to retrieve. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes name Customer supplied name of the Timestream for InfluxDB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ Required: Yes allocatedStorage The amount of storage allocated for your DB storage type (in gibibytes). DbClusterSummary API Version 2023-01-27 96 Timestream for InfluxDB Type: Integer API Reference Valid Range: Minimum value of 20. Maximum value of 15360. Required: No dbInstanceType The Timestream for InfluxDB DB instance type that InfluxDB runs on. Type: String Valid 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 Required: No dbStorageType The Timestream for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Required: No deploymentType Deployment type of the DB cluster Type: String Valid Values: MULTI_NODE_READ_REPLICAS Required: No endpoint The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations. Type: String Required: No Contents API Version 2023-01-27 97 Timestream for InfluxDB networkType API Reference 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. Type: String
|
TimestreamInfluxDB-API-019
|
TimestreamInfluxDB-API.pdf
| 19 |
for InfluxDB DB storage type that InfluxDB stores data on. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Required: No deploymentType Deployment type of the DB cluster Type: String Valid Values: MULTI_NODE_READ_REPLICAS Required: No endpoint The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations. Type: String Required: No Contents API Version 2023-01-27 97 Timestream for InfluxDB networkType API Reference 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. Type: String Valid Values: IPV4 | DUAL Required: No port The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No readerEndpoint The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations. Type: String Required: No status The status of the DB cluster. Type: String Valid Values: CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2023-01-27 98 Timestream for InfluxDB • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 99 Timestream for InfluxDB API Reference DbInstanceForClusterSummary Contains a summary of a DB instance belonging to a DB cluster. Contents arn The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Required: Yes id The service-generated unique identifier of the DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes name A service-generated name for the DB instance based on the customer-supplied name for the DB cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ Required: Yes DbInstanceForClusterSummary API Version 2023-01-27 100 Timestream for InfluxDB allocatedStorage API Reference The amount of storage allocated for your DB storage type in GiB (gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. Required: No dbInstanceType The Timestream for InfluxDB instance type to run InfluxDB on. Type: String Valid 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 Required: No dbStorageType The storage type for your DB instance. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Required: No deploymentType Specifies the deployment type if applicable. Type: String Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY Required: No endpoint The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Contents API Version 2023-01-27 101 API Reference Timestream for InfluxDB Type: String Required: No instanceMode Specifies the DB instance's role in the cluster. Type: String Valid Values: PRIMARY | STANDBY | REPLICA Required: No networkType 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. Type: String Valid Values: IPV4 | DUAL Required: No port The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No status The status of the DB instance. Type: String Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE Required: No Contents API Version 2023-01-27 102 Timestream for InfluxDB See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-01-27 103 Timestream for InfluxDB API Reference DbInstanceSummary Contains a summary of a DB instance. Contents arn The Amazon Resource Name (ARN) of the DB instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Required: Yes id The service-generated unique identifier of the DB instance. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes name This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ Required: Yes DbInstanceSummary API Version 2023-01-27 104 Timestream for InfluxDB allocatedStorage API Reference The amount of storage to allocate for your DbStorageType in GiB (gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. Required: No dbInstanceType The Timestream for InfluxDB instance type to run InfluxDB on. Type: String Valid 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
|
TimestreamInfluxDB-API-020
|
TimestreamInfluxDB-API.pdf
| 20 |
identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands. Type: String Length Constraints: Minimum length of 3. Maximum length of 40. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ Required: Yes DbInstanceSummary API Version 2023-01-27 104 Timestream for InfluxDB allocatedStorage API Reference The amount of storage to allocate for your DbStorageType in GiB (gibibytes). Type: Integer Valid Range: Minimum value of 20. Maximum value of 15360. Required: No dbInstanceType The Timestream for InfluxDB instance type to run InfluxDB on. Type: String Valid 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 Required: No dbStorageType The storage type for your DB instance. Type: String Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 Required: No deploymentType Single-Instance or with a MultiAZ Standby for High availability. Type: String Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY Required: No endpoint The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. Contents API Version 2023-01-27 105 Timestream for InfluxDB Type: String Required: No networkType API Reference 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. Type: String Valid Values: IPV4 | DUAL Required: No port The port number on which InfluxDB accepts connections. Type: Integer Valid Range: Minimum value of 1024. Maximum value of 65535. Required: No status The status of the DB instance. Type: String Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED | UPDATING_DEPLOYMENT_TYPE | UPDATING_INSTANCE_TYPE Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2023-01-27 106 Timestream for InfluxDB • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 107 Timestream for InfluxDB API Reference DbParameterGroupSummary Contains a summary of a DB parameter group. Contents arn The Amazon Resource Name (ARN) of the DB parameter group. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. 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}$ Required: Yes id A service-generated unique identifier. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z0-9]+$ Required: Yes name This customer-supplied name uniquely identifies the parameter group. Type: String Length Constraints: Minimum length of 3. Maximum length of 64. Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ Required: Yes description A description of the DB parameter group. DbParameterGroupSummary API Version 2023-01-27 108 Timestream for InfluxDB Type: String Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2023-01-27 109 Timestream for InfluxDB Duration Duration for InfluxDB parameters in Timestream for InfluxDB. API Reference Contents durationType The type of duration for InfluxDB parameters. Type: String Valid Values: hours | minutes | seconds | milliseconds Required: Yes value The value of duration for InfluxDB parameters. Type: Long Valid Range: Minimum value of 0. Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Duration API Version 2023-01-27 110 Timestream for InfluxDB API Reference InfluxDBv2Parameters All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB. Contents fluxLogEnabled Include option to show detailed logs for Flux queries. Default: false Type: Boolean Required: No httpIdleTimeout Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout. Default: 3 minutes Type: Duration object Required: No httpReadHeaderTimeout Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout. Default: 10 seconds Type: Duration object Required: No httpReadTimeout Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout. Default: 0 Type: Duration object InfluxDBv2Parameters API Version 2023-01-27 111 Timestream for InfluxDB Required: No httpWriteTimeout API Reference Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout. Default: 0 Type: Duration object Required: No influxqlMaxSelectBuckets Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets. Default: 0 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No influxqlMaxSelectPoint 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 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No influxqlMaxSelectSeries
|
TimestreamInfluxDB-API-021
|
TimestreamInfluxDB-API.pdf
| 21 |
write requests. Set to 0 for no timeout. Default: 0 Type: Duration object Required: No influxqlMaxSelectBuckets Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets. Default: 0 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No influxqlMaxSelectPoint 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 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No influxqlMaxSelectSeries Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series. Default: 0 Contents API Version 2023-01-27 112 Timestream for InfluxDB Type: Long API Reference Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No logLevel Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified. Default: info Type: String Valid Values: debug | info | error Required: No metricsDisabled Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics. Default: false Type: Boolean Required: No noTasks Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks. Default: false Type: Boolean Required: No pprofDisabled Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging. Default: true Contents API Version 2023-01-27 113 Timestream for InfluxDB Type: Boolean Required: No queryConcurrency API Reference Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries. Default: 0 Type: Integer Valid Range: Minimum value of 0. Maximum value of 256. Required: No queryInitialMemoryBytes Initial bytes of memory allocated for a query. Default: 0 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No queryMaxMemoryBytes 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 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No queryMemoryBytes Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes. Contents API Version 2023-01-27 114 Timestream for InfluxDB Default: 0 Type: Long API Reference Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No queryQueueSize 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 Type: Integer Valid Range: Minimum value of 0. Maximum value of 256. Required: No sessionLength Specifies the Time to Live (TTL) in minutes for newly created user sessions. Default: 60 Type: Integer Valid Range: Minimum value of 1. Maximum value of 2880. Required: No sessionRenewDisabled 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 Type: Boolean Required: No Contents API Version 2023-01-27 115 Timestream for InfluxDB storageCacheMaxMemorySize API Reference 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 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No storageCacheSnapshotMemorySize 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 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No storageCacheSnapshotWriteColdDuration 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 Type: Duration object Required: No storageCompactFullWriteColdDuration 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 Type: Duration object Contents API Version 2023-01-27 116 Timestream for InfluxDB Required: No storageCompactThroughputBurst API Reference Rate limit (in bytes per second) that TSM compactions can write to disk. Default: 50331648 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No storageMaxConcurrentCompactions 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 Type: Integer Valid Range: Minimum value of 0.
|
TimestreamInfluxDB-API-022
|
TimestreamInfluxDB-API.pdf
| 22 |
Default: 4 hours Type: Duration object Contents API Version 2023-01-27 116 Timestream for InfluxDB Required: No storageCompactThroughputBurst API Reference Rate limit (in bytes per second) that TSM compactions can write to disk. Default: 50331648 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No storageMaxConcurrentCompactions 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 Type: Integer Valid Range: Minimum value of 0. Maximum value of 64. Required: No storageMaxIndexLogFileSize 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 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No storageNoValidateFieldSize Skip field size validation on incoming write requests. Default: false Contents API Version 2023-01-27 117 Timestream for InfluxDB Type: Boolean Required: No storageRetentionCheckInterval API Reference Interval of retention policy enforcement checks. Must be greater than 0. Default: 30 minutes Type: Duration object Required: No storageSeriesFileMaxConcurrentSnapshotCompactions Maximum number of snapshot compactions that can run concurrently across all series partitions in a database. Default: 0 Type: Integer Valid Range: Minimum value of 0. Maximum value of 64. Required: No storageSeriesIdSetCacheSize 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 Type: Long Valid Range: Minimum value of 0. Maximum value of 1000000000000. Required: No storageWalMaxConcurrentWrites 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. Contents API Version 2023-01-27 118 Timestream for InfluxDB Default: 0 Type: Integer Valid Range: Minimum value of 0. Maximum value of 256. Required: No storageWalMaxWriteDelay API Reference 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 Type: Duration object Required: No tracingType Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default. Type: String Valid Values: log | jaeger Required: No uiDisabled Disable the InfluxDB user interface (UI). The UI is enabled by default. Default: false Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2023-01-27 119 Timestream for InfluxDB • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2023-01-27 120 Timestream for InfluxDB API Reference LogDeliveryConfiguration Configuration for sending InfluxDB engine logs to send to specified S3 bucket. Contents s3Configuration Configuration for S3 bucket log delivery. Type: S3Configuration object Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LogDeliveryConfiguration API Version 2023-01-27 121 Timestream for InfluxDB Parameters The parameters that comprise the parameter group. Contents Important API Reference This data type is a UNION, so only one of the following members can be specified when used or returned. InfluxDBv2 All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB. Type: InfluxDBv2Parameters object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Parameters API Version 2023-01-27 122 API Reference Timestream for InfluxDB S3Configuration Configuration for S3 bucket log delivery. Contents bucketName The name of the S3 bucket to deliver logs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+$ Required: Yes enabled Indicates whether log delivery to the S3 bucket is enabled. Type: Boolean Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3Configuration API Version 2023-01-27 123 Timestream for InfluxDB API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for
|
TimestreamInfluxDB-API-023
|
TimestreamInfluxDB-API.pdf
| 23 |
Maximum length of 63. Pattern: ^[0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+$ Required: Yes enabled Indicates whether log delivery to the S3 bucket is enabled. Type: Boolean Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3Configuration API Version 2023-01-27 123 Timestream for InfluxDB API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2023-01-27 124 Timestream for InfluxDB API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2023-01-27 125 Timestream for InfluxDB Type: string Required: Conditional X-Amz-SignedHeaders API Reference Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2023-01-27 126 Timestream for InfluxDB API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 API Version 2023-01-27 127 Timestream for InfluxDB RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to
|
TimestreamInfluxDB-API-024
|
TimestreamInfluxDB-API.pdf
| 24 |
service. HTTP Status Code: 403 API Version 2023-01-27 127 Timestream for InfluxDB RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2023-01-27 128
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.