CI Class Amazon SQS Queue

Inheritance diagram for Amazon SQS Queue

Summary

Display NameAmazon SQS Queue
Nameaws_sqs_queue
Description[Summary]Amazon SQS Queue [Class]com.amazonaws.services.sns.model.Topic

Attributes

Attributes defined for Amazon SQS Queue
NameDisplay NameTypeDefault ValueDescriptionFactoryKeyHidden
approximate_number_messagesApproximate Number Of Messagesinteger[Summary] The approximate number of messages available for retrieval from the queue. [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.ApproximateNumberOfMessages)).attributes().get(QueueAttributeName.ApproximateNumberOfMessages) [Example] 0truefalsefalse
approximate_number_messages_delayedApproximate Number Of Messages Delayedinteger[Summary] The approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter. [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.ApproximateNumberOfMessagesDelayed)).attributes().get(QueueAttributeName.ApproximateNumberOfMessagesDelayed) [Example] 0truefalsefalse
approximate_number_messages_not_visibleApproximate Number Of Messages Not Visibleinteger[Summary] The approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not a client but have not yet been deleted or have not yet reached the end of their visibility window. [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.ApproximateNumberOfMessagesNotVisible)).attributes().get(QueueAttributeName.ApproximateNumberOfMessagesNotVisible) [Example] 0truefalsefalse
delay_secondsDelay Secondsinteger[Summary] The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0. [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.DelaySeconds)).attributes().get(QueueAttributeName.DelaySeconds) [Example] 0truefalsefalse
maximum_message_sizeMaximum Message Sizeinteger[Summary] The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.MaximumMessageSize)).attributes().get(QueueAttributeName.MaximumMessageSize) [Example] 262144truefalsefalse
message_retention_periodMessage Retention Periodinteger[Summary] The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.MessageRetentionPeriod)).attributes().get(QueueAttributeName.MessageRetentionPeriod) [Example] 345600truefalsefalse
queue_urlQueue Urlstring[255][Summary] TThe queue url [Collection - AWS] Call API:SqsClient.getQueueUrl(GetQueueUrlRequest.builder().queueName(queueName).build()).queueUrl() [Example] https://sqs.ap-south-1.amazonaws.com/1234567/ucmdb_queuetruefalsefalse
receive_message_wait_time_secondsReceive Message Wait Time Secondsinteger[Summary] The length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.ReceiveMessageWaitTimeSeconds)).attributes().get(QueueAttributeName.ReceiveMessageWaitTimeSeconds) [Example] 15truefalsefalse
redrive_policyRedrive Policystring[500][Summary] The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.RedrivePolicy)).attributes().get(QueueAttributeName.RedrivePolicy) [Example] truefalsefalse
visibility_timeoutVisibility Timeoutinteger[Summary] The visibility timeout for the queue. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout ,see https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html [Collection - AWS] Call API:SqsClient.getQueueAttributes(GetQueueAttributesRequest.builder().attributeNames(QueueAttributeName.VisibilityTimeout)).attributes().get(QueueAttributeName.VisibilityTimeout) [Example] 30truefalsefalse
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[500]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
is_save_persistencyStore KPI History For Over Time ReportsbooleanfalseStore KPI history for over time reportstruefalsetrue
layerlayer_enumtruefalsefalse
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[50]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 Amazon SQS Queue

Relations defined for Amazon SQS Queue
FromToTypeDescription
Amazon AccountAmazon SQS QueueContainment
Amazon Lambda FunctionAmazon SQS QueueDependencyrepresents a dependency between 2 objects
LocationAmazon SQS QueueMembership
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
Google Dataflow JobCloud ServiceUsageMonitor system Relationships
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
ConfigurationItemAutomation Flow ExecutionIncludesThis relationship connects two CIs, one of which is included into another. A child CI can be moved to another parent, but when the parent is deleted, the child will be deleted as well, except if a second includes link exist on it already. Moving of a child CI possible by creation of new link to another parent and deletion of the first one.
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
DefectsFilterConfigurationItemContainment
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 Amazon SQS Queue

Potential Data Providers

Adapters providing CIs of type Amazon SQS Queue
Adapter NameDescriptionAdapter Type
AWS by Web ServicesDiscovers AWS topologies using the Amazon Web Services.Discovery
AWS by Web Services using TagsDiscovers AWS resources with customized tagsDiscovery
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
ALMAdapterFederate defects from ALMIntegration
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
Application Portfolio Management Push AdapterThis adapter pushes data from UCMDB to HP Application Portfolio Management. 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
AutomationFlowAdapterProvide API to Operation OrchestrationIntegration
BSMKpiAdapterFederate 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.xUsed 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
Push Adapter DB ExamplePush data into Oracle \ MSSQL databaseIntegration
GenericDBAdapterAn example Adapter that uses the GDB-FrameworkIntegration
IAM UI Push AdapterPush IAM Universal Inventory data into MSSQL database on-premises or on cloud-based Azure.Integration
Java_Adapter_TemplateAdapter DescriptionIntegration
Kafka Push Adapter 2019.05Push function for Kafka Push AdapterIntegration
Local State Push AdapterUsed for populating data between the states of the same UCMDB ServerIntegration
Pulsar Push AdapterPush function for Pulsar Push AdapterIntegration
Push AdapterPush AdapterIntegration
Remedyforce Push IntegrationRemedyforce Push IntegrationIntegration
SMA-X Push AdapterThis adapter pushes data from UCMDB to Service Anywhere. Integration
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 9.xxDiscovery 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