AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the IncreaseStreamRetentionPeriod operation. Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours (365 days).

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Kinesis.AmazonKinesisRequest
      Amazon.Kinesis.Model.IncreaseStreamRetentionPeriodRequest

Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z

Syntax

C#
public class IncreaseStreamRetentionPeriodRequest : AmazonKinesisRequest
         IAmazonWebServiceRequest

The IncreaseStreamRetentionPeriodRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property RetentionPeriodHours System.Int32

Gets and sets the property RetentionPeriodHours.

The new retention period of the stream, in hours. Must be more than the current retention period.

Public Property StreamARN System.String

Gets and sets the property StreamARN.

The ARN of the stream.

Public Property StreamName System.String

Gets and sets the property StreamName.

The name of the stream to modify.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5