/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Kinesis { namespace Model { /** */ class StopStreamEncryptionRequest : public KinesisRequest { public: AWS_KINESIS_API StopStreamEncryptionRequest(); // 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 "StopStreamEncryption"; } AWS_KINESIS_API Aws::String SerializePayload() const override; AWS_KINESIS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_KINESIS_API EndpointParameters GetEndpointContextParams() const override; /** *

The name of the stream on which to stop encrypting records.

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

The name of the stream on which to stop encrypting records.

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

The name of the stream on which to stop encrypting records.

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

The name of the stream on which to stop encrypting records.

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

The name of the stream on which to stop encrypting records.

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

The name of the stream on which to stop encrypting records.

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

The name of the stream on which to stop encrypting records.

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

The name of the stream on which to stop encrypting records.

*/ inline StopStreamEncryptionRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;} /** *

The encryption type. The only valid value is KMS.

*/ inline const EncryptionType& GetEncryptionType() const{ return m_encryptionType; } /** *

The encryption type. The only valid value is KMS.

*/ inline bool EncryptionTypeHasBeenSet() const { return m_encryptionTypeHasBeenSet; } /** *

The encryption type. The only valid value is KMS.

*/ inline void SetEncryptionType(const EncryptionType& value) { m_encryptionTypeHasBeenSet = true; m_encryptionType = value; } /** *

The encryption type. The only valid value is KMS.

*/ inline void SetEncryptionType(EncryptionType&& value) { m_encryptionTypeHasBeenSet = true; m_encryptionType = std::move(value); } /** *

The encryption type. The only valid value is KMS.

*/ inline StopStreamEncryptionRequest& WithEncryptionType(const EncryptionType& value) { SetEncryptionType(value); return *this;} /** *

The encryption type. The only valid value is KMS.

*/ inline StopStreamEncryptionRequest& WithEncryptionType(EncryptionType&& value) { SetEncryptionType(std::move(value)); return *this;} /** *

The GUID for the customer-managed Amazon Web Services KMS key to use for * encryption. This value can be a globally unique identifier, a fully specified * Amazon Resource Name (ARN) to either an alias or a key, or an alias name * prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams * by specifying the alias aws/kinesis.

  • Key ARN * example: * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 *

  • Alias ARN example: * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • *
  • Globally unique key ID example: * 12345678-1234-1234-1234-123456789012

  • Alias name * example: alias/MyAliasName

  • Master key owned by * Kinesis Data Streams: alias/aws/kinesis

*/ inline const Aws::String& GetKeyId() const{ return m_keyId; } /** *

The GUID for the customer-managed Amazon Web Services KMS key to use for * encryption. This value can be a globally unique identifier, a fully specified * Amazon Resource Name (ARN) to either an alias or a key, or an alias name * prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams * by specifying the alias aws/kinesis.

  • Key ARN * example: * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 *

  • Alias ARN example: * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • *
  • Globally unique key ID example: * 12345678-1234-1234-1234-123456789012

  • Alias name * example: alias/MyAliasName

  • Master key owned by * Kinesis Data Streams: alias/aws/kinesis

*/ inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; } /** *

The GUID for the customer-managed Amazon Web Services KMS key to use for * encryption. This value can be a globally unique identifier, a fully specified * Amazon Resource Name (ARN) to either an alias or a key, or an alias name * prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams * by specifying the alias aws/kinesis.

  • Key ARN * example: * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 *

  • Alias ARN example: * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • *
  • Globally unique key ID example: * 12345678-1234-1234-1234-123456789012

  • Alias name * example: alias/MyAliasName

  • Master key owned by * Kinesis Data Streams: alias/aws/kinesis

*/ inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; } /** *

The GUID for the customer-managed Amazon Web Services KMS key to use for * encryption. This value can be a globally unique identifier, a fully specified * Amazon Resource Name (ARN) to either an alias or a key, or an alias name * prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams * by specifying the alias aws/kinesis.

  • Key ARN * example: * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 *

  • Alias ARN example: * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • *
  • Globally unique key ID example: * 12345678-1234-1234-1234-123456789012

  • Alias name * example: alias/MyAliasName

  • Master key owned by * Kinesis Data Streams: alias/aws/kinesis

*/ inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); } /** *

The GUID for the customer-managed Amazon Web Services KMS key to use for * encryption. This value can be a globally unique identifier, a fully specified * Amazon Resource Name (ARN) to either an alias or a key, or an alias name * prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams * by specifying the alias aws/kinesis.

  • Key ARN * example: * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 *

  • Alias ARN example: * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • *
  • Globally unique key ID example: * 12345678-1234-1234-1234-123456789012

  • Alias name * example: alias/MyAliasName

  • Master key owned by * Kinesis Data Streams: alias/aws/kinesis

*/ inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); } /** *

The GUID for the customer-managed Amazon Web Services KMS key to use for * encryption. This value can be a globally unique identifier, a fully specified * Amazon Resource Name (ARN) to either an alias or a key, or an alias name * prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams * by specifying the alias aws/kinesis.

  • Key ARN * example: * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 *

  • Alias ARN example: * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • *
  • Globally unique key ID example: * 12345678-1234-1234-1234-123456789012

  • Alias name * example: alias/MyAliasName

  • Master key owned by * Kinesis Data Streams: alias/aws/kinesis

*/ inline StopStreamEncryptionRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;} /** *

The GUID for the customer-managed Amazon Web Services KMS key to use for * encryption. This value can be a globally unique identifier, a fully specified * Amazon Resource Name (ARN) to either an alias or a key, or an alias name * prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams * by specifying the alias aws/kinesis.

  • Key ARN * example: * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 *

  • Alias ARN example: * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • *
  • Globally unique key ID example: * 12345678-1234-1234-1234-123456789012

  • Alias name * example: alias/MyAliasName

  • Master key owned by * Kinesis Data Streams: alias/aws/kinesis

*/ inline StopStreamEncryptionRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;} /** *

The GUID for the customer-managed Amazon Web Services KMS key to use for * encryption. This value can be a globally unique identifier, a fully specified * Amazon Resource Name (ARN) to either an alias or a key, or an alias name * prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams * by specifying the alias aws/kinesis.

  • Key ARN * example: * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 *

  • Alias ARN example: * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • *
  • Globally unique key ID example: * 12345678-1234-1234-1234-123456789012

  • Alias name * example: alias/MyAliasName

  • Master key owned by * Kinesis Data Streams: alias/aws/kinesis

*/ inline StopStreamEncryptionRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;} /** *

The ARN of the stream.

*/ inline const Aws::String& GetStreamARN() const{ return m_streamARN; } /** *

The ARN of the stream.

*/ inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; } /** *

The ARN of the stream.

*/ inline void SetStreamARN(const Aws::String& value) { m_streamARNHasBeenSet = true; m_streamARN = value; } /** *

The ARN of the stream.

*/ inline void SetStreamARN(Aws::String&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::move(value); } /** *

The ARN of the stream.

*/ inline void SetStreamARN(const char* value) { m_streamARNHasBeenSet = true; m_streamARN.assign(value); } /** *

The ARN of the stream.

*/ inline StopStreamEncryptionRequest& WithStreamARN(const Aws::String& value) { SetStreamARN(value); return *this;} /** *

The ARN of the stream.

*/ inline StopStreamEncryptionRequest& WithStreamARN(Aws::String&& value) { SetStreamARN(std::move(value)); return *this;} /** *

The ARN of the stream.

*/ inline StopStreamEncryptionRequest& WithStreamARN(const char* value) { SetStreamARN(value); return *this;} private: Aws::String m_streamName; bool m_streamNameHasBeenSet = false; EncryptionType m_encryptionType; bool m_encryptionTypeHasBeenSet = false; Aws::String m_keyId; bool m_keyIdHasBeenSet = false; Aws::String m_streamARN; bool m_streamARNHasBeenSet = false; }; } // namespace Model } // namespace Kinesis } // namespace Aws