/AWS1/CL_TSIDELETEDBINSTOUTPUT¶
DeleteDbInstanceOutput
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_ID TYPE /AWS1/TSIDBINSTANCEID /AWS1/TSIDBINSTANCEID¶
A service-generated unique identifier.
IV_NAME TYPE /AWS1/TSIDBINSTANCENAME /AWS1/TSIDBINSTANCENAME¶
The customer-supplied name that 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.
IT_VPCSUBNETIDS TYPE /AWS1/CL_TSIVPCSUBNETIDLIST_W=>TT_VPCSUBNETIDLIST TT_VPCSUBNETIDLIST¶
A list of VPC subnet IDs associated with 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_DBINSTANCETYPE TYPE /AWS1/TSIDBINSTANCETYPE /AWS1/TSIDBINSTANCETYPE¶
The Timestream for InfluxDB instance type that InfluxDB runs on.
IV_DBSTORAGETYPE TYPE /AWS1/TSIDBSTORAGETYPE /AWS1/TSIDBSTORAGETYPE¶
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
IV_ALLOCATEDSTORAGE TYPE /AWS1/TSIALLOCATEDSTORAGE /AWS1/TSIALLOCATEDSTORAGE¶
The amount of storage allocated for your DB storage type (in gibibytes).
IV_DEPLOYMENTTYPE TYPE /AWS1/TSIDEPLOYMENTTYPE /AWS1/TSIDEPLOYMENTTYPE¶
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
IV_PUBLICLYACCESSIBLE TYPE /AWS1/TSIBOOLEAN /AWS1/TSIBOOLEAN¶
Indicates if the DB instance has a public IP to facilitate access.
IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_TSIVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST¶
A list of VPC security group IDs associated with the DB instance.
IV_DBPARAMETERGROUPID TYPE /AWS1/TSIDBPARAMETERGROUPID /AWS1/TSIDBPARAMETERGROUPID¶
The id of the DB parameter group assigned to your DB instance.
IV_AVAILABILITYZONE TYPE /AWS1/TSISTRING /AWS1/TSISTRING¶
The Availability Zone in which the DB instance resides.
IV_SECONDARYAVAILABILITYZONE TYPE /AWS1/TSISTRING /AWS1/TSISTRING¶
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
IO_LOGDELIVERYCONFIGURATION TYPE REF TO /AWS1/CL_TSILOGDELIVERYCONF /AWS1/CL_TSILOGDELIVERYCONF¶
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
IV_INFLUXAUTHPARAMSSECRETARN TYPE /AWS1/TSISTRING /AWS1/TSISTRING¶
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.
Queryable Attributes¶
id¶
A service-generated unique identifier.
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¶
The customer-supplied name that 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 |
dbInstanceType¶
The Timestream for InfluxDB instance type that InfluxDB runs 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 Timestream for InfluxDB DB storage type that InfluxDB stores data on.
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 allocated for your DB storage type (in 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¶
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ 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 |
vpcSubnetIds¶
A list of VPC subnet IDs associated with the DB instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCSUBNETIDS() |
Getter for VPCSUBNETIDS, with configurable default |
ASK_VPCSUBNETIDS() |
Getter for VPCSUBNETIDS w/ exceptions if field has no value |
HAS_VPCSUBNETIDS() |
Determine if VPCSUBNETIDS has a value |
publiclyAccessible¶
Indicates if the DB instance has a public IP to facilitate access.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PUBLICLYACCESSIBLE() |
Getter for PUBLICLYACCESSIBLE, with configurable default |
ASK_PUBLICLYACCESSIBLE() |
Getter for PUBLICLYACCESSIBLE w/ exceptions if field has no |
HAS_PUBLICLYACCESSIBLE() |
Determine if PUBLICLYACCESSIBLE has a value |
vpcSecurityGroupIds¶
A list of VPC security group IDs associated with the DB instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCSECURITYGROUPIDS() |
Getter for VPCSECURITYGROUPIDS, with configurable default |
ASK_VPCSECURITYGROUPIDS() |
Getter for VPCSECURITYGROUPIDS w/ exceptions if field has no |
HAS_VPCSECURITYGROUPIDS() |
Determine if VPCSECURITYGROUPIDS has a value |
dbParameterGroupIdentifier¶
The id of the DB parameter group assigned to your DB instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DBPARAMETERGROUPID() |
Getter for DBPARAMETERGROUPIDENTIFIER, with configurable def |
ASK_DBPARAMETERGROUPID() |
Getter for DBPARAMETERGROUPIDENTIFIER w/ exceptions if field |
HAS_DBPARAMETERGROUPID() |
Determine if DBPARAMETERGROUPIDENTIFIER has a value |
availabilityZone¶
The Availability Zone in which the DB instance resides.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE, with configurable default |
ASK_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE w/ exceptions if field has no va |
HAS_AVAILABILITYZONE() |
Determine if AVAILABILITYZONE has a value |
secondaryAvailabilityZone¶
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECONDARYAZ() |
Getter for SECONDARYAVAILABILITYZONE, with configurable defa |
ASK_SECONDARYAZ() |
Getter for SECONDARYAVAILABILITYZONE w/ exceptions if field |
HAS_SECONDARYAZ() |
Determine if SECONDARYAVAILABILITYZONE has a value |
logDeliveryConfiguration¶
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGDELIVERYCONFIGURATION() |
Getter for LOGDELIVERYCONFIGURATION |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INFLUXAUTHPARMSSECRETARN() |
Getter for INFLUXAUTHPARAMSSECRETARN, with configurable defa |
ASK_INFLUXAUTHPARMSSECRETARN() |
Getter for INFLUXAUTHPARAMSSECRETARN w/ exceptions if field |
HAS_INFLUXAUTHPARMSSECRETARN() |
Determine if INFLUXAUTHPARAMSSECRETARN has a value |