/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the redshift-2012-12-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Redshift.Model
{
///
/// Container for the parameters to the DeleteCluster operation.
/// 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 DescribeClusters 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 Amazon
/// Redshift Clusters in the Amazon Redshift Cluster Management Guide.
///
///
///
/// If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot
/// to false
and specify a name for FinalClusterSnapshotIdentifier.
/// 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.
///
///
///
/// For more information about managing clusters, go to Amazon
/// Redshift Clusters in the Amazon Redshift Cluster Management Guide.
///
///
public partial class DeleteClusterRequest : AmazonRedshiftRequest
{
private string _clusterIdentifier;
private string _finalClusterSnapshotIdentifier;
private int? _finalClusterSnapshotRetentionPeriod;
private bool? _skipFinalClusterSnapshot;
///
/// Gets and sets the property ClusterIdentifier.
///
/// The identifier of the cluster to be deleted.
///
///
///
/// Constraints:
///
/// -
///
/// Must contain lowercase characters.
///
///
-
///
/// Must contain from 1 to 63 alphanumeric characters or hyphens.
///
///
-
///
/// First character must be a letter.
///
///
-
///
/// Cannot end with a hyphen or contain two consecutive hyphens.
///
///
///
[AWSProperty(Required=true, Max=2147483647)]
public string ClusterIdentifier
{
get { return this._clusterIdentifier; }
set { this._clusterIdentifier = value; }
}
// Check to see if ClusterIdentifier property is set
internal bool IsSetClusterIdentifier()
{
return this._clusterIdentifier != null;
}
///
/// Gets and sets the property FinalClusterSnapshotIdentifier.
///
/// The identifier of the final snapshot that is to be created immediately before deleting
/// the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be
/// false
.
///
///
///
/// Constraints:
///
/// -
///
/// Must be 1 to 255 alphanumeric characters.
///
///
-
///
/// First character must be a letter.
///
///
-
///
/// Cannot end with a hyphen or contain two consecutive hyphens.
///
///
///
[AWSProperty(Max=2147483647)]
public string FinalClusterSnapshotIdentifier
{
get { return this._finalClusterSnapshotIdentifier; }
set { this._finalClusterSnapshotIdentifier = value; }
}
// Check to see if FinalClusterSnapshotIdentifier property is set
internal bool IsSetFinalClusterSnapshotIdentifier()
{
return this._finalClusterSnapshotIdentifier != null;
}
///
/// Gets and sets the property FinalClusterSnapshotRetentionPeriod.
///
/// The number of days that a manual snapshot is retained. If the value is -1, the manual
/// snapshot is retained indefinitely.
///
///
///
/// The value must be either -1 or an integer between 1 and 3,653.
///
///
///
/// The default value is -1.
///
///
public int FinalClusterSnapshotRetentionPeriod
{
get { return this._finalClusterSnapshotRetentionPeriod.GetValueOrDefault(); }
set { this._finalClusterSnapshotRetentionPeriod = value; }
}
// Check to see if FinalClusterSnapshotRetentionPeriod property is set
internal bool IsSetFinalClusterSnapshotRetentionPeriod()
{
return this._finalClusterSnapshotRetentionPeriod.HasValue;
}
///
/// Gets and sets the property SkipFinalClusterSnapshot.
///
/// Determines whether a final snapshot of the cluster is created before Amazon Redshift
/// deletes the cluster. If true
, a final cluster snapshot is not created.
/// If false
, a final cluster snapshot is created before the cluster is deleted.
///
///
///
///
/// The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot
/// is false
.
///
///
///
/// Default: false
///
///
public bool SkipFinalClusterSnapshot
{
get { return this._skipFinalClusterSnapshot.GetValueOrDefault(); }
set { this._skipFinalClusterSnapshot = value; }
}
// Check to see if SkipFinalClusterSnapshot property is set
internal bool IsSetSkipFinalClusterSnapshot()
{
return this._skipFinalClusterSnapshot.HasValue;
}
}
}