/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace QLDB { namespace Model { /** */ class StreamJournalToKinesisRequest : public QLDBRequest { public: AWS_QLDB_API StreamJournalToKinesisRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "StreamJournalToKinesis"; } AWS_QLDB_API Aws::String SerializePayload() const override; /** *

The name of the ledger.

*/ inline const Aws::String& GetLedgerName() const{ return m_ledgerName; } /** *

The name of the ledger.

*/ inline bool LedgerNameHasBeenSet() const { return m_ledgerNameHasBeenSet; } /** *

The name of the ledger.

*/ inline void SetLedgerName(const Aws::String& value) { m_ledgerNameHasBeenSet = true; m_ledgerName = value; } /** *

The name of the ledger.

*/ inline void SetLedgerName(Aws::String&& value) { m_ledgerNameHasBeenSet = true; m_ledgerName = std::move(value); } /** *

The name of the ledger.

*/ inline void SetLedgerName(const char* value) { m_ledgerNameHasBeenSet = true; m_ledgerName.assign(value); } /** *

The name of the ledger.

*/ inline StreamJournalToKinesisRequest& WithLedgerName(const Aws::String& value) { SetLedgerName(value); return *this;} /** *

The name of the ledger.

*/ inline StreamJournalToKinesisRequest& WithLedgerName(Aws::String&& value) { SetLedgerName(std::move(value)); return *this;} /** *

The name of the ledger.

*/ inline StreamJournalToKinesisRequest& WithLedgerName(const char* value) { SetLedgerName(value); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

To pass a role to QLDB when requesting a journal stream, you * must have permissions to perform the iam:PassRole action on the IAM * role resource. This is required for all journal stream requests.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

To pass a role to QLDB when requesting a journal stream, you * must have permissions to perform the iam:PassRole action on the IAM * role resource. This is required for all journal stream requests.

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

To pass a role to QLDB when requesting a journal stream, you * must have permissions to perform the iam:PassRole action on the IAM * role resource. This is required for all journal stream requests.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

To pass a role to QLDB when requesting a journal stream, you * must have permissions to perform the iam:PassRole action on the IAM * role resource. This is required for all journal stream requests.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

To pass a role to QLDB when requesting a journal stream, you * must have permissions to perform the iam:PassRole action on the IAM * role resource. This is required for all journal stream requests.

*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

To pass a role to QLDB when requesting a journal stream, you * must have permissions to perform the iam:PassRole action on the IAM * role resource. This is required for all journal stream requests.

*/ inline StreamJournalToKinesisRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

To pass a role to QLDB when requesting a journal stream, you * must have permissions to perform the iam:PassRole action on the IAM * role resource. This is required for all journal stream requests.

*/ inline StreamJournalToKinesisRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

To pass a role to QLDB when requesting a journal stream, you * must have permissions to perform the iam:PassRole action on the IAM * role resource. This is required for all journal stream requests.

*/ inline StreamJournalToKinesisRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

The key-value pairs to add as tags to the stream that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline StreamJournalToKinesisRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

The inclusive start date and time from which to start streaming journal data. * This parameter must be in ISO 8601 date and time format and in * Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

The InclusiveStartTime * cannot be in the future and must be before ExclusiveEndTime.

*

If you provide an InclusiveStartTime that is before the ledger's * CreationDateTime, QLDB effectively defaults it to the ledger's * CreationDateTime.

*/ inline const Aws::Utils::DateTime& GetInclusiveStartTime() const{ return m_inclusiveStartTime; } /** *

The inclusive start date and time from which to start streaming journal data. * This parameter must be in ISO 8601 date and time format and in * Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

The InclusiveStartTime * cannot be in the future and must be before ExclusiveEndTime.

*

If you provide an InclusiveStartTime that is before the ledger's * CreationDateTime, QLDB effectively defaults it to the ledger's * CreationDateTime.

*/ inline bool InclusiveStartTimeHasBeenSet() const { return m_inclusiveStartTimeHasBeenSet; } /** *

The inclusive start date and time from which to start streaming journal data. * This parameter must be in ISO 8601 date and time format and in * Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

The InclusiveStartTime * cannot be in the future and must be before ExclusiveEndTime.

*

If you provide an InclusiveStartTime that is before the ledger's * CreationDateTime, QLDB effectively defaults it to the ledger's * CreationDateTime.

*/ inline void SetInclusiveStartTime(const Aws::Utils::DateTime& value) { m_inclusiveStartTimeHasBeenSet = true; m_inclusiveStartTime = value; } /** *

The inclusive start date and time from which to start streaming journal data. * This parameter must be in ISO 8601 date and time format and in * Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

The InclusiveStartTime * cannot be in the future and must be before ExclusiveEndTime.

*

If you provide an InclusiveStartTime that is before the ledger's * CreationDateTime, QLDB effectively defaults it to the ledger's * CreationDateTime.

*/ inline void SetInclusiveStartTime(Aws::Utils::DateTime&& value) { m_inclusiveStartTimeHasBeenSet = true; m_inclusiveStartTime = std::move(value); } /** *

The inclusive start date and time from which to start streaming journal data. * This parameter must be in ISO 8601 date and time format and in * Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

The InclusiveStartTime * cannot be in the future and must be before ExclusiveEndTime.

*

If you provide an InclusiveStartTime that is before the ledger's * CreationDateTime, QLDB effectively defaults it to the ledger's * CreationDateTime.

*/ inline StreamJournalToKinesisRequest& WithInclusiveStartTime(const Aws::Utils::DateTime& value) { SetInclusiveStartTime(value); return *this;} /** *

The inclusive start date and time from which to start streaming journal data. * This parameter must be in ISO 8601 date and time format and in * Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

The InclusiveStartTime * cannot be in the future and must be before ExclusiveEndTime.

*

If you provide an InclusiveStartTime that is before the ledger's * CreationDateTime, QLDB effectively defaults it to the ledger's * CreationDateTime.

*/ inline StreamJournalToKinesisRequest& WithInclusiveStartTime(Aws::Utils::DateTime&& value) { SetInclusiveStartTime(std::move(value)); return *this;} /** *

The exclusive date and time that specifies when the stream ends. If you don't * define this parameter, the stream runs indefinitely until you cancel it.

*

The ExclusiveEndTime must be in ISO 8601 date and * time format and in Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

*/ inline const Aws::Utils::DateTime& GetExclusiveEndTime() const{ return m_exclusiveEndTime; } /** *

The exclusive date and time that specifies when the stream ends. If you don't * define this parameter, the stream runs indefinitely until you cancel it.

*

The ExclusiveEndTime must be in ISO 8601 date and * time format and in Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

*/ inline bool ExclusiveEndTimeHasBeenSet() const { return m_exclusiveEndTimeHasBeenSet; } /** *

The exclusive date and time that specifies when the stream ends. If you don't * define this parameter, the stream runs indefinitely until you cancel it.

*

The ExclusiveEndTime must be in ISO 8601 date and * time format and in Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

*/ inline void SetExclusiveEndTime(const Aws::Utils::DateTime& value) { m_exclusiveEndTimeHasBeenSet = true; m_exclusiveEndTime = value; } /** *

The exclusive date and time that specifies when the stream ends. If you don't * define this parameter, the stream runs indefinitely until you cancel it.

*

The ExclusiveEndTime must be in ISO 8601 date and * time format and in Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

*/ inline void SetExclusiveEndTime(Aws::Utils::DateTime&& value) { m_exclusiveEndTimeHasBeenSet = true; m_exclusiveEndTime = std::move(value); } /** *

The exclusive date and time that specifies when the stream ends. If you don't * define this parameter, the stream runs indefinitely until you cancel it.

*

The ExclusiveEndTime must be in ISO 8601 date and * time format and in Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

*/ inline StreamJournalToKinesisRequest& WithExclusiveEndTime(const Aws::Utils::DateTime& value) { SetExclusiveEndTime(value); return *this;} /** *

The exclusive date and time that specifies when the stream ends. If you don't * define this parameter, the stream runs indefinitely until you cancel it.

*

The ExclusiveEndTime must be in ISO 8601 date and * time format and in Universal Coordinated Time (UTC). For example: * 2019-06-13T21:36:34Z.

*/ inline StreamJournalToKinesisRequest& WithExclusiveEndTime(Aws::Utils::DateTime&& value) { SetExclusiveEndTime(std::move(value)); return *this;} /** *

The configuration settings of the Kinesis Data Streams destination for your * stream request.

*/ inline const KinesisConfiguration& GetKinesisConfiguration() const{ return m_kinesisConfiguration; } /** *

The configuration settings of the Kinesis Data Streams destination for your * stream request.

*/ inline bool KinesisConfigurationHasBeenSet() const { return m_kinesisConfigurationHasBeenSet; } /** *

The configuration settings of the Kinesis Data Streams destination for your * stream request.

*/ inline void SetKinesisConfiguration(const KinesisConfiguration& value) { m_kinesisConfigurationHasBeenSet = true; m_kinesisConfiguration = value; } /** *

The configuration settings of the Kinesis Data Streams destination for your * stream request.

*/ inline void SetKinesisConfiguration(KinesisConfiguration&& value) { m_kinesisConfigurationHasBeenSet = true; m_kinesisConfiguration = std::move(value); } /** *

The configuration settings of the Kinesis Data Streams destination for your * stream request.

*/ inline StreamJournalToKinesisRequest& WithKinesisConfiguration(const KinesisConfiguration& value) { SetKinesisConfiguration(value); return *this;} /** *

The configuration settings of the Kinesis Data Streams destination for your * stream request.

*/ inline StreamJournalToKinesisRequest& WithKinesisConfiguration(KinesisConfiguration&& value) { SetKinesisConfiguration(std::move(value)); return *this;} /** *

The name that you want to assign to the QLDB journal stream. User-defined * names can help identify and indicate the purpose of a stream.

Your stream * name must be unique among other active streams for a given ledger. Stream * names have the same naming constraints as ledger names, as defined in Quotas * in Amazon QLDB in the Amazon QLDB Developer Guide.

*/ inline const Aws::String& GetStreamName() const{ return m_streamName; } /** *

The name that you want to assign to the QLDB journal stream. User-defined * names can help identify and indicate the purpose of a stream.

Your stream * name must be unique among other active streams for a given ledger. Stream * names have the same naming constraints as ledger names, as defined in Quotas * in Amazon QLDB in the Amazon QLDB Developer Guide.

*/ inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; } /** *

The name that you want to assign to the QLDB journal stream. User-defined * names can help identify and indicate the purpose of a stream.

Your stream * name must be unique among other active streams for a given ledger. Stream * names have the same naming constraints as ledger names, as defined in Quotas * in Amazon QLDB in the Amazon QLDB Developer Guide.

*/ inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; } /** *

The name that you want to assign to the QLDB journal stream. User-defined * names can help identify and indicate the purpose of a stream.

Your stream * name must be unique among other active streams for a given ledger. Stream * names have the same naming constraints as ledger names, as defined in Quotas * in Amazon QLDB in the Amazon QLDB Developer Guide.

*/ inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); } /** *

The name that you want to assign to the QLDB journal stream. User-defined * names can help identify and indicate the purpose of a stream.

Your stream * name must be unique among other active streams for a given ledger. Stream * names have the same naming constraints as ledger names, as defined in Quotas * in Amazon QLDB in the Amazon QLDB Developer Guide.

*/ inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); } /** *

The name that you want to assign to the QLDB journal stream. User-defined * names can help identify and indicate the purpose of a stream.

Your stream * name must be unique among other active streams for a given ledger. Stream * names have the same naming constraints as ledger names, as defined in Quotas * in Amazon QLDB in the Amazon QLDB Developer Guide.

*/ inline StreamJournalToKinesisRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;} /** *

The name that you want to assign to the QLDB journal stream. User-defined * names can help identify and indicate the purpose of a stream.

Your stream * name must be unique among other active streams for a given ledger. Stream * names have the same naming constraints as ledger names, as defined in Quotas * in Amazon QLDB in the Amazon QLDB Developer Guide.

*/ inline StreamJournalToKinesisRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;} /** *

The name that you want to assign to the QLDB journal stream. User-defined * names can help identify and indicate the purpose of a stream.

Your stream * name must be unique among other active streams for a given ledger. Stream * names have the same naming constraints as ledger names, as defined in Quotas * in Amazon QLDB in the Amazon QLDB Developer Guide.

*/ inline StreamJournalToKinesisRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;} private: Aws::String m_ledgerName; bool m_ledgerNameHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::Map m_tags; bool m_tagsHasBeenSet = false; Aws::Utils::DateTime m_inclusiveStartTime; bool m_inclusiveStartTimeHasBeenSet = false; Aws::Utils::DateTime m_exclusiveEndTime; bool m_exclusiveEndTimeHasBeenSet = false; KinesisConfiguration m_kinesisConfiguration; bool m_kinesisConfigurationHasBeenSet = false; Aws::String m_streamName; bool m_streamNameHasBeenSet = false; }; } // namespace Model } // namespace QLDB } // namespace Aws