CI Class DB Cluster Service

Inheritance diagram for DB Cluster Service

Summary

Display NameDB Cluster Service
Namedb_cluster_service
DescriptionA generic class to represent all kinds of db cluster services provided by public cloud.

Attributes

Attributes defined for DB Cluster Service
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
activity_stream_kinesis_stream_nameActivity Stream Kinesis Stream Namestring[100][Summary] The name of the Amazon Kinesis data stream used for the database activity stream. [Collection - AWS] Call DBCluster().getActivityStreamKinesisStreamName()truefalsefalse
activity_stream_kms_key_idActivity Stream Kms Key Idstring[100][Summary] The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. [Collection - AWS] Call DBCluster().getActivityStreamKmsKeyId()truefalsefalse
activity_stream_modeActivity Stream Modestring[100][Summary] The mode of the database activity stream. [Collection - AWS] Call DBCluster().getActivityStreamMode()truefalsefalse
activity_stream_statusActivity Stream Statusstring[100][Summary] The status of the database activity stream. [Collection - AWS] Call DBCluster().getActivityStreamStatus()truefalsefalse
allocated_storageAllocated Storageinteger[Summary] For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). [Collection - AWS] Call DBCluster().getAllocatedStorage()truefalsefalse
automatic_restart_timeAutomatic Restart Timedate[Summary] The time when a stopped DB cluster is restarted automatically. [Collection - AWS] Call DBCluster().getAutomaticRestartTime()truefalsefalse
backup_retention_periodBackup Retention Periodinteger[Summary] Specifies the number of days for which automatic DB snapshots are retained. [Collection - AWS] Call DBCluster().getBackupRetentionPeriod()truefalsefalse
capacityCapacityinteger[Summary] The current capacity of an Aurora Serverless v1 DB cluster. [Collection - AWS] Call DBCluster().getCapacity()truefalsefalse
character_set_nameCharacter Set Namestring[100][Summary] If present, specifies the name of the character set that this cluster is associated with. [Collection - AWS] Call DBCluster().getCharacterSetName()truefalsefalse
clone_group_idClone Group Idstring[100][Summary] Identifies the clone group to which the DB cluster is associated. [Collection - AWS] Call DBCluster().getCloneGroupId()truefalsefalse
created_dateDB Cluster Create Datedate[Summary] Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). [Collection - AWS] Call DBCluster().getClusterCreateTime()truefalsefalse
cross_account_cloneCross Account Cloneboolean[Summary] Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. [Collection - AWS] Call DBCluster().getCrossAccountClone()truefalsefalse
database_authentication_enabledIAM Database Authentication Enabledboolean[Summary] True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. [Collection - AWS] Call DBCluster().getIAMDatabaseAuthenticationEnabled()truefalsefalse
db_cluster_idDB Cluster Idstring[100][Summary] Contains a user-supplied DB cluster identifier. [Collection - AWS] Call DBCluster().getDBClusterIdentifier()truefalsefalse
db_cluster_instance_classDB Cluster Instance Classstring[50][Summary] The name of the compute and memory capacity class of the DB instance. [Collection - AWS] Call DBCluster().getDBClusterInstanceClass()truefalsefalse
db_cluster_resource_idDB Cluster Resource Idstring[200][Summary] The Amazon Web Services Region-unique, immutable identifier for the DB cluster. [Collection - AWS] Call DBCluster().getDbClusterResourceId()truefalsefalse
db_nameDatabase Namestring[50][Summary] Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. [Collection - AWS] Call DBCluster().getDatabaseName()truefalsefalse
deletion_protectionDeletion Protectionboolean[Summary] Indicates if the DB cluster has deletion protection enabled. [Collection - AWS] Call DBCluster().getDeletionProtection()truefalsefalse
earliest_restorable_timeDB Cluster Earliest Restorable Timedate[Summary] The earliest time to which a database can be restored with point-in-time restore. [Collection - AWS] Call DBCluster().getEarliestRestorableTime()truefalsefalse
enabled_cloudwatch_logs_exportsEnabled Cloudwatch Logs Exportsstring_list[Summary] A list of log types that this DB cluster is configured to export to CloudWatch Logs. [Collection - AWS] Call DBInstance().getEnabledCloudwatchLogsExports()truefalsefalse
engineEnginestring[200][Summary] The name of the database engine to be used for this DB cluster. [Collection - AWS] Call DBCluster().getEngine()truefalsefalse
engine_modeEngine Modestring[50][Summary] The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. [Collection - AWS] Call DBCluster().getEngineMode()truefalsefalse
engine_versionEngine Versionstring[500][Summary] Indicates the database engine version. [Collection - AWS] Call DBCluster().getEngineVersion()truefalsefalse
global_write_forwarding_requestedGlobal Write Forwarding Requestedboolean[Summary] Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. [Collection - AWS] Call DBCluster().getGlobalWriteForwardingRequested()truefalsefalse
global_write_forwarding_statusGlobal Write Forwarding Statusstring[50][Summary] Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it. [Collection - AWS] Call DBCluster().getGlobalWriteForwardingStatus()truefalsefalse
http_endpoint_enabledHttp Endpoint Enabledboolean[Summary] A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled. [Collection - AWS] Call DBCluster().getHttpEndpointEnabled()truefalsefalse
iopsIopsinteger[Summary] The Provisioned IOPS (I/O operations per second) value. [Collection - AWS] Call DBCluster().getIops()truefalsefalse
kms_key_idKms Key Idstring[200][Summary] If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. Call DBCluster().getKmsKeyId()truefalsefalse
latest_restorable_timeDB Cluster Latest Restorable Timedate[Summary] Specifies the latest time to which a database can be restored with point-in-time restore. [Collection - AWS] Call DBCluster().getLatestRestorableTime()truefalsefalse
master_user_nameMaster Usernamestring[50][Summary] Contains the master username for the DB cluster. [Collection - AWS] Call DBCluster().getMasterUsername()truefalsefalse
monitoring_intervalMonitoring Intervalinteger[Summary] The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. [Collection - AWS] Call DBCluster().getMonitoringInterval()truefalsefalse
monitoring_roleMonitoring Role Arnstring[200][Summary] The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. [Collection - AWS] Call DBCluster().getMonitoringRoleArn()truefalsefalse
multi_locationMulti-Locationboolean[Summary] Specifies whether the DB cluster has instances in multiple Availability Zones. [Collection - AWS] Call DBCluster().getMultiAZ()truefalsefalse
percent_progressPercent Progressstring[50][Summary] Specifies the progress of the operation as a percentage. [Collection - AWS] Call DBCluster().getPercentProgress()truefalsefalse
performance_insights_enabledPerformance Insights Enabledboolean[Summary] True if Performance Insights is enabled for the DB cluster, and otherwise false. [Collection - AWS] Call DBCluster().getPerformanceInsightsEnabled()truefalsefalse
portPortinteger[Summary] Specifies the port that the database engine is listening on. [Collection - AWS] Call DBCluster().getPort()truefalsefalse
preferred_backup_windowPreferred Backup Windowstring[500][Summary] Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. [Collection - AWS] Call DBCluster().getPreferredBackupWindow()truefalsefalse
preferred_maintenance_windowPreferred Maintenance Windowstring[500][Summary] Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). [Collection - AWS] Call DBCluster().getPreferredMaintenanceWindow()truefalsefalse
publicly_accessiblePublicly Accessibleboolean[Summary] Specifies the accessibility options for the DB instance. [Collection - AWS] Call DBCluster().getPubliclyAccessible()truefalsefalse
replication_source_identifierReplication Source Identifierstring[200][Summary] Contains the identifier of the source DB cluster if this DB cluster is a read replica. [Collection - AWS] Call DBCluster().getReplicationSourceIdentifier()truefalsefalse
statusStatusstring[50][Summary] Specifies the current state of this DB cluster. [Collection - AWS] Call DBCluster().getStatus()truefalsefalse
storage_encryptedStorage Encryptedboolean[Summary] Specifies whether the DB cluster is encrypted. [Collection - AWS] Call DBCluster().getStorageEncrypted()truefalsefalse
storage_typeStorage Typestring[50][Summary] The storage type associated with the DB cluster. [Collection - AWS] Call DBCluster().getStorageType()truefalsefalse
Attributes defined for Cloud Service
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
cloud_resource_identifierCloud Resource Identifierstring[255]Used as unique identifier for all cloud resourcetruefalsefalse
service_typeService Typestring[100]The type of the Service. Azure: azure, AWS: awstruefalsetrue
service_vendorService Vendorstring[100]This attribute indicates the hosting platform of this node. For example, AWS, Azure, etctruefalsefalse
type_propertiesType Propertiesstring[4000]This attribute indicates the properties of the represented servicetruefalsefalse
type_serviceType of Servicestring[100]This attribute indicates the type of the service. It can be AzureBlogStorage, AzureKeyVault etctruefalsefalse
Attributes defined for InfrastructureElement
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
BODY_ICONstringsystemtruefalsetrue
codepageCodePagestring[50]System suported CodePagetruefalsetrue
credentials_idReference to the credentials dictionary entrystringReference to the credentials dictinary entrytruefalsetrue
languageLanguagestring[50]System suported languagetruefalsetrue
zone_listZone Liststring_list[256]List of management zones in which the CI is discoveredtruefalsefalse
Attributes defined for ConfigurationItem
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
ack_cleared_timelongtruefalsetrue
ack_idstring[80]truefalsetrue
bit_positionBit Positionintegertruefalsetrue
bitmap_idBitmap IDintegertruefalsetrue
BODY_ICONstringit_worldtruefalsetrue
cityCitystring[50]City locationtruefalsetrue
classificationclassification_enumtruefalsefalse
contextmenuContext Menustring_list[100]Context menutruefalsetrue
countryCountry or Provincestring[50]Country or province locationtruefalsetrue
data_tagsTagsjson[4000]A tag is a label assigned to a resource.Each tag consists of a key and a value.truefalsefalse
discovery_stateDiscovery Statediscovery_state_enumState of UD discoverytruefalsefalse
is_save_persistencyStore KPI History For Over Time ReportsbooleanfalseStore KPI history for over time reportstruefalsetrue
layerlayer_enumtruefalsefalse
metaphaseMeta Phasestring[50]Meta Phase of a CI in SMAX. The attribute is owned by SMAX exclusivelytruefalsefalse
monitor_stateMonitor Statestring[50]Monitor State of a CI in OpsB. The attribute is owned by OpsB exclusively.truefalsefalse
provision_stateProvision Statestring[50]Provision State of a CI in HCMX. The attribute is owned by HCMX exclusively.truefalsefalse
sd_typeSD Typestring[32]truefalsefalse
stateStatestring[50]State locationtruefalsetrue
track_changesTrack Configuration ChangesbooleanfalseTrack configuration changestruefalsetrue
Attributes defined for Managed Object
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
TenantOwnerOwner Tenantstring[32]The Tenant Owner IDtruefalsefalse
TenantsUsesConsumer Tenantsstring_listThe IDs of the Tenants who are associated with the CItruefalsefalse
Attributes defined for Object
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
document_listDocumentsstringDocumentstruefalsetrue
MENUxmltruefalsetrue
Attributes defined for Data
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
data_adminstateAdmin Stateadminstates_enum0Admin Statetruefalsetrue
data_allow_auto_discoveryAllow CI Updateboolean[250]truetruefalsefalse
data_changecorrstateChange Corr Statechangestates_enum0Change Statetruefalsetrue
data_changeisnewChange Is NewbooleanfalseChange Statetruefalsetrue
data_changestateChange Statechangestates_enum0Change Statetruefalsetrue
data_externalidExternal IDstring[300]external source id: snmp index, data sources index etc.truefalsetrue
data_noteNotestring[250]truefalsefalse
data_operationcorrstateOperation Corr Stateoperationstates_enum0Operation Statetruefalsetrue
data_operationisnewOperation Is NewbooleanfalseOperation Statetruefalsetrue
data_operationstateOperation Stateoperationstates_enum0Operation Statetruefalsetrue
data_originOriginstring[100]truefalsefalse
data_sourceCreated Bystring[512]truefalsefalse
data_testcorrstateTest Corr Stateteststates_enum0Test Statetruefalsetrue
data_testisnewTest Is NewbooleanfalseTest Statetruefalsetrue
data_teststateTest Stateteststates_enum0Test Statetruefalsetrue
data_updated_byLastModifiedBystring[512]truefalsefalse
descriptionDescriptionstring[1000]Descriptiontruefalsefalse
digestDigeststring[40]truefalsetrue
display_labelDisplay Labelstring[900]Used as calc attribute for displaytruefalsefalse
MENUxmltruefalsetrue
nameNamestring[900]truefalsefalse
user_labelUser Labelstring[900]Used as user labeltruefalsefalse
Attributes defined for Root
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
BODY_ICONstringgeneraltruefalsetrue
calculated_idCalculated IDbytes[16]Calculated IDtruefalsetrue
create_timeCreated TimedateWhen was this CI createdtruefalsefalse
FAMILY_ICONstringtruefalsetrue
global_idGlobal Idstring[32]A globally unique identifier for the entity represented by the objecttruefalsefalse
global_id_scopestringDefaulttruefalsetrue
last_discovered_byLastDiscoveredBystring[512]Who discovered this CItruefalsefalse
last_discovered_by_probeLastDiscoveredByProbestringWhich probe discovered this CItruefalsefalse
last_discovered_timeLastDiscoveredTimedateWhen was this CI discoveredtruefalsefalse
last_modified_timeLastModifiedTimedateWhen was this CI last updatedtruefalsefalse
root_actualdeletetimeActual Delete TimedateWhen will this CI be deletedtruefalsetrue
root_actualdeletionperiodActual Deletion Periodinteger40What is the period after the CI will be deletedtruefalsefalse
root_candidatefordeletetimeCandidate For Deletion TimedateWhen will this CI be warned about deletingtruefalsetrue
root_classCI Typestring[100]Class name of the CItruefalsetrue
root_containerContainerstring[32]Container CI of this CItruefalsefalse
root_deletioncandidateperiodDeletion Candidate Periodinteger20What is the period after the CI will be candidate for deletetruefalsefalse
root_enableageingEnable AgingbooleanfalseIs aging enabledtruefalsefalse
root_iconpropertiesstring[100]truefalsetrue
root_iscandidatefordeletionIs Candidate For DeletionbooleanfalseIs candidate for deletiontruefalsefalse
root_lastaccesstimeLast Access TimedateWhen was this CI last accessedtruefalsefalse
root_systemSystemstring[2]truefalsetrue

Valid Relations

Valid direct incoming and outgoing relations defined on DB Cluster Service

Relations defined for DB Cluster Service
FromToTypeDescription
DB Cluster ServiceAmazon DB Cluster EndpointCompositionRepresents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
DB Cluster ServiceAmazon IAM RoleUsageMonitor system Relationships
DB Cluster ServiceAmazon Route 53 Hosted ZoneUsageMonitor system Relationships
DB Cluster ServiceAmazon Security GroupUsageMonitor system Relationships
DB Cluster ServiceDB ServiceMembership
Amazon AccountDB Cluster ServiceContainment
LocationDB Cluster ServiceMembership
Relations defined for Cloud Service
FromToTypeDescription
Cloud ServiceAzure Cosmos DB AccountUsageMonitor system Relationships
Cloud ServiceAzure Logical ServerUsageMonitor system Relationships
Cloud ServiceAzure Storage AccountUsageMonitor system Relationships
Azure Data Factory Integration RuntimeCloud ServiceUsageMonitor system Relationships
Azure Data Factory ServiceCloud ServiceContainment
Azure Private EndpointCloud ServiceUsageMonitor system Relationships
Azure Resource GroupCloud ServiceCompositionRepresents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
Google Dataflow JobCloud ServiceUsageMonitor system Relationships
LocationCloud ServiceMembership
Relations defined for InfrastructureElement
FromToTypeDescription
BusinessActivityInfrastructureElementUsageMonitor system Relationships
BusinessApplicationInfrastructureElementContainment
BusinessApplicationInfrastructureElementUsageMonitor system Relationships
BusinessElementInfrastructureElementUsageMonitor system Relationships
BusinessTransactionInfrastructureElementUsageMonitor system Relationships
CiCollectionInfrastructureElementUsageMonitor system Relationships
ClusterResourceConfigInfrastructureElementDependencyrepresents a dependency between 2 objects
ServiceInfrastructureElementContainment
ServiceInfrastructureElementUsageMonitor system Relationships
Relations defined for ConfigurationItem
FromToTypeDescription
ConfigurationItemConfigurationItemConsumerProvider
ConfigurationItemKpiCompositionRepresents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
ConfigurationItemOutageCompositionRepresents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
ConfigurationItemPolicyResultAggregation
ConfigurationItemScheduledDowntimeConnection
ConfigurationItemServiceConnectionPointCompositionRepresents a relation between 2 objects where one is contained within the other, and the included object can not exist without its container. Therefore, when the container is deleted, all its contained object will be automatically removed
ConfigurationItemServiceConnectionPointOwnership
ApplicationSystemConfigurationItemAggregation
AssetConfigurationItemConnection
CiCollectionConfigurationItemContainment
CiCollectionConfigurationItemMembership
ItProcessRecordConfigurationItemConnection
ItProcessRecordConfigurationItemMembership
LocationConfigurationItemMembership
TenantConfigurationItemConnection
Relations defined for Managed Object
FromToTypeDescription
Managed ObjectHistory ChangeHistory Link
TenantManaged ObjectConnection

Combined inheritance and relation diagram for DB Cluster Service

Potential Data Providers

Adapters providing CIs of type Cloud Service
Adapter NameDescriptionAdapter Type
Azure Discovery by TenantThis adapter discovers subscriptions, resource groups, virtual machines, networks and storage accounts on an Azure tenantDiscovery
Azure Event Based DiscoveryAzure Event Based DiscoveryDiscovery
Azure Event Based Discovery by TenantAzure Event Based Discovery by TenantDiscovery
Azure by WebServicesThis adapter discovers subscriptions, resource groups, virtual machines, networks and storage accounts on an Azure tenantDiscovery
Adapters providing CIs of type ConfigurationItem
Adapter NameDescriptionAdapter Type
Import from CSV Imports data from a CSV file into CMDB using mapping of the CSV file columns to CIT attributes. Mapping is defined by the following parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the CIT attributes to the CSV file columns. Mapping file is used for more complex mapping definitions. Mapping file name is specified by 'mappingFile' parameter.Integration
Import from DB Imports data from an external database into CMDB using mapping of table columns to CIT attributes. Mapping is defined by the following parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the CIT attributes to the table columns Mapping file is used for more complex mapping definitions. Mapping file name is specified by 'mappingFile' parameter. A SQL 'select' query is generated automatically and selects all columns in specified table, which defined by parameter: tableName In advanced cases you can specify custom SQL query.Integration
Import from properties file Imports data from a Properties file into CMDB, using mapping of the CSV file columns to CIT attributes This mapping is usually defined by the setting adapter parameters: ciType: to define the CIT name which you want to create, mappingString: to define the mapping of the Properties attributes to the CSV file columns In cases you need more complex mapping abilities, such as conversion of the strings contained in Properties file to the appropriate type of CMDB object's attribute, you should use the mapping XML configuration file specified by the mappingFile parameter. Integration
SCCM Installed Software IntegrationThis adapter queries the records from SCCM database and recognizes it as install software by UD SAIIntegration
Import from Excel WorkbookImports data from Excel Workbooks. Parses through multiple worksheet XLS files. Uses 'CIImports.xls' (default) file to import data.Integration
Adapters providing CIs of type Object
Adapter NameDescriptionAdapter Type
AMGenericAdapterThis adapter pushes/populates data between UCMDB and Asset Manager. Follow the Quick Start guide supplied with the AM Generic Adapter documentation before creating this integration point.Integration
APM Push AdapterThis adapter pushes data from UCMDB to HP APM. Follow the APM Push Adapter documentation included in the HP UCMDB Discovery and Integration Content Guide before creating this integration point.Integration
UCMDB API PopulationAllows defining Reconciliation Priority for API Data In flowsIntegration
Data Push into AtriumPushes CIs and relationships to BMC AtriumIntegration
BSM Kpi Adapter (deprecated)Federate KPIs from BSMIntegration
CA CMDBPushes CIs and relationships to CA CMDBIntegration
UCMDB 10.x and laterUsed for Populating and Federating data from a remote UCMDB 10.x(or later) and for Pushing to a remote UCMDB 10.x(or later)Integration
UCMDB 9.x (deprecated)Used for Populating and Federating data from a remote UCMDB 9.x server and for Pushing to a remote UCMDB 9.xIntegration
UCMDB History Adapter [local instance only]Used to federated data from the UCMDB's HistoryIntegration
UCMDB to SaaSUsed for Pushing CIs and Relationships from an on-premises UCMDB 2019.02(or later) to Micro Focus SaaS CMSIntegration
Push Adapter DB ExamplePush data into Oracle \ MSSQL databaseIntegration
GenericDBAdapterAn example Adapter that uses the GDB-FrameworkIntegration
IAM UI Push Adapter (deprecated)Push IAM Universal Inventory data into MSSQL database on-premises or on cloud-based Azure.Integration
Java_Adapter_TemplateAdapter DescriptionIntegration
Kafka Push Adapter 2019.05 (deprecated)Push function for Kafka Push AdapterIntegration
Pulsar Push AdapterPush function for Pulsar Push AdapterIntegration
Push AdapterPush AdapterIntegration
Remedyforce Push IntegrationRemedyforce Push IntegrationIntegration
System Center Configuration ManagerUses the GDB-Framework to Populate and Federate data from a System Center Configuration Manager. The adapter is also backward compatible with the SMS DBIntegration
Service Manager 9.41Discovery Pattern DescriptionIntegration
Service Manager Enhanced Generic AdapterPush and Populate CI data between UCMDB and Service ManagerIntegration
ServiceNow Enhanced Generic AdapterPush, Populate and Federation of CI data between UCMDB and ServiceNowIntegration
UCMDB to XMLExport data into XML from UCMDBIntegration

© Copyright 2018 Micro Focus or one of its affiliates