library
turbot/aws
OverviewPipelines
0
Triggers
0
Variables
GitHub

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
regionstringYesThe name of the Region.-
credstringYesName for credentials to use. If not provided, the default credentials will be used.default
db_cluster_identifierstringYesThe identifier of the DB cluster to modify. This value is stored as a lowercase string.-
deletion_protectionboolNoEnables or disables the deletion protection property of a DB cluster.-
copy_tags_to_snapshotboolNoEnables or disables the copy tags to snapshot of a DB cluster.-
auto_minor_version_upgradeboolNoEnables or disables the auto minor version upgrade property of a DB cluster.-
iam_database_authenticationboolNoEnables or disables the IAM database authentication property of a DB cluster.-
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 cluster. By default, this parameter is disabled.-
engine_versionstringNoIndicates the database engine version.-
enginestringYesIndicates the database engine.-
db_cluster_parameter_group_namestringNoThe name of the DB cluster parameter group to apply to the DB cluster.-
vpc_security_group_idslist(string)NoA list of VPC security groups to associate with this DB cluster.-
preferred_backup_windowstringNoThe daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.-
preferred_maintenance_windowstringNoThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).-
enable_loggingboolNoEnables or disables logging for the DB cluster based on the engine version.-

Outputs

NameDescription
db_clusterContains the details of an Amazon RDS DB cluster.