Stops the running cluster that is specified by DBClusterIdentifier¶

Description¶

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Usage¶

docdb_stop_db_cluster(DBClusterIdentifier)

Arguments¶

DBClusterIdentifier

[required] The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

Value¶

A list with the following syntax:

list(
  DBCluster = list(
    AvailabilityZones = list(
      "string"
    ),
    BackupRetentionPeriod = 123,
    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",
    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"
      )
    ),
    CloneGroupId = "string",
    ClusterCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    EnabledCloudwatchLogsExports = list(
      "string"
    ),
    DeletionProtection = TRUE|FALSE,
    IOOptimizedNextAllowedModificationTime = as.POSIXct(
      "2015-01-01"
    ),
    StorageType = "string",
    ServerlessV2ScalingConfiguration = list(
      MinCapacity = 123.0,
      MaxCapacity = 123.0
    ),
    MasterUserSecret = list(
      SecretArn = "string",
      SecretStatus = "string",
      KmsKeyId = "string"
    ),
    NetworkType = "string",
    CopyTagsToSnapshot = TRUE|FALSE
  )
)

Request syntax¶

svc$stop_db_cluster(
  DBClusterIdentifier = "string"
)