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
- 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.
Required: No
-
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.
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\-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.
- 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
- 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: