/*
* Copyright 2010-2014 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 kinesis-2013-12-02.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Kinesis.Model
{
///
/// Container for the parameters to the UpdateShardCount operation.
/// Updates the shard count of the specified stream to the specified number of shards.
///
///
///
/// Updating the shard count is an asynchronous operation. Upon receiving the request,
/// Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING
.
/// After the update is complete, Kinesis Data Streams sets the status of the stream back
/// to ACTIVE
. Depending on the size of the stream, the scaling action could
/// take a few minutes to complete. You can continue to read and write data to your stream
/// while its status is UPDATING
.
///
///
///
/// To update the shard count, Kinesis Data Streams performs splits or merges on individual
/// shards. This can cause short-lived shards to be created, in addition to the final
/// shards. We recommend that you double or halve the shard count, as this results in
/// the fewest number of splits or merges.
///
///
///
/// This operation has the following default limits. By default, you cannot do the following:
///
/// -
///
/// Scale more than twice per rolling 24-hour period per stream
///
///
-
///
/// Scale up to more than double your current shard count for a stream
///
///
-
///
/// Scale down below half your current shard count for a stream
///
///
-
///
/// Scale up to more than 500 shards in a stream
///
///
-
///
/// Scale a stream with more than 500 shards down unless the result is less than 500 shards
///
///
-
///
/// Scale up to more than the shard limit for your account
///
///
///
/// For the default limits for an AWS account, see Streams
/// Limits in the Amazon Kinesis Data Streams Developer Guide. To request an
/// increase in the call rate limit, the shard limit for this API, or your overall shard
/// limit, use the limits
/// form.
///
///
public partial class UpdateShardCountRequest : AmazonKinesisRequest
{
private ScalingType _scalingType;
private string _streamName;
private int? _targetShardCount;
///
/// Gets and sets the property ScalingType.
///
/// The scaling type. Uniform scaling creates shards of equal size.
///
///
[AWSProperty(Required=true)]
public ScalingType ScalingType
{
get { return this._scalingType; }
set { this._scalingType = value; }
}
// Check to see if ScalingType property is set
internal bool IsSetScalingType()
{
return this._scalingType != null;
}
///
/// Gets and sets the property StreamName.
///
/// The name of the stream.
///
///
[AWSProperty(Required=true, Min=1, Max=128)]
public string StreamName
{
get { return this._streamName; }
set { this._streamName = value; }
}
// Check to see if StreamName property is set
internal bool IsSetStreamName()
{
return this._streamName != null;
}
///
/// Gets and sets the property TargetShardCount.
///
/// The new number of shards.
///
///
[AWSProperty(Required=true, Min=1, Max=100000)]
public int TargetShardCount
{
get { return this._targetShardCount.GetValueOrDefault(); }
set { this._targetShardCount = value; }
}
// Check to see if TargetShardCount property is set
internal bool IsSetTargetShardCount()
{
return this._targetShardCount.HasValue;
}
}
}