Delete Db Cluster
neptune_delete_db_cluster | R Documentation |
The DeleteDBCluster action deletes a previously provisioned DB cluster¶
Description¶
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
Note that the DB Cluster cannot be deleted if deletion protection is
enabled. To delete it, you must first set its DeletionProtection
field
to False
.
Usage¶
Arguments¶
DBClusterIdentifier
[required] The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
SkipFinalSnapshot
Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If
true
is specified, no DB cluster snapshot is created. Iffalse
is specified, a DB cluster snapshot is created before the DB cluster is deleted.You must specify a
FinalDBSnapshotIdentifier
parameter ifSkipFinalSnapshot
isfalse
.Default:
false
FinalDBSnapshotIdentifier
The DB cluster snapshot identifier of the new DB cluster snapshot created when
SkipFinalSnapshot
is set tofalse
.Specifying this parameter and also setting the
SkipFinalShapshot
parameter to true results in an error.Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Value¶
A list with the following syntax:
list(
DBCluster = list(
AllocatedStorage = 123,
AvailabilityZones = list(
"string"
),
BackupRetentionPeriod = 123,
CharacterSetName = "string",
DatabaseName = "string",
DBClusterIdentifier = "string",
DBClusterParameterGroup = "string",
DBSubnetGroup = "string",
Status = "string",
PercentProgress = "string",
EarliestRestorableTime = as.POSIXct(
"2015-01-01"
),
Endpoint = "string",
ReaderEndpoint = "string",
MultiAZ = TRUE|FALSE,
Engine = "string",
EngineVersion = "string",
LatestRestorableTime = as.POSIXct(
"2015-01-01"
),
Port = 123,
MasterUsername = "string",
DBClusterOptionGroupMemberships = list(
list(
DBClusterOptionGroupName = "string",
Status = "string"
)
),
PreferredBackupWindow = "string",
PreferredMaintenanceWindow = "string",
ReplicationSourceIdentifier = "string",
ReadReplicaIdentifiers = list(
"string"
),
DBClusterMembers = list(
list(
DBInstanceIdentifier = "string",
IsClusterWriter = TRUE|FALSE,
DBClusterParameterGroupStatus = "string",
PromotionTier = 123
)
),
VpcSecurityGroups = list(
list(
VpcSecurityGroupId = "string",
Status = "string"
)
),
HostedZoneId = "string",
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
DbClusterResourceId = "string",
DBClusterArn = "string",
AssociatedRoles = list(
list(
RoleArn = "string",
Status = "string",
FeatureName = "string"
)
),
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
CloneGroupId = "string",
ClusterCreateTime = as.POSIXct(
"2015-01-01"
),
CopyTagsToSnapshot = TRUE|FALSE,
EnabledCloudwatchLogsExports = list(
"string"
),
PendingModifiedValues = list(
PendingCloudwatchLogsExports = list(
LogTypesToEnable = list(
"string"
),
LogTypesToDisable = list(
"string"
)
),
DBClusterIdentifier = "string",
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
EngineVersion = "string",
BackupRetentionPeriod = 123,
StorageType = "string",
AllocatedStorage = 123,
Iops = 123
),
DeletionProtection = TRUE|FALSE,
CrossAccountClone = TRUE|FALSE,
AutomaticRestartTime = as.POSIXct(
"2015-01-01"
),
ServerlessV2ScalingConfiguration = list(
MinCapacity = 123.0,
MaxCapacity = 123.0
),
GlobalClusterIdentifier = "string",
IOOptimizedNextAllowedModificationTime = as.POSIXct(
"2015-01-01"
),
StorageType = "string"
)
)