Skip to main content
Sign in

Creating workflows for AWS RDS assets

  • August 01, 2023 15:19
  • Updated

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets as data from AWS RDS is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and AWS RDS in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

  • Configurable dashboards and list views of key information
  • Configurable reports to share information with your colleagues and management
  • Configurable asset workflows that you can easily create to automate tasks such as:
    • Workflows for adding and removing metadata tags from an Amazon RDS resource.
    • Workflows for creating and deleting a snapshot of a DB cluster
    • Workflows for creating and deleting a snapshot of a DB instance

Let Oomnitza be your single source of truth!

You'll get visibility of your devices as data from AWS RDS is automatically transformed into consumable information and actionable insights.

small_blue_link.svgBefore you start

small_blue_link.svgCreating workflows

Create asset workflows

AWS RDS Add Tag To Resource

AWS RDS Remove Tag From Resource

AWS RDS Create Cluster Snapshot

AWS RDS Create DB Snapshot

AWS RDS Delete DB Snapshot

AWS RDS Delete Cluster Snapshot

AWS RDS Describe DB Instances

Before you start

Before you create workflows, you need to have added your AWS credentials to Oomnitza. Follow the steps in Adding your AWS RDS credentials to Oomnitza.

We recommend that you also create the extended integration for AWS RDS assets. You can use the asset integration to retrieve the AWS Region which will be required for creating asset workflows.

Important
Unlike the integration, these workflows are not enabled for cross-account access. As a result, when performing create, fetch, update, and delete operations, you must use credentials that belong to the target account you intend to work with.

Creating workflows

Create asset workflows

To create an asset workflow, you must complete these steps:  

  1. Click Configuration > Workflows 
  2. Click Add (+) and select Assets from the list.
  3. Drag and drop the API block onto the Sandbox.
  4. Click Edit on the API block and enter AWS RDS in the search field. 
  5. Select a preset:
  6. To choose a preset, click the forward arrow (>).
  7. Select the credentials that you created in Adding your AWS RDS credentials to Oomnitza.
  8. Configure the API Block following the preset instructions below, and save your changes.
  9. Edit the Begin Block and add rules to trigger the workflow. For example, if you set the Actions to New you can trigger a workflow every time a new asset is created. Refer to Using the Begin block.
  10. Connect the Blocks. 
  11. Save, validate, and activate your workflow.

Using the AWS RDS Add Tag To Resource preset

The AWS RDS Add Tag To Resource preset adds metadata tags to an Amazon RDS resource. When you select this preset you need to specify the following:

  • Resource Name: The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN).
  • Tag Key: The required name of the tag.
  • Tag Value: The optional value of the tag.

You can configure the message payload by selecting Advanced Mode.

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Information tab. You will notice that the AWS Region is referenced in the property {{aws_region}}. Follow the mapping steps in Creating an asset integration so that this property exists in Oomnitza and is populated with information before you run this workflow. Alternatively, replace the property with the AWS Region, for example https://rds.us-west-1
    .amazonaws.com    . For further information, refer to Regions, Availability Zones, and Local Zones.
  3. Select the Body tab to review or edit the asset information you have entered. 
  4. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

For further information, refer to AWS API Documentation: AddTagsToResource.

Using the AWS RDS Remove Tag From Resource preset

The AWS RDS Remove Tag From Resource preset removes metadata tags from an Amazon RDS resource. When you select this preset you need to specify the following:

  • Resource Name: The Amazon RDS resource. This value is an Amazon Resource Name (ARN).
  • Tag Name: The required name of the tag.

You can configure the message payload by selecting Advanced Mode.

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Information tab. You will notice that the AWS Region is referenced in the property {{aws_region}}. Follow the mapping steps in Creating an asset integration so that this property exists in Oomnitza and is populated with information before you run this workflow. Alternatively, replace the property with the AWS Region, for example https://rds.us-west-1
    .amazonaws.com    . For further information, refer to Regions, Availability Zones, and Local Zones.
  3. Select the Body tab to review or edit the asset information you have entered. 
  4. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

For further information, refer to AWS API Documentation: RemoveTagsFromResource.

Using the AWS RDS Create Cluster Snapshot preset

The AWS RDS Create Cluster Snapshot preset creates a snapshot of a DB cluster. When you select this preset you need to specify the following:

  • DB Cluster Identifier: The identifier of the DB cluster to create a snapshot for. This identifier must match the identifier of an existing DBCluster .Example: my-cluster1
  • DB Cluster Snapshot Identifier: The identifier of the DB cluster snapshot. This value must contain 1-63 letters, numbers, or hyphens. The first character must be in the form of a letter, and the value cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1

You can configure this preset in the same manner as the Using the AWS RDS Remove Tag From Resource preset. For further information, refer to AWS API Documentation: CreateDBClusterSnapshot.

Using the AWS RDS Create DB Snapshot preset

The AWS RDS Create DB Snapshot preset creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state. When you select this preset you need to specify the following:

  • DB Instance Identifier: The identifier of the DB instance that you want to create the snapshot of. The identifer must match the identifier of an existing DBInstance.
  • DB Snapshot Identifier: The identifier for the DB snapshot. This value must contain 1-255 letters, numbers, or hyphens. The first character must be in the form of a letter, and the value cannot end with a hyphen or contain two consecutive hyphens. Example: my-snapshot-id

You can configure this preset in the same manner as the Using the AWS RDS Remove Tag From Resource preset. For further information, refer to AWS API Documentation: CreateDBSnapshot.

Using the AWS RDS Delete DB Snapshot preset

The AWS RDS Delete DB Snapshot deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. When you select this preset you need to specify the DB snapshot identifier. This value must be the name of an existing DB snapshot in the available state. You can configure this preset in the same manner as the Using the AWS RDS Remove Tag From Resource preset. For further information, refer to AWS API Documentation: DeleteDBSnapshot.

Using the AWS RDS Delete Cluster Snapshot preset

The AWS RDS Delete Cluster Snapshot preset deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. When you select this preset you need to specify the identifier of the DB cluster snapshot to delete. This value must be the name of an existing DB cluster snapshot in the available state. You can configure this preset in the same manner as the Using the AWS RDS Remove Tag From Resource preset. For further information, refer to AWS API Documentation: DeleteDBClusterSnapshot.

Using the AWS RDS Describe DB Instances preset

The AWS RDS Describe DB Instances preset returns information about provisioned RDS instances. When you select this preset you need to specify the identifier of the DB instance you want to retrieve. This parameter isn't case-sensitive. You can configure this preset in the same manner as the Using the AWS RDS Remove Tag From Resource preset. For further information, refer to AWS API Documentation: DescribeDBInstances.

articles_icon.svg Reference articles for workflows

Related articles

Comments

0 comments

Please sign in to leave a comment.