pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-dms/include/aws/dms/model/NeptuneSettings.h

/**
 * 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 <utility>

namespace Aws
{
namespace Utils
{
namespace Json
{
  class JsonValue;
  class JsonView;
} // namespace Json
} // namespace Utils
namespace DatabaseMigrationService
{
namespace Model
{

  /**
   * <p>Provides information that defines an Amazon Neptune endpoint.</p><p><h3>See
   * Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/NeptuneSettings">AWS
   * API Reference</a></p>
   */
  class AWS_DATABASEMIGRATIONSERVICE_API NeptuneSettings
  {
  public:
    NeptuneSettings();
    NeptuneSettings(Aws::Utils::Json::JsonView jsonValue);
    NeptuneSettings& operator=(Aws::Utils::Json::JsonView jsonValue);
    Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * <p>The Amazon Resource Name (ARN) of the service role that you created for the
     * Neptune target endpoint. For more information, see <a
     * href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating
     * an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS
     * Database Migration Service User Guide. </i> </p>
     */
    inline const Aws::String& GetServiceAccessRoleArn() const{ return m_serviceAccessRoleArn; }

    /**
     * <p>The Amazon Resource Name (ARN) of the service role that you created for the
     * Neptune target endpoint. For more information, see <a
     * href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating
     * an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS
     * Database Migration Service User Guide. </i> </p>
     */
    inline bool ServiceAccessRoleArnHasBeenSet() const { return m_serviceAccessRoleArnHasBeenSet; }

    /**
     * <p>The Amazon Resource Name (ARN) of the service role that you created for the
     * Neptune target endpoint. For more information, see <a
     * href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating
     * an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS
     * Database Migration Service User Guide. </i> </p>
     */
    inline void SetServiceAccessRoleArn(const Aws::String& value) { m_serviceAccessRoleArnHasBeenSet = true; m_serviceAccessRoleArn = value; }

    /**
     * <p>The Amazon Resource Name (ARN) of the service role that you created for the
     * Neptune target endpoint. For more information, see <a
     * href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating
     * an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS
     * Database Migration Service User Guide. </i> </p>
     */
    inline void SetServiceAccessRoleArn(Aws::String&& value) { m_serviceAccessRoleArnHasBeenSet = true; m_serviceAccessRoleArn = std::move(value); }

    /**
     * <p>The Amazon Resource Name (ARN) of the service role that you created for the
     * Neptune target endpoint. For more information, see <a
     * href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating
     * an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS
     * Database Migration Service User Guide. </i> </p>
     */
    inline void SetServiceAccessRoleArn(const char* value) { m_serviceAccessRoleArnHasBeenSet = true; m_serviceAccessRoleArn.assign(value); }

    /**
     * <p>The Amazon Resource Name (ARN) of the service role that you created for the
     * Neptune target endpoint. For more information, see <a
     * href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating
     * an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS
     * Database Migration Service User Guide. </i> </p>
     */
    inline NeptuneSettings& WithServiceAccessRoleArn(const Aws::String& value) { SetServiceAccessRoleArn(value); return *this;}

    /**
     * <p>The Amazon Resource Name (ARN) of the service role that you created for the
     * Neptune target endpoint. For more information, see <a
     * href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating
     * an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS
     * Database Migration Service User Guide. </i> </p>
     */
    inline NeptuneSettings& WithServiceAccessRoleArn(Aws::String&& value) { SetServiceAccessRoleArn(std::move(value)); return *this;}

    /**
     * <p>The Amazon Resource Name (ARN) of the service role that you created for the
     * Neptune target endpoint. For more information, see <a
     * href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating
     * an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS
     * Database Migration Service User Guide. </i> </p>
     */
    inline NeptuneSettings& WithServiceAccessRoleArn(const char* value) { SetServiceAccessRoleArn(value); return *this;}


    /**
     * <p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated
     * graph data in .csv files before bulk-loading it to the Neptune target database.
     * AWS DMS maps the SQL source data to graph data before storing it in these .csv
     * files.</p>
     */
    inline const Aws::String& GetS3BucketName() const{ return m_s3BucketName; }

    /**
     * <p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated
     * graph data in .csv files before bulk-loading it to the Neptune target database.
     * AWS DMS maps the SQL source data to graph data before storing it in these .csv
     * files.</p>
     */
    inline bool S3BucketNameHasBeenSet() const { return m_s3BucketNameHasBeenSet; }

    /**
     * <p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated
     * graph data in .csv files before bulk-loading it to the Neptune target database.
     * AWS DMS maps the SQL source data to graph data before storing it in these .csv
     * files.</p>
     */
    inline void SetS3BucketName(const Aws::String& value) { m_s3BucketNameHasBeenSet = true; m_s3BucketName = value; }

    /**
     * <p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated
     * graph data in .csv files before bulk-loading it to the Neptune target database.
     * AWS DMS maps the SQL source data to graph data before storing it in these .csv
     * files.</p>
     */
    inline void SetS3BucketName(Aws::String&& value) { m_s3BucketNameHasBeenSet = true; m_s3BucketName = std::move(value); }

    /**
     * <p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated
     * graph data in .csv files before bulk-loading it to the Neptune target database.
     * AWS DMS maps the SQL source data to graph data before storing it in these .csv
     * files.</p>
     */
    inline void SetS3BucketName(const char* value) { m_s3BucketNameHasBeenSet = true; m_s3BucketName.assign(value); }

    /**
     * <p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated
     * graph data in .csv files before bulk-loading it to the Neptune target database.
     * AWS DMS maps the SQL source data to graph data before storing it in these .csv
     * files.</p>
     */
    inline NeptuneSettings& WithS3BucketName(const Aws::String& value) { SetS3BucketName(value); return *this;}

    /**
     * <p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated
     * graph data in .csv files before bulk-loading it to the Neptune target database.
     * AWS DMS maps the SQL source data to graph data before storing it in these .csv
     * files.</p>
     */
    inline NeptuneSettings& WithS3BucketName(Aws::String&& value) { SetS3BucketName(std::move(value)); return *this;}

    /**
     * <p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated
     * graph data in .csv files before bulk-loading it to the Neptune target database.
     * AWS DMS maps the SQL source data to graph data before storing it in these .csv
     * files.</p>
     */
    inline NeptuneSettings& WithS3BucketName(const char* value) { SetS3BucketName(value); return *this;}


    /**
     * <p>A folder path where you want AWS DMS to store migrated graph data in the S3
     * bucket specified by <code>S3BucketName</code> </p>
     */
    inline const Aws::String& GetS3BucketFolder() const{ return m_s3BucketFolder; }

    /**
     * <p>A folder path where you want AWS DMS to store migrated graph data in the S3
     * bucket specified by <code>S3BucketName</code> </p>
     */
    inline bool S3BucketFolderHasBeenSet() const { return m_s3BucketFolderHasBeenSet; }

    /**
     * <p>A folder path where you want AWS DMS to store migrated graph data in the S3
     * bucket specified by <code>S3BucketName</code> </p>
     */
    inline void SetS3BucketFolder(const Aws::String& value) { m_s3BucketFolderHasBeenSet = true; m_s3BucketFolder = value; }

    /**
     * <p>A folder path where you want AWS DMS to store migrated graph data in the S3
     * bucket specified by <code>S3BucketName</code> </p>
     */
    inline void SetS3BucketFolder(Aws::String&& value) { m_s3BucketFolderHasBeenSet = true; m_s3BucketFolder = std::move(value); }

    /**
     * <p>A folder path where you want AWS DMS to store migrated graph data in the S3
     * bucket specified by <code>S3BucketName</code> </p>
     */
    inline void SetS3BucketFolder(const char* value) { m_s3BucketFolderHasBeenSet = true; m_s3BucketFolder.assign(value); }

    /**
     * <p>A folder path where you want AWS DMS to store migrated graph data in the S3
     * bucket specified by <code>S3BucketName</code> </p>
     */
    inline NeptuneSettings& WithS3BucketFolder(const Aws::String& value) { SetS3BucketFolder(value); return *this;}

    /**
     * <p>A folder path where you want AWS DMS to store migrated graph data in the S3
     * bucket specified by <code>S3BucketName</code> </p>
     */
    inline NeptuneSettings& WithS3BucketFolder(Aws::String&& value) { SetS3BucketFolder(std::move(value)); return *this;}

    /**
     * <p>A folder path where you want AWS DMS to store migrated graph data in the S3
     * bucket specified by <code>S3BucketName</code> </p>
     */
    inline NeptuneSettings& WithS3BucketFolder(const char* value) { SetS3BucketFolder(value); return *this;}


    /**
     * <p>The number of milliseconds for AWS DMS to wait to retry a bulk-load of
     * migrated graph data to the Neptune target database before raising an error. The
     * default is 250.</p>
     */
    inline int GetErrorRetryDuration() const{ return m_errorRetryDuration; }

    /**
     * <p>The number of milliseconds for AWS DMS to wait to retry a bulk-load of
     * migrated graph data to the Neptune target database before raising an error. The
     * default is 250.</p>
     */
    inline bool ErrorRetryDurationHasBeenSet() const { return m_errorRetryDurationHasBeenSet; }

    /**
     * <p>The number of milliseconds for AWS DMS to wait to retry a bulk-load of
     * migrated graph data to the Neptune target database before raising an error. The
     * default is 250.</p>
     */
    inline void SetErrorRetryDuration(int value) { m_errorRetryDurationHasBeenSet = true; m_errorRetryDuration = value; }

    /**
     * <p>The number of milliseconds for AWS DMS to wait to retry a bulk-load of
     * migrated graph data to the Neptune target database before raising an error. The
     * default is 250.</p>
     */
    inline NeptuneSettings& WithErrorRetryDuration(int value) { SetErrorRetryDuration(value); return *this;}


    /**
     * <p>The maximum size in kilobytes of migrated graph data stored in a .csv file
     * before AWS DMS bulk-loads the data to the Neptune target database. The default
     * is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket,
     * ready to store the next batch of migrated graph data.</p>
     */
    inline int GetMaxFileSize() const{ return m_maxFileSize; }

    /**
     * <p>The maximum size in kilobytes of migrated graph data stored in a .csv file
     * before AWS DMS bulk-loads the data to the Neptune target database. The default
     * is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket,
     * ready to store the next batch of migrated graph data.</p>
     */
    inline bool MaxFileSizeHasBeenSet() const { return m_maxFileSizeHasBeenSet; }

    /**
     * <p>The maximum size in kilobytes of migrated graph data stored in a .csv file
     * before AWS DMS bulk-loads the data to the Neptune target database. The default
     * is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket,
     * ready to store the next batch of migrated graph data.</p>
     */
    inline void SetMaxFileSize(int value) { m_maxFileSizeHasBeenSet = true; m_maxFileSize = value; }

    /**
     * <p>The maximum size in kilobytes of migrated graph data stored in a .csv file
     * before AWS DMS bulk-loads the data to the Neptune target database. The default
     * is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket,
     * ready to store the next batch of migrated graph data.</p>
     */
    inline NeptuneSettings& WithMaxFileSize(int value) { SetMaxFileSize(value); return *this;}


    /**
     * <p>The number of times for AWS DMS to retry a bulk load of migrated graph data
     * to the Neptune target database before raising an error. The default is 5.</p>
     */
    inline int GetMaxRetryCount() const{ return m_maxRetryCount; }

    /**
     * <p>The number of times for AWS DMS to retry a bulk load of migrated graph data
     * to the Neptune target database before raising an error. The default is 5.</p>
     */
    inline bool MaxRetryCountHasBeenSet() const { return m_maxRetryCountHasBeenSet; }

    /**
     * <p>The number of times for AWS DMS to retry a bulk load of migrated graph data
     * to the Neptune target database before raising an error. The default is 5.</p>
     */
    inline void SetMaxRetryCount(int value) { m_maxRetryCountHasBeenSet = true; m_maxRetryCount = value; }

    /**
     * <p>The number of times for AWS DMS to retry a bulk load of migrated graph data
     * to the Neptune target database before raising an error. The default is 5.</p>
     */
    inline NeptuneSettings& WithMaxRetryCount(int value) { SetMaxRetryCount(value); return *this;}


    /**
     * <p>If you want AWS Identity and Access Management (IAM) authorization enabled
     * for this endpoint, set this parameter to <code>true</code>. Then attach the
     * appropriate IAM policy document to your service role specified by
     * <code>ServiceAccessRoleArn</code>. The default is <code>false</code>.</p>
     */
    inline bool GetIamAuthEnabled() const{ return m_iamAuthEnabled; }

    /**
     * <p>If you want AWS Identity and Access Management (IAM) authorization enabled
     * for this endpoint, set this parameter to <code>true</code>. Then attach the
     * appropriate IAM policy document to your service role specified by
     * <code>ServiceAccessRoleArn</code>. The default is <code>false</code>.</p>
     */
    inline bool IamAuthEnabledHasBeenSet() const { return m_iamAuthEnabledHasBeenSet; }

    /**
     * <p>If you want AWS Identity and Access Management (IAM) authorization enabled
     * for this endpoint, set this parameter to <code>true</code>. Then attach the
     * appropriate IAM policy document to your service role specified by
     * <code>ServiceAccessRoleArn</code>. The default is <code>false</code>.</p>
     */
    inline void SetIamAuthEnabled(bool value) { m_iamAuthEnabledHasBeenSet = true; m_iamAuthEnabled = value; }

    /**
     * <p>If you want AWS Identity and Access Management (IAM) authorization enabled
     * for this endpoint, set this parameter to <code>true</code>. Then attach the
     * appropriate IAM policy document to your service role specified by
     * <code>ServiceAccessRoleArn</code>. The default is <code>false</code>.</p>
     */
    inline NeptuneSettings& WithIamAuthEnabled(bool value) { SetIamAuthEnabled(value); return *this;}

  private:

    Aws::String m_serviceAccessRoleArn;
    bool m_serviceAccessRoleArnHasBeenSet;

    Aws::String m_s3BucketName;
    bool m_s3BucketNameHasBeenSet;

    Aws::String m_s3BucketFolder;
    bool m_s3BucketFolderHasBeenSet;

    int m_errorRetryDuration;
    bool m_errorRetryDurationHasBeenSet;

    int m_maxFileSize;
    bool m_maxFileSizeHasBeenSet;

    int m_maxRetryCount;
    bool m_maxRetryCountHasBeenSet;

    bool m_iamAuthEnabled;
    bool m_iamAuthEnabledHasBeenSet;
  };

} // namespace Model
} // namespace DatabaseMigrationService
} // namespace Aws