AWS Redshift #Action=DeleteCluster API
The #Action=DeleteCluster API from AWS Redshift — 1 operation(s) for #action=deletecluster.
The #Action=DeleteCluster API from AWS Redshift — 1 operation(s) for #action=deletecluster.
openapi: 3.0.0
info:
version: '2019-12-20'
x-release: v4
title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=DeleteCluster API'
description: <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: redshift-data
x-aws-signingName: redshift-data
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/redshift-data-2019-12-20.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://redshift-data.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Redshift Data API Service multi-region endpoint
- url: https://redshift-data.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Redshift Data API Service multi-region endpoint
- url: http://redshift-data.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
- url: https://redshift-data.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=DeleteCluster'
paths:
/#Action=DeleteCluster:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
x-aws-operation-name: DeleteCluster
operationId: GET_DeleteCluster
description: <p>Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use <a>DescribeClusters</a> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. </p> <p> For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClusterResult'
'480':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'481':
description: InvalidClusterStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterStateFault'
'482':
description: ClusterSnapshotAlreadyExistsFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSnapshotAlreadyExistsFault'
'483':
description: ClusterSnapshotQuotaExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSnapshotQuotaExceededFault'
'484':
description: InvalidRetentionPeriodFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidRetentionPeriodFault'
parameters:
- name: ClusterIdentifier
in: query
required: true
description: <p>The identifier of the cluster to be deleted.</p> <p>Constraints:</p> <ul> <li> <p>Must contain lowercase characters.</p> </li> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>
schema:
type: string
maxLength: 2147483647
- name: SkipFinalClusterSnapshot
in: query
required: false
description: '<p>Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted. </p> <note> <p>The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>.</p> </note> <p>Default: <code>false</code> </p>'
schema:
type: boolean
- name: FinalClusterSnapshotIdentifier
in: query
required: false
description: <p>The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>. </p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric characters.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>
schema:
type: string
maxLength: 2147483647
- name: FinalClusterSnapshotRetentionPeriod
in: query
required: false
description: <p>The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p> <p>The default value is -1.</p>
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCluster
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - G E T_ Delete Cluster
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DeleteCluster'
post:
x-aws-operation-name: DeleteCluster
operationId: POST_DeleteCluster
description: <p>Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use <a>DescribeClusters</a> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. </p> <p> For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClusterResult'
'480':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'481':
description: InvalidClusterStateFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidClusterStateFault'
'482':
description: ClusterSnapshotAlreadyExistsFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSnapshotAlreadyExistsFault'
'483':
description: ClusterSnapshotQuotaExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterSnapshotQuotaExceededFault'
'484':
description: InvalidRetentionPeriodFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidRetentionPeriodFault'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClusterMessage'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCluster
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - P O S T_ Delete Cluster
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DeleteCluster'
components:
schemas:
DeleteClusterResult:
type: object
properties:
Cluster:
$ref: '#/components/schemas/Cluster'
ScheduleState:
type: string
enum:
- MODIFYING
- ACTIVE
- FAILED
NetworkInterface:
type: object
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The network interface identifier. '
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The subnet identifier. '
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IPv4 address of the network interface within the subnet. '
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The Availability Zone. '
description: 'Describes a network interface. '
PendingActionsList:
type: array
items:
$ref: '#/components/schemas/String'
ClusterParameterStatus:
type: object
properties:
ParameterName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the parameter.
ParameterApplyStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.</p> <p>The following are possible statuses and descriptions.</p> <ul> <li> <p> <code>in-sync</code>: The parameter value is in sync with the database.</p> </li> <li> <p> <code>pending-reboot</code>: The parameter value will be applied after the cluster reboots.</p> </li> <li> <p> <code>applying</code>: The parameter value is being applied to the database.</p> </li> <li> <p> <code>invalid-parameter</code>: Cannot apply the parameter value because it has an invalid value or syntax.</p> </li> <li> <p> <code>apply-deferred</code>: The parameter contains static property changes. The changes are deferred until the cluster reboots.</p> </li> <li> <p> <code>apply-error</code>: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.</p> </li> <li> <p> <code>unknown-error</code>: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.</p> </li> </ul>'
ParameterApplyErrorDescription:
allOf:
- $ref: '#/components/schemas/String'
- description: The error that prevented the parameter from being applied to the database.
description: Describes the status of a parameter group.
Tag:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- description: The key, or name, for the resource tag.
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: The value for the resource tag.
description: A tag consisting of a name/value pair for a resource.
BooleanOptional:
type: boolean
ReservedNodeExchangeStatusType:
type: string
enum:
- REQUESTED
- PENDING
- IN_PROGRESS
- RETRYING
- SUCCEEDED
- FAILED
Double:
type: number
format: double
TStamp:
type: string
format: date-time
VpcEndpointsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpoint'
- xml:
name: VpcEndpoint
DeleteClusterMessage:
type: object
required:
- ClusterIdentifier
title: DeleteClusterMessage
properties:
ClusterIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The identifier of the cluster to be deleted.</p> <p>Constraints:</p> <ul> <li> <p>Must contain lowercase characters.</p> </li> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>
SkipFinalClusterSnapshot:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '<p>Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted. </p> <note> <p>The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>.</p> </note> <p>Default: <code>false</code> </p>'
FinalClusterSnapshotIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>. </p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric characters.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>
FinalClusterSnapshotRetentionPeriod:
allOf:
- $ref: '#/components/schemas/IntegerOptional'
- description: <p>The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p> <p>The default value is -1.</p>
description: <p/>
Integer:
type: integer
ClusterSecurityGroupMembershipList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ClusterSecurityGroupMembership'
- xml:
name: ClusterSecurityGroup
AquaConfiguration:
type: object
properties:
AquaStatus:
allOf:
- $ref: '#/components/schemas/AquaStatus'
- description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus:
allOf:
- $ref: '#/components/schemas/AquaConfigurationStatus'
- description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
description: The operation that uses this structure is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
String:
type: string
maxLength: 2147483647
TagList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Tag'
- xml:
name: Tag
DeferredMaintenanceWindowsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/DeferredMaintenanceWindow'
- xml:
name: DeferredMaintenanceWindow
HsmStatus:
type: object
properties:
HsmClientCertificateIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
Status:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.</p> <p>Values: active, applying</p>'
description: Describes the status of changes to HSM settings.
AquaConfigurationStatus:
type: string
enum:
- enabled
- disabled
- auto
ReservedNodeExchangeStatus:
type: object
properties:
ReservedNodeExchangeRequestId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the reserved-node exchange request.
Status:
allOf:
- $ref: '#/components/schemas/ReservedNodeExchangeStatusType'
- description: The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the source reserved node.
SourceReservedNodeType:
allOf:
- $ref: '#/components/schemas/String'
- description: The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The source reserved-node count in the cluster.
TargetReservedNodeOfferingId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the target reserved node offering.
TargetReservedNodeType:
allOf:
- $ref: '#/components/schemas/String'
- description: The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The count of target reserved nodes in the cluster.
description: Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other details.
ClusterParameterGroupStatus:
type: object
properties:
ParameterGroupName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the cluster parameter group.
ParameterApplyStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of parameter updates.
ClusterParameterStatusList:
allOf:
- $ref: '#/components/schemas/ClusterParameterStatusList'
- description: <p>The list of parameter statuses.</p> <p> For more information about parameters and parameter groups, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
description: Describes the status of a parameter group.
DoubleOptional:
type: number
format: double
ClusterSecurityGroupMembership:
type: object
properties:
ClusterSecurityGroupName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the cluster security group.
Status:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of the cluster security group.
description: Describes a cluster security group.
ResizeInfo:
type: object
properties:
ResizeType:
allOf:
- $ref: '#/components/schemas/String'
- description: Returns the value <code>ClassicResize</code>.
AllowCancelResize:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: A boolean value indicating if the resize operation can be cancelled.
description: Describes a resize operation.
AquaStatus:
type: string
enum:
- enabled
- disabled
- applying
Endpoint:
type: object
properties:
Address:
allOf:
- $ref: '#/components/schemas/String'
- description: The DNS address of the Cluster.
Port:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The port that the database engine is listening on.
VpcEndpoints:
allOf:
- $ref: '#/components/schemas/VpcEndpointsList'
- description: Describes a connection endpoint.
description: Describes a connection endpoint.
RestoreStatus:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types. '
SnapshotSizeInMegaBytes:
allOf:
- $ref: '#/components/schemas/Long'
- description: 'The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types. '
ProgressInMegaBytes:
allOf:
- $ref: '#/components/schemas/Long'
- description: 'The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types. '
ElapsedTimeInSeconds:
allOf:
- $ref: '#/components/schemas/Long'
- description: 'The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types. '
EstimatedTimeToCompletionInSeconds:
allOf:
- $ref: '#/components/schemas/Long'
- description: 'The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types. '
description: Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
ClusterParameterGroupStatusList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ClusterParameterGroupStatus'
- xml:
name: ClusterParameterGroup
Cluster:
type: object
properties:
ClusterIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: The unique identifier of the cluster.
NodeType:
allOf:
- $ref: '#/components/schemas/String'
- description: The node type for the nodes in the cluster.
ClusterStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: <p> The current state of the cluster. Possible values are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>available, prep-for-resize</code> </p> </li> <li> <p> <code>available, resize-cleanup</code> </p> </li> <li> <p> <code>cancelling-resize</code> </p> </li> <li> <p> <code>creating</code> </p> </li> <li> <p> <code>deleting</code> </p> </li> <li> <p> <code>final-snapshot</code> </p> </li> <li> <p> <code>hardware-failure</code> </p> </li> <li> <p> <code>incompatible-hsm</code> </p> </li> <li> <p> <code>incompatible-network</code> </p> </li> <li> <p> <code>incompatible-parameters</code> </p> </li> <li> <p> <code>incompatible-restore</code> </p> </li> <li> <p> <code>modifying</code> </p> </li> <li> <p> <code>paused</code> </p> </li> <li> <p> <code>rebooting</code> </p> </li> <li> <p> <code>renaming</code> </p> </li> <li> <p> <code>resizing</code> </p> </li> <li> <p> <code>rotating-keys</code> </p> </li> <li> <p> <code>storage-full</code> </p> </li> <li> <p> <code>updating-hsm</code> </p> </li> </ul>
ClusterAvailabilityStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The availability status of the cluster for queries. Possible values are the following:</p> <ul> <li> <p>Available - The cluster is available for queries. </p> </li> <li> <p>Unavailable - The cluster is not available for queries.</p> </li> <li> <p>Maintenance - The cluster is intermittently available for queries due to maintenance activities.</p> </li> <li> <p>Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.</p> </li> <li> <p>Failed - The cluster failed and is not available for queries.</p> </li> </ul>
ModifyStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of a modify operation, if any, initiated for the cluster.
MasterUsername:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The admin user name for the cluster. This name is used to connect to the database that is specified in the <b>DBName</b> parameter. '
DBName:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named <code>dev</code>dev was created by default. '
Endpoint:
allOf:
- $ref: '#/components/schemas/Endpoint'
- description: The connection endpoint.
ClusterCreateTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod:
allOf:
- $ref: '#/components/schemas/Integer'
- description: <p>The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p>
ClusterSecurityGroups:
allOf:
- $ref: '#/components/schemas/ClusterSecurityGroupMembershipList'
- description: <p>A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains <code>ClusterSecurityGroup.Name</code> and <code>ClusterSecurityGroup.Status</code> subelements. </p> <p>Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the <b>VpcSecurityGroups</b> parameter. </p>
VpcSecurityGroups:
allOf:
- $ref: '#/components/schemas/VpcSecurityGroupMembershipList'
- description: A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
ClusterParameterGroups:
allOf:
- $ref: '#/components/schemas/ClusterParameterGroupStatusList'
- description: The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
ClusterSubnetGroupName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow:
allOf:
- $ref: '#/components/schemas/String'
- description: The weekly ti
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aws-redshift/refs/heads/main/openapi/aws-redshift-action-deletecluster-api-openapi.yml