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

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_cluster_identifier	string	Yes	The identifier of the DB cluster to modify. This value is stored as a lowercase string.	-
deletion_protection	bool	No	Enables or disables the deletion protection property of a DB cluster.	-
copy_tags_to_snapshot	bool	No	Enables or disables the copy tags to snapshot of a DB cluster.	-
auto_minor_version_upgrade	bool	No	Enables or disables the auto minor version upgrade property of a DB cluster.	-
iam_database_authentication	bool	No	Enables or disables the IAM database authentication property of a DB cluster.	-
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 cluster. By default, this parameter is disabled.	-
engine_version	string	No	Indicates the database engine version.	-
engine	string	Yes	Indicates the database engine.	-
db_cluster_parameter_group_name	string	No	The name of the DB cluster parameter group to apply to the DB cluster.	-
vpc_security_group_ids	list(string)	No	A list of VPC security groups to associate with this DB cluster.	-
preferred_backup_window	string	No	The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.	-
preferred_maintenance_window	string	No	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).	-
enable_logging	bool	No	Enables or disables logging for the DB cluster based on the engine version.	-

Outputs

Name	Description
db_cluster	Contains the details of an Amazon RDS DB cluster.