text: ﻿/**
   * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * SPDX-License-Identifier: Apache-2.0.
   */
  
  #pragma once
  #include <aws/dms/DatabaseMigrationService_EXPORTS.h>
  #include <aws/core/utils/memory/stl/AWSString.h>
  #include <aws/dms/model/MessageFormatValue.h>
  #include <utility>
  
  namespace Aws
  {
  namespace Utils
  {
  namespace Json
  {
    class JsonValue;
    class JsonView;
  } // namespace Json
  } // namespace Utils
  namespace DatabaseMigrationService
  {
  namespace Model
  {
  
    /**
     * <p>Provides information that describes an Amazon Kinesis Data Stream endpoint.
     * This information includes the output format of records applied to the endpoint
     * and details of transaction and control table data information.</p><p><h3>See
     * Also:</h3>   <a
     * href="http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/KinesisSettings">AWS
     * API Reference</a></p>
     */
    class AWS_DATABASEMIGRATIONSERVICE_API KinesisSettings
    {
    public:
      KinesisSettings();
      KinesisSettings(Aws::Utils::Json::JsonView jsonValue);
      KinesisSettings& operator=(Aws::Utils::Json::JsonView jsonValue);
      Aws::Utils::Json::JsonValue Jsonize() const;
  
  
      /**
       * <p>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
       * endpoint.</p>
       */
      inline const Aws::String& GetStreamArn() const{ return m_streamArn; }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
       * endpoint.</p>
       */
      inline bool StreamArnHasBeenSet() const { return m_streamArnHasBeenSet; }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
       * endpoint.</p>
       */
      inline void SetStreamArn(const Aws::String& value) { m_streamArnHasBeenSet = true; m_streamArn = value; }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
       * endpoint.</p>
       */
      inline void SetStreamArn(Aws::String&& value) { m_streamArnHasBeenSet = true; m_streamArn = std::move(value); }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
       * endpoint.</p>
       */
      inline void SetStreamArn(const char* value) { m_streamArnHasBeenSet = true; m_streamArn.assign(value); }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
       * endpoint.</p>
       */
      inline KinesisSettings& WithStreamArn(const Aws::String& value) { SetStreamArn(value); return *this;}
  
      /**
       * <p>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
       * endpoint.</p>
       */
      inline KinesisSettings& WithStreamArn(Aws::String&& value) { SetStreamArn(std::move(value)); return *this;}
  
      /**
       * <p>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
       * endpoint.</p>
       */
      inline KinesisSettings& WithStreamArn(const char* value) { SetStreamArn(value); return *this;}
  
  
      /**
       * <p>The output format for the records created on the endpoint. The message format
       * is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line
       * with no tab).</p>
       */
      inline const MessageFormatValue& GetMessageFormat() const{ return m_messageFormat; }
  
      /**
       * <p>The output format for the records created on the endpoint. The message format
       * is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line
       * with no tab).</p>
       */
      inline bool MessageFormatHasBeenSet() const { return m_messageFormatHasBeenSet; }
  
      /**
       * <p>The output format for the records created on the endpoint. The message format
       * is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line
       * with no tab).</p>
       */
      inline void SetMessageFormat(const MessageFormatValue& value) { m_messageFormatHasBeenSet = true; m_messageFormat = value; }
  
      /**
       * <p>The output format for the records created on the endpoint. The message format
       * is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line
       * with no tab).</p>
       */
      inline void SetMessageFormat(MessageFormatValue&& value) { m_messageFormatHasBeenSet = true; m_messageFormat = std::move(value); }
  
      /**
       * <p>The output format for the records created on the endpoint. The message format
       * is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line
       * with no tab).</p>
       */
      inline KinesisSettings& WithMessageFormat(const MessageFormatValue& value) { SetMessageFormat(value); return *this;}
  
      /**
       * <p>The output format for the records created on the endpoint. The message format
       * is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line
       * with no tab).</p>
       */
      inline KinesisSettings& WithMessageFormat(MessageFormatValue&& value) { SetMessageFormat(std::move(value)); return *this;}
  
  
      /**
       * <p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management
       * (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>
       */
      inline const Aws::String& GetServiceAccessRoleArn() const{ return m_serviceAccessRoleArn; }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management
       * (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>
       */
      inline bool ServiceAccessRoleArnHasBeenSet() const { return m_serviceAccessRoleArnHasBeenSet; }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management
       * (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>
       */
      inline void SetServiceAccessRoleArn(const Aws::String& value) { m_serviceAccessRoleArnHasBeenSet = true; m_serviceAccessRoleArn = value; }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management
       * (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>
       */
      inline void SetServiceAccessRoleArn(Aws::String&& value) { m_serviceAccessRoleArnHasBeenSet = true; m_serviceAccessRoleArn = std::move(value); }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management
       * (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>
       */
      inline void SetServiceAccessRoleArn(const char* value) { m_serviceAccessRoleArnHasBeenSet = true; m_serviceAccessRoleArn.assign(value); }
  
      /**
       * <p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management
       * (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>
       */
      inline KinesisSettings& WithServiceAccessRoleArn(const Aws::String& value) { SetServiceAccessRoleArn(value); return *this;}
  
      /**
       * <p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management
       * (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>
       */
      inline KinesisSettings& WithServiceAccessRoleArn(Aws::String&& value) { SetServiceAccessRoleArn(std::move(value)); return *this;}
  
      /**
       * <p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management
       * (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>
       */
      inline KinesisSettings& WithServiceAccessRoleArn(const char* value) { SetServiceAccessRoleArn(value); return *this;}
  
  
      /**
       * <p>Provides detailed transaction information from the source database. This
       * information includes a commit timestamp, a log position, and values for
       * <code>transaction_id</code>, previous <code>transaction_id</code>, and
       * <code>transaction_record_id</code> (the record offset within a transaction). The
       * default is <code>false</code>.</p>
       */
      inline bool GetIncludeTransactionDetails() const{ return m_includeTransactionDetails; }
  
      /**
       * <p>Provides detailed transaction information from the source database. This
       * information includes a commit timestamp, a log position, and values for
       * <code>transaction_id</code>, previous <code>transaction_id</code>, and
       * <code>transaction_record_id</code> (the record offset within a transaction). The
       * default is <code>false</code>.</p>
       */
      inline bool IncludeTransactionDetailsHasBeenSet() const { return m_includeTransactionDetailsHasBeenSet; }
  
      /**
       * <p>Provides detailed transaction information from the source database. This
       * information includes a commit timestamp, a log position, and values for
       * <code>transaction_id</code>, previous <code>transaction_id</code>, and
       * <code>transaction_record_id</code> (the record offset within a transaction). The
       * default is <code>false</code>.</p>
       */
      inline void SetIncludeTransactionDetails(bool value) { m_includeTransactionDetailsHasBeenSet = true; m_includeTransactionDetails = value; }
  
      /**
       * <p>Provides detailed transaction information from the source database. This
       * information includes a commit timestamp, a log position, and values for
       * <code>transaction_id</code>, previous <code>transaction_id</code>, and
       * <code>transaction_record_id</code> (the record offset within a transaction). The
       * default is <code>false</code>.</p>
       */
      inline KinesisSettings& WithIncludeTransactionDetails(bool value) { SetIncludeTransactionDetails(value); return *this;}
  
  
      /**
       * <p>Shows the partition value within the Kinesis message output, unless the
       * partition type is <code>schema-table-type</code>. The default is
       * <code>false</code>.</p>
       */
      inline bool GetIncludePartitionValue() const{ return m_includePartitionValue; }
  
      /**
       * <p>Shows the partition value within the Kinesis message output, unless the
       * partition type is <code>schema-table-type</code>. The default is
       * <code>false</code>.</p>
       */
      inline bool IncludePartitionValueHasBeenSet() const { return m_includePartitionValueHasBeenSet; }
  
      /**
       * <p>Shows the partition value within the Kinesis message output, unless the
       * partition type is <code>schema-table-type</code>. The default is
       * <code>false</code>.</p>
       */
      inline void SetIncludePartitionValue(bool value) { m_includePartitionValueHasBeenSet = true; m_includePartitionValue = value; }
  
      /**
       * <p>Shows the partition value within the Kinesis message output, unless the
       * partition type is <code>schema-table-type</code>. The default is
       * <code>false</code>.</p>
       */
      inline KinesisSettings& WithIncludePartitionValue(bool value) { SetIncludePartitionValue(value); return *this;}
  
  
      /**
       * <p>Prefixes schema and table names to partition values, when the partition type
       * is <code>primary-key-type</code>. Doing this increases data distribution among
       * Kinesis shards. For example, suppose that a SysBench schema has thousands of
       * tables and each table has only limited range for a primary key. In this case,
       * the same primary key is sent from thousands of tables to the same shard, which
       * causes throttling. The default is <code>false</code>.</p>
       */
      inline bool GetPartitionIncludeSchemaTable() const{ return m_partitionIncludeSchemaTable; }
  
      /**
       * <p>Prefixes schema and table names to partition values, when the partition type
       * is <code>primary-key-type</code>. Doing this increases data distribution among
       * Kinesis shards. For example, suppose that a SysBench schema has thousands of
       * tables and each table has only limited range for a primary key. In this case,
       * the same primary key is sent from thousands of tables to the same shard, which
       * causes throttling. The default is <code>false</code>.</p>
       */
      inline bool PartitionIncludeSchemaTableHasBeenSet() const { return m_partitionIncludeSchemaTableHasBeenSet; }
  
      /**
       * <p>Prefixes schema and table names to partition values, when the partition type
       * is <code>primary-key-type</code>. Doing this increases data distribution among
       * Kinesis shards. For example, suppose that a SysBench schema has thousands of
       * tables and each table has only limited range for a primary key. In this case,
       * the same primary key is sent from thousands of tables to the same shard, which
       * causes throttling. The default is <code>false</code>.</p>
       */
      inline void SetPartitionIncludeSchemaTable(bool value) { m_partitionIncludeSchemaTableHasBeenSet = true; m_partitionIncludeSchemaTable = value; }
  
      /**
       * <p>Prefixes schema and table names to partition values, when the partition type
       * is <code>primary-key-type</code>. Doing this increases data distribution among
       * Kinesis shards. For example, suppose that a SysBench schema has thousands of
       * tables and each table has only limited range for a primary key. In this case,
       * the same primary key is sent from thousands of tables to the same shard, which
       * causes throttling. The default is <code>false</code>.</p>
       */
      inline KinesisSettings& WithPartitionIncludeSchemaTable(bool value) { SetPartitionIncludeSchemaTable(value); return *this;}
  
  
      /**
       * <p>Includes any data definition language (DDL) operations that change the table
       * in the control data, such as <code>rename-table</code>, <code>drop-table</code>,
       * <code>add-column</code>, <code>drop-column</code>, and
       * <code>rename-column</code>. The default is <code>false</code>.</p>
       */
      inline bool GetIncludeTableAlterOperations() const{ return m_includeTableAlterOperations; }
  
      /**
       * <p>Includes any data definition language (DDL) operations that change the table
       * in the control data, such as <code>rename-table</code>, <code>drop-table</code>,
       * <code>add-column</code>, <code>drop-column</code>, and
       * <code>rename-column</code>. The default is <code>false</code>.</p>
       */
      inline bool IncludeTableAlterOperationsHasBeenSet() const { return m_includeTableAlterOperationsHasBeenSet; }
  
      /**
       * <p>Includes any data definition language (DDL) operations that change the table
       * in the control data, such as <code>rename-table</code>, <code>drop-table</code>,
       * <code>add-column</code>, <code>drop-column</code>, and
       * <code>rename-column</code>. The default is <code>false</code>.</p>
       */
      inline void SetIncludeTableAlterOperations(bool value) { m_includeTableAlterOperationsHasBeenSet = true; m_includeTableAlterOperations = value; }
  
      /**
       * <p>Includes any data definition language (DDL) operations that change the table
       * in the control data, such as <code>rename-table</code>, <code>drop-table</code>,
       * <code>add-column</code>, <code>drop-column</code>, and
       * <code>rename-column</code>. The default is <code>false</code>.</p>
       */
      inline KinesisSettings& WithIncludeTableAlterOperations(bool value) { SetIncludeTableAlterOperations(value); return *this;}
  
  
      /**
       * <p>Shows detailed control information for table definition, column definition,
       * and table and column changes in the Kinesis message output. The default is
       * <code>false</code>.</p>
       */
      inline bool GetIncludeControlDetails() const{ return m_includeControlDetails; }
  
      /**
       * <p>Shows detailed control information for table definition, column definition,
       * and table and column changes in the Kinesis message output. The default is
       * <code>false</code>.</p>
       */
      inline bool IncludeControlDetailsHasBeenSet() const { return m_includeControlDetailsHasBeenSet; }
  
      /**
       * <p>Shows detailed control information for table definition, column definition,
       * and table and column changes in the Kinesis message output. The default is
       * <code>false</code>.</p>
       */
      inline void SetIncludeControlDetails(bool value) { m_includeControlDetailsHasBeenSet = true; m_includeControlDetails = value; }
  
      /**
       * <p>Shows detailed control information for table definition, column definition,
       * and table and column changes in the Kinesis message output. The default is
       * <code>false</code>.</p>
       */
      inline KinesisSettings& WithIncludeControlDetails(bool value) { SetIncludeControlDetails(value); return *this;}
  
  
      /**
       * <p>Include NULL and empty columns for records migrated to the endpoint. The
       * default is <code>false</code>.</p>
       */
      inline bool GetIncludeNullAndEmpty() const{ return m_includeNullAndEmpty; }
  
      /**
       * <p>Include NULL and empty columns for records migrated to the endpoint. The
       * default is <code>false</code>.</p>
       */
      inline bool IncludeNullAndEmptyHasBeenSet() const { return m_includeNullAndEmptyHasBeenSet; }
  
      /**
       * <p>Include NULL and empty columns for records migrated to the endpoint. The
       * default is <code>false</code>.</p>
       */
      inline void SetIncludeNullAndEmpty(bool value) { m_includeNullAndEmptyHasBeenSet = true; m_includeNullAndEmpty = value; }
  
      /**
       * <p>Include NULL and empty columns for records migrated to the endpoint. The
       * default is <code>false</code>.</p>
       */
      inline KinesisSettings& WithIncludeNullAndEmpty(bool value) { SetIncludeNullAndEmpty(value); return *this;}
  
    private:
  
      Aws::String m_streamArn;
      bool m_streamArnHasBeenSet;
  
      MessageFormatValue m_messageFormat;
      bool m_messageFormatHasBeenSet;
  
      Aws::String m_serviceAccessRoleArn;
      bool m_serviceAccessRoleArnHasBeenSet;
  
      bool m_includeTransactionDetails;
      bool m_includeTransactionDetailsHasBeenSet;
  
      bool m_includePartitionValue;
      bool m_includePartitionValueHasBeenSet;
  
      bool m_partitionIncludeSchemaTable;
      bool m_partitionIncludeSchemaTableHasBeenSet;
  
      bool m_includeTableAlterOperations;
      bool m_includeTableAlterOperationsHasBeenSet;
  
      bool m_includeControlDetails;
      bool m_includeControlDetailsHasBeenSet;
  
      bool m_includeNullAndEmpty;
      bool m_includeNullAndEmptyHasBeenSet;
    };
  
  } // namespace Model
  } // namespace DatabaseMigrationService
  } // namespace Aws
  