/AWS1/CL_TSIDBINSTANCESUMMARY¶
Contains a summary of a DB instance.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_id TYPE /AWS1/TSIDBINSTANCEID /AWS1/TSIDBINSTANCEID¶
The service-generated unique identifier of the DB instance.
iv_name TYPE /AWS1/TSIDBINSTANCENAME /AWS1/TSIDBINSTANCENAME¶
This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
iv_arn TYPE /AWS1/TSIARN /AWS1/TSIARN¶
The Amazon Resource Name (ARN) of the DB instance.
Optional arguments:¶
iv_status TYPE /AWS1/TSISTATUS /AWS1/TSISTATUS¶
The status of the DB instance.
iv_endpoint TYPE /AWS1/TSISTRING /AWS1/TSISTRING¶
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
iv_port TYPE /AWS1/TSIPORT /AWS1/TSIPORT¶
The port number on which InfluxDB accepts connections.
iv_networktype TYPE /AWS1/TSINETWORKTYPE /AWS1/TSINETWORKTYPE¶
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.
iv_dbinstancetype TYPE /AWS1/TSIDBINSTANCETYPE /AWS1/TSIDBINSTANCETYPE¶
The Timestream for InfluxDB instance type to run InfluxDB on.
iv_dbstoragetype TYPE /AWS1/TSIDBSTORAGETYPE /AWS1/TSIDBSTORAGETYPE¶
The storage type for your DB instance.
iv_allocatedstorage TYPE /AWS1/TSIALLOCATEDSTORAGE /AWS1/TSIALLOCATEDSTORAGE¶
The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
iv_deploymenttype TYPE /AWS1/TSIDEPLOYMENTTYPE /AWS1/TSIDEPLOYMENTTYPE¶
Single-Instance or with a MultiAZ Standby for High availability.
Queryable Attributes¶
id¶
The service-generated unique identifier of the DB instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
name¶
This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
arn¶
The Amazon Resource Name (ARN) of the DB instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
status¶
The status of the DB instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
endpoint¶
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINT() |
Getter for ENDPOINT, with configurable default |
ASK_ENDPOINT() |
Getter for ENDPOINT w/ exceptions if field has no value |
HAS_ENDPOINT() |
Determine if ENDPOINT has a value |
port¶
The port number on which InfluxDB accepts connections.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PORT() |
Getter for PORT, with configurable default |
ASK_PORT() |
Getter for PORT w/ exceptions if field has no value |
HAS_PORT() |
Determine if PORT has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKTYPE() |
Getter for NETWORKTYPE, with configurable default |
ASK_NETWORKTYPE() |
Getter for NETWORKTYPE w/ exceptions if field has no value |
HAS_NETWORKTYPE() |
Determine if NETWORKTYPE has a value |
dbInstanceType¶
The Timestream for InfluxDB instance type to run InfluxDB on.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBINSTANCETYPE() |
Getter for DBINSTANCETYPE, with configurable default |
ASK_DBINSTANCETYPE() |
Getter for DBINSTANCETYPE w/ exceptions if field has no valu |
HAS_DBINSTANCETYPE() |
Determine if DBINSTANCETYPE has a value |
dbStorageType¶
The storage type for your DB instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBSTORAGETYPE() |
Getter for DBSTORAGETYPE, with configurable default |
ASK_DBSTORAGETYPE() |
Getter for DBSTORAGETYPE w/ exceptions if field has no value |
HAS_DBSTORAGETYPE() |
Determine if DBSTORAGETYPE has a value |
allocatedStorage¶
The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALLOCATEDSTORAGE() |
Getter for ALLOCATEDSTORAGE, with configurable default |
ASK_ALLOCATEDSTORAGE() |
Getter for ALLOCATEDSTORAGE w/ exceptions if field has no va |
HAS_ALLOCATEDSTORAGE() |
Determine if ALLOCATEDSTORAGE has a value |
deploymentType¶
Single-Instance or with a MultiAZ Standby for High availability.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPLOYMENTTYPE() |
Getter for DEPLOYMENTTYPE, with configurable default |
ASK_DEPLOYMENTTYPE() |
Getter for DEPLOYMENTTYPE w/ exceptions if field has no valu |
HAS_DEPLOYMENTTYPE() |
Determine if DEPLOYMENTTYPE has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_DBINSTANCESUMMARYLIST¶
TYPES TT_DBINSTANCESUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_TSIDBINSTANCESUMMARY WITH DEFAULT KEY
.