Pipeline: Modify RDS DB Instance

Modifies settings for a DB instance.

Run the pipeline

To run this pipeline from your terminal:

flowpipe pipeline run aws.pipeline.modify_rds_db_instance \
  --arg 'region=<string>' \
  --arg 'db_instance_identifier=<string>'

Use this pipeline

To call this pipeline from your pipeline, use a step:

step "pipeline" "step_name" {
  pipeline = aws.pipeline.modify_rds_db_instance  
  args = {
    region = <string>
    db_instance_identifier = <string>
  }
}

Params

Name	Type	Required	Description	Default
region	string	Yes	The name of the Region.	-
conn	connection.aws	Yes	Name of AWS connection to use. If not provided, the default AWS connection will be used.	`connection.aws.default`
db_instance_identifier	string	Yes	The identifier of DB instance to modify. This value is stored as a lowercase string.	-
publicly_accessible	bool	No	Specifies whether the DB instance is publicly accessible.	-
deletion_protection	bool	No	Enables or disables the deletion protection property of a DB instance.	-
copy_tags_to_snapshot	bool	No	Enables or disables the copy tags to snapshot of a DB instance.	-
auto_minor_version_upgrade	bool	No	Enables or disables the auto minor version upgrade property of a DB instance.	-
iam_database_authentication	bool	No	Enables or disables the IAM database authentication property of a DB instance.	-
multi_az	bool	No	Enables or disables the Multi-AZ property of a DB instance.	-
db_instance_class	string	No	The new compute and memory capacity of the DB instance, for example `db.m4.large`.	-
backup_retention_period	number	No	The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.	-
apply_immediately	bool	No	Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.	-
engine_version	string	No	Indicates the database engine version.	-

Outputs

Name	Description
db_instance	Contains the details of an Amazon RDS DB instance.