Start Db Cluster

rds_start_db_cluster

R Documentation

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation

Description

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the stop_db_cluster operation.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

This operation only applies to Aurora DB clusters.

Usage

rds_start_db_cluster(DBClusterIdentifier)

Arguments

DBClusterIdentifier

[required] The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.

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",
    AutomaticRestartTime = as.POSIXct(
      "2015-01-01"
    ),
    PercentProgress = "string",
    EarliestRestorableTime = as.POSIXct(
      "2015-01-01"
    ),
    Endpoint = "string",
    ReaderEndpoint = "string",
    CustomEndpoints = list(
      "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"
    ),
    StatusInfos = list(
      list(
        StatusType = "string",
        Normal = TRUE|FALSE,
        Status = "string",
        Message = "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"
    ),
    EarliestBacktrackTime = as.POSIXct(
      "2015-01-01"
    ),
    BacktrackWindow = 123,
    BacktrackConsumedChangeRecords = 123,
    EnabledCloudwatchLogsExports = list(
      "string"
    ),
    Capacity = 123,
    EngineMode = "string",
    ScalingConfigurationInfo = list(
      MinCapacity = 123,
      MaxCapacity = 123,
      AutoPause = TRUE|FALSE,
      SecondsUntilAutoPause = 123,
      TimeoutAction = "string",
      SecondsBeforeTimeout = 123
    ),
    RdsCustomClusterConfiguration = list(
      InterconnectSubnetId = "string",
      TransitGatewayMulticastDomainId = "string",
      ReplicaMode = "open-read-only"|"mounted"
    ),
    DeletionProtection = TRUE|FALSE,
    HttpEndpointEnabled = TRUE|FALSE,
    ActivityStreamMode = "sync"|"async",
    ActivityStreamStatus = "stopped"|"starting"|"started"|"stopping",
    ActivityStreamKmsKeyId = "string",
    ActivityStreamKinesisStreamName = "string",
    CopyTagsToSnapshot = TRUE|FALSE,
    CrossAccountClone = TRUE|FALSE,
    DomainMemberships = list(
      list(
        Domain = "string",
        Status = "string",
        FQDN = "string",
        IAMRoleName = "string",
        OU = "string",
        AuthSecretArn = "string",
        DnsIps = list(
          "string"
        )
      )
    ),
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    GlobalWriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"unknown",
    GlobalWriteForwardingRequested = TRUE|FALSE,
    PendingModifiedValues = list(
      PendingCloudwatchLogsExports = list(
        LogTypesToEnable = list(
          "string"
        ),
        LogTypesToDisable = list(
          "string"
        )
      ),
      DBClusterIdentifier = "string",
      MasterUserPassword = "string",
      IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
      EngineVersion = "string",
      BackupRetentionPeriod = 123,
      AllocatedStorage = 123,
      RdsCustomClusterConfiguration = list(
        InterconnectSubnetId = "string",
        TransitGatewayMulticastDomainId = "string",
        ReplicaMode = "open-read-only"|"mounted"
      ),
      Iops = 123,
      StorageType = "string",
      CertificateDetails = list(
        CAIdentifier = "string",
        ValidTill = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    DBClusterInstanceClass = "string",
    StorageType = "string",
    Iops = 123,
    PubliclyAccessible = TRUE|FALSE,
    AutoMinorVersionUpgrade = TRUE|FALSE,
    MonitoringInterval = 123,
    MonitoringRoleArn = "string",
    PerformanceInsightsEnabled = TRUE|FALSE,
    PerformanceInsightsKMSKeyId = "string",
    PerformanceInsightsRetentionPeriod = 123,
    ServerlessV2ScalingConfiguration = list(
      MinCapacity = 123.0,
      MaxCapacity = 123.0
    ),
    NetworkType = "string",
    DBSystemId = "string",
    MasterUserSecret = list(
      SecretArn = "string",
      SecretStatus = "string",
      KmsKeyId = "string"
    ),
    IOOptimizedNextAllowedModificationTime = as.POSIXct(
      "2015-01-01"
    ),
    LocalWriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"requested",
    AwsBackupRecoveryPointArn = "string",
    LimitlessDatabase = list(
      Status = "active"|"not-in-use"|"enabled"|"disabled"|"enabling"|"disabling"|"modifying-max-capacity"|"error",
      MinRequiredACU = 123.0
    ),
    StorageThroughput = 123,
    CertificateDetails = list(
      CAIdentifier = "string",
      ValidTill = as.POSIXct(
        "2015-01-01"
      )
    ),
    EngineLifecycleSupport = "string"
  )
)

Request syntax

svc$start_db_cluster(
  DBClusterIdentifier = "string"
)