library
turbot/aws
OverviewPipelines
0
Triggers
0
Variables
GitHub

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

NameTypeRequiredDescriptionDefault
regionstringYesThe name of the Region.-
credstringYesName for credentials to use. If not provided, the default credentials will be used.default
db_instance_identifierstringYesThe identifier of DB instance to modify. This value is stored as a lowercase string.-
publicly_accessibleboolNoSpecifies whether the DB instance is publicly accessible.-
deletion_protectionboolNoEnables or disables the deletion protection property of a DB instance.-
copy_tags_to_snapshotboolNoEnables or disables the copy tags to snapshot of a DB instance.-
auto_minor_version_upgradeboolNoEnables or disables the auto minor version upgrade property of a DB instance.-
iam_database_authenticationboolNoEnables or disables the IAM database authentication property of a DB instance.-
multi_azboolNoEnables or disables the Multi-AZ property of a DB instance.-
db_instance_classstringNoThe new compute and memory capacity of the DB instance, for example `db.m4.large`.-
backup_retention_periodnumberNoThe 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_immediatelyboolNoSpecifies 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_versionstringNoIndicates the database engine version.-

Outputs

NameDescription
db_instanceContains the details of an Amazon RDS DB instance.