AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::EventBridge::Model::KinesisParameters Class Reference

#include <KinesisParameters.h>

Public Member Functions

 KinesisParameters ()
 
 KinesisParameters (Aws::Utils::Json::JsonView jsonValue)
 
KinesisParametersoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetPartitionKeyPath () const
 
bool PartitionKeyPathHasBeenSet () const
 
void SetPartitionKeyPath (const Aws::String &value)
 
void SetPartitionKeyPath (Aws::String &&value)
 
void SetPartitionKeyPath (const char *value)
 
KinesisParametersWithPartitionKeyPath (const Aws::String &value)
 
KinesisParametersWithPartitionKeyPath (Aws::String &&value)
 
KinesisParametersWithPartitionKeyPath (const char *value)
 

Detailed Description

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

See Also:

AWS API Reference

Definition at line 35 of file KinesisParameters.h.

Constructor & Destructor Documentation

◆ KinesisParameters() [1/2]

Aws::EventBridge::Model::KinesisParameters::KinesisParameters ( )

◆ KinesisParameters() [2/2]

Aws::EventBridge::Model::KinesisParameters::KinesisParameters ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetPartitionKeyPath()

const Aws::String& Aws::EventBridge::Model::KinesisParameters::GetPartitionKeyPath ( ) const
inline

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Definition at line 51 of file KinesisParameters.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EventBridge::Model::KinesisParameters::Jsonize ( ) const

◆ operator=()

KinesisParameters& Aws::EventBridge::Model::KinesisParameters::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PartitionKeyPathHasBeenSet()

bool Aws::EventBridge::Model::KinesisParameters::PartitionKeyPathHasBeenSet ( ) const
inline

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Definition at line 60 of file KinesisParameters.h.

◆ SetPartitionKeyPath() [1/3]

void Aws::EventBridge::Model::KinesisParameters::SetPartitionKeyPath ( const Aws::String value)
inline

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Definition at line 69 of file KinesisParameters.h.

◆ SetPartitionKeyPath() [2/3]

void Aws::EventBridge::Model::KinesisParameters::SetPartitionKeyPath ( Aws::String &&  value)
inline

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Definition at line 78 of file KinesisParameters.h.

◆ SetPartitionKeyPath() [3/3]

void Aws::EventBridge::Model::KinesisParameters::SetPartitionKeyPath ( const char *  value)
inline

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Definition at line 87 of file KinesisParameters.h.

◆ WithPartitionKeyPath() [1/3]

KinesisParameters& Aws::EventBridge::Model::KinesisParameters::WithPartitionKeyPath ( const Aws::String value)
inline

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Definition at line 96 of file KinesisParameters.h.

◆ WithPartitionKeyPath() [2/3]

KinesisParameters& Aws::EventBridge::Model::KinesisParameters::WithPartitionKeyPath ( Aws::String &&  value)
inline

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Definition at line 105 of file KinesisParameters.h.

◆ WithPartitionKeyPath() [3/3]

KinesisParameters& Aws::EventBridge::Model::KinesisParameters::WithPartitionKeyPath ( const char *  value)
inline

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Definition at line 114 of file KinesisParameters.h.


The documentation for this class was generated from the following file: