library
turbot/aws
OverviewPipelines
0
Triggers
0
Variables
GitHub

Pipeline: Modify RDS DB Cluster

Modifies settings for a DB cluster.

Run the pipeline

To run this pipeline from your terminal:

flowpipe pipeline run aws.pipeline.modify_rds_db_cluster \
--arg 'region=<string>' \
--arg 'db_cluster_identifier=<string>' \
--arg 'engine=<string>'

Use this pipeline

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

step "pipeline" "step_name" {
pipeline = aws.pipeline.modify_rds_db_cluster
args = {
region = <string>
db_cluster_identifier = <string>
engine = <string>
}
}

Params

NameTypeRequiredDescriptionDefault
region
string
YesThe name of the Region.-
conn
connection.aws
YesName of AWS connection to use. If not provided, the default AWS connection will be used.connection.aws.default
db_cluster_identifier
string
YesThe identifier of the DB cluster to modify. This value is stored as a lowercase string.-
deletion_protection
bool
NoEnables or disables the deletion protection property of a DB cluster.-
copy_tags_to_snapshot
bool
NoEnables or disables the copy tags to snapshot of a DB cluster.-
auto_minor_version_upgrade
bool
NoEnables or disables the auto minor version upgrade property of a DB cluster.-
iam_database_authentication
bool
NoEnables or disables the IAM database authentication property of a DB cluster.-
backup_retention_period
number
NoThe 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
NoSpecifies 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 cluster. By default, this parameter is disabled.-
engine_version
string
NoIndicates the database engine version.-
engine
string
YesIndicates the database engine.-
db_cluster_parameter_group_name
string
NoThe name of the DB cluster parameter group to apply to the DB cluster.-
vpc_security_group_ids
list(string)
NoA list of VPC security groups to associate with this DB cluster.-
preferred_backup_window
string
NoThe daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.-
preferred_maintenance_window
string
NoThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).-
enable_logging
bool
NoEnables or disables logging for the DB cluster based on the engine version.-

Outputs

NameDescription
db_clusterContains the details of an Amazon RDS DB cluster.