Delete Cluster

docdbelastic_delete_cluster

R Documentation

Delete an elastic cluster

Description

Delete an elastic cluster.

Usage

docdbelastic_delete_cluster(clusterArn)

Arguments

clusterArn

[required] The ARN identifier of the elastic cluster that is to be deleted.

Value

A list with the following syntax:

list(
  cluster = list(
    adminUserName = "string",
    authType = "PLAIN_TEXT"|"SECRET_ARN",
    backupRetentionPeriod = 123,
    clusterArn = "string",
    clusterEndpoint = "string",
    clusterName = "string",
    createTime = "string",
    kmsKeyId = "string",
    preferredBackupWindow = "string",
    preferredMaintenanceWindow = "string",
    shardCapacity = 123,
    shardCount = 123,
    shardInstanceCount = 123,
    shards = list(
      list(
        createTime = "string",
        shardId = "string",
        status = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"VPC_ENDPOINT_LIMIT_EXCEEDED"|"IP_ADDRESS_LIMIT_EXCEEDED"|"INVALID_SECURITY_GROUP_ID"|"INVALID_SUBNET_ID"|"INACCESSIBLE_ENCRYPTION_CREDS"|"INACCESSIBLE_SECRET_ARN"|"INACCESSIBLE_VPC_ENDPOINT"|"INCOMPATIBLE_NETWORK"|"MERGING"|"MODIFYING"|"SPLITTING"|"COPYING"|"STARTING"|"STOPPING"|"STOPPED"
      )
    ),
    status = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"VPC_ENDPOINT_LIMIT_EXCEEDED"|"IP_ADDRESS_LIMIT_EXCEEDED"|"INVALID_SECURITY_GROUP_ID"|"INVALID_SUBNET_ID"|"INACCESSIBLE_ENCRYPTION_CREDS"|"INACCESSIBLE_SECRET_ARN"|"INACCESSIBLE_VPC_ENDPOINT"|"INCOMPATIBLE_NETWORK"|"MERGING"|"MODIFYING"|"SPLITTING"|"COPYING"|"STARTING"|"STOPPING"|"STOPPED",
    subnetIds = list(
      "string"
    ),
    vpcSecurityGroupIds = list(
      "string"
    )
  )
)

Request syntax

svc$delete_cluster(
  clusterArn = "string"
)