Top / Amazon Web Service / AWS OpsWorks / RDS Db Instance

AWS OpsWorks RDS Db Instance

This page shows how to write Terraform and CloudFormation for OpsWorks RDS Db Instance and write them securely.

terraform-logo

Review your .tf file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

aws_opsworks_rds_db_instance (Terraform)

The RDS Db Instance in OpsWorks can be configured in Terraform with the resource name aws_opsworks_rds_db_instance. The following sections describe 2 examples of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L7
resource "aws_opsworks_rds_db_instance" "this" {
  db_password         = var.db_password
  db_user             = var.db_user
  rds_db_instance_arn = var.rds_db_instance_arn
  stack_id            = var.stack_id
}
test.tf#L1
resource "aws_opsworks_rds_db_instance" "my_instance" {
  stack_id            = aws_opsworks_stack.my_stack.id
  rds_db_instance_arn = aws_db_instance.my_instance.arn
  db_user             = "someUser"
  db_password         = "somePass"

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Provides an OpsWorks RDS DB Instance resource.

Note: All arguments including the username and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

>> from Terraform Registry

AWS::OpsWorks::Stack RdsDbInstance (CloudFormation)

The Stack RdsDbInstance in OpsWorks can be configured in CloudFormation with the resource name AWS::OpsWorks::Stack RdsDbInstance. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

DbPassword AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
Required: Yes
Type: String
Update requires: No interruption

DbUser The master user name.
Required: Yes
Type: String
Update requires: No interruption

RdsDbInstanceArn The instance's ARN.
Required: Yes
Type: String
Update requires: No interruption

>> from AWS CloudFormation Documentation

Explanation in CloudFormation Registry

Describes an Amazon RDS instance.

>> from AWS CloudFormation Documentation

The Other Related AWS OpsWorks Resources

Frequently asked questions

What is AWS OpsWorks RDS Db Instance?

AWS OpsWorks RDS Db Instance is a resource for OpsWorks of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS OpsWorks RDS Db Instance?

For Terraform, the niveklabs/aws and JamesWoolfenden/test source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents