490 lines
19 KiB
C++
490 lines
19 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/quicksight/QuickSight_EXPORTS.h>
|
|
#include <aws/quicksight/QuickSightRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/quicksight/model/DataSourceType.h>
|
|
#include <aws/quicksight/model/DataSourceParameters.h>
|
|
#include <aws/quicksight/model/DataSourceCredentials.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/quicksight/model/VpcConnectionProperties.h>
|
|
#include <aws/quicksight/model/SslProperties.h>
|
|
#include <aws/quicksight/model/ResourcePermission.h>
|
|
#include <aws/quicksight/model/Tag.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace QuickSight
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_QUICKSIGHT_API CreateDataSourceRequest : public QuickSightRequest
|
|
{
|
|
public:
|
|
CreateDataSourceRequest();
|
|
|
|
// 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 "CreateDataSource"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
|
|
/**
|
|
* <p>The AWS account ID.</p>
|
|
*/
|
|
inline const Aws::String& GetAwsAccountId() const{ return m_awsAccountId; }
|
|
|
|
/**
|
|
* <p>The AWS account ID.</p>
|
|
*/
|
|
inline bool AwsAccountIdHasBeenSet() const { return m_awsAccountIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The AWS account ID.</p>
|
|
*/
|
|
inline void SetAwsAccountId(const Aws::String& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = value; }
|
|
|
|
/**
|
|
* <p>The AWS account ID.</p>
|
|
*/
|
|
inline void SetAwsAccountId(Aws::String&& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The AWS account ID.</p>
|
|
*/
|
|
inline void SetAwsAccountId(const char* value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId.assign(value); }
|
|
|
|
/**
|
|
* <p>The AWS account ID.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithAwsAccountId(const Aws::String& value) { SetAwsAccountId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The AWS account ID.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithAwsAccountId(Aws::String&& value) { SetAwsAccountId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The AWS account ID.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithAwsAccountId(const char* value) { SetAwsAccountId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>An ID for the data source. This ID is unique per AWS Region for each AWS
|
|
* account. </p>
|
|
*/
|
|
inline const Aws::String& GetDataSourceId() const{ return m_dataSourceId; }
|
|
|
|
/**
|
|
* <p>An ID for the data source. This ID is unique per AWS Region for each AWS
|
|
* account. </p>
|
|
*/
|
|
inline bool DataSourceIdHasBeenSet() const { return m_dataSourceIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>An ID for the data source. This ID is unique per AWS Region for each AWS
|
|
* account. </p>
|
|
*/
|
|
inline void SetDataSourceId(const Aws::String& value) { m_dataSourceIdHasBeenSet = true; m_dataSourceId = value; }
|
|
|
|
/**
|
|
* <p>An ID for the data source. This ID is unique per AWS Region for each AWS
|
|
* account. </p>
|
|
*/
|
|
inline void SetDataSourceId(Aws::String&& value) { m_dataSourceIdHasBeenSet = true; m_dataSourceId = std::move(value); }
|
|
|
|
/**
|
|
* <p>An ID for the data source. This ID is unique per AWS Region for each AWS
|
|
* account. </p>
|
|
*/
|
|
inline void SetDataSourceId(const char* value) { m_dataSourceIdHasBeenSet = true; m_dataSourceId.assign(value); }
|
|
|
|
/**
|
|
* <p>An ID for the data source. This ID is unique per AWS Region for each AWS
|
|
* account. </p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithDataSourceId(const Aws::String& value) { SetDataSourceId(value); return *this;}
|
|
|
|
/**
|
|
* <p>An ID for the data source. This ID is unique per AWS Region for each AWS
|
|
* account. </p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithDataSourceId(Aws::String&& value) { SetDataSourceId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>An ID for the data source. This ID is unique per AWS Region for each AWS
|
|
* account. </p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithDataSourceId(const char* value) { SetDataSourceId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A display name for the data source.</p>
|
|
*/
|
|
inline const Aws::String& GetName() const{ return m_name; }
|
|
|
|
/**
|
|
* <p>A display name for the data source.</p>
|
|
*/
|
|
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A display name for the data source.</p>
|
|
*/
|
|
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
|
|
|
|
/**
|
|
* <p>A display name for the data source.</p>
|
|
*/
|
|
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
|
|
|
|
/**
|
|
* <p>A display name for the data source.</p>
|
|
*/
|
|
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
|
|
|
|
/**
|
|
* <p>A display name for the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
|
|
|
|
/**
|
|
* <p>A display name for the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A display name for the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithName(const char* value) { SetName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The type of the data source. Currently, the supported types for this
|
|
* operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
|
|
* POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>.
|
|
* Use <code>ListDataSources</code> to return a list of all data sources.</p>
|
|
*/
|
|
inline const DataSourceType& GetType() const{ return m_type; }
|
|
|
|
/**
|
|
* <p>The type of the data source. Currently, the supported types for this
|
|
* operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
|
|
* POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>.
|
|
* Use <code>ListDataSources</code> to return a list of all data sources.</p>
|
|
*/
|
|
inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The type of the data source. Currently, the supported types for this
|
|
* operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
|
|
* POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>.
|
|
* Use <code>ListDataSources</code> to return a list of all data sources.</p>
|
|
*/
|
|
inline void SetType(const DataSourceType& value) { m_typeHasBeenSet = true; m_type = value; }
|
|
|
|
/**
|
|
* <p>The type of the data source. Currently, the supported types for this
|
|
* operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
|
|
* POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>.
|
|
* Use <code>ListDataSources</code> to return a list of all data sources.</p>
|
|
*/
|
|
inline void SetType(DataSourceType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); }
|
|
|
|
/**
|
|
* <p>The type of the data source. Currently, the supported types for this
|
|
* operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
|
|
* POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>.
|
|
* Use <code>ListDataSources</code> to return a list of all data sources.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithType(const DataSourceType& value) { SetType(value); return *this;}
|
|
|
|
/**
|
|
* <p>The type of the data source. Currently, the supported types for this
|
|
* operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
|
|
* POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>.
|
|
* Use <code>ListDataSources</code> to return a list of all data sources.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithType(DataSourceType&& value) { SetType(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
*/
|
|
inline const DataSourceParameters& GetDataSourceParameters() const{ return m_dataSourceParameters; }
|
|
|
|
/**
|
|
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
*/
|
|
inline bool DataSourceParametersHasBeenSet() const { return m_dataSourceParametersHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
*/
|
|
inline void SetDataSourceParameters(const DataSourceParameters& value) { m_dataSourceParametersHasBeenSet = true; m_dataSourceParameters = value; }
|
|
|
|
/**
|
|
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
*/
|
|
inline void SetDataSourceParameters(DataSourceParameters&& value) { m_dataSourceParametersHasBeenSet = true; m_dataSourceParameters = std::move(value); }
|
|
|
|
/**
|
|
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithDataSourceParameters(const DataSourceParameters& value) { SetDataSourceParameters(value); return *this;}
|
|
|
|
/**
|
|
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithDataSourceParameters(DataSourceParameters&& value) { SetDataSourceParameters(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The credentials QuickSight that uses to connect to your underlying source.
|
|
* Currently, only credentials based on user name and password are supported.</p>
|
|
*/
|
|
inline const DataSourceCredentials& GetCredentials() const{ return m_credentials; }
|
|
|
|
/**
|
|
* <p>The credentials QuickSight that uses to connect to your underlying source.
|
|
* Currently, only credentials based on user name and password are supported.</p>
|
|
*/
|
|
inline bool CredentialsHasBeenSet() const { return m_credentialsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The credentials QuickSight that uses to connect to your underlying source.
|
|
* Currently, only credentials based on user name and password are supported.</p>
|
|
*/
|
|
inline void SetCredentials(const DataSourceCredentials& value) { m_credentialsHasBeenSet = true; m_credentials = value; }
|
|
|
|
/**
|
|
* <p>The credentials QuickSight that uses to connect to your underlying source.
|
|
* Currently, only credentials based on user name and password are supported.</p>
|
|
*/
|
|
inline void SetCredentials(DataSourceCredentials&& value) { m_credentialsHasBeenSet = true; m_credentials = std::move(value); }
|
|
|
|
/**
|
|
* <p>The credentials QuickSight that uses to connect to your underlying source.
|
|
* Currently, only credentials based on user name and password are supported.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithCredentials(const DataSourceCredentials& value) { SetCredentials(value); return *this;}
|
|
|
|
/**
|
|
* <p>The credentials QuickSight that uses to connect to your underlying source.
|
|
* Currently, only credentials based on user name and password are supported.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithCredentials(DataSourceCredentials&& value) { SetCredentials(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A list of resource permissions on the data source.</p>
|
|
*/
|
|
inline const Aws::Vector<ResourcePermission>& GetPermissions() const{ return m_permissions; }
|
|
|
|
/**
|
|
* <p>A list of resource permissions on the data source.</p>
|
|
*/
|
|
inline bool PermissionsHasBeenSet() const { return m_permissionsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A list of resource permissions on the data source.</p>
|
|
*/
|
|
inline void SetPermissions(const Aws::Vector<ResourcePermission>& value) { m_permissionsHasBeenSet = true; m_permissions = value; }
|
|
|
|
/**
|
|
* <p>A list of resource permissions on the data source.</p>
|
|
*/
|
|
inline void SetPermissions(Aws::Vector<ResourcePermission>&& value) { m_permissionsHasBeenSet = true; m_permissions = std::move(value); }
|
|
|
|
/**
|
|
* <p>A list of resource permissions on the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithPermissions(const Aws::Vector<ResourcePermission>& value) { SetPermissions(value); return *this;}
|
|
|
|
/**
|
|
* <p>A list of resource permissions on the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithPermissions(Aws::Vector<ResourcePermission>&& value) { SetPermissions(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A list of resource permissions on the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& AddPermissions(const ResourcePermission& value) { m_permissionsHasBeenSet = true; m_permissions.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>A list of resource permissions on the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& AddPermissions(ResourcePermission&& value) { m_permissionsHasBeenSet = true; m_permissions.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>Use this parameter only when you want QuickSight to use a VPC connection when
|
|
* connecting to your underlying source.</p>
|
|
*/
|
|
inline const VpcConnectionProperties& GetVpcConnectionProperties() const{ return m_vpcConnectionProperties; }
|
|
|
|
/**
|
|
* <p>Use this parameter only when you want QuickSight to use a VPC connection when
|
|
* connecting to your underlying source.</p>
|
|
*/
|
|
inline bool VpcConnectionPropertiesHasBeenSet() const { return m_vpcConnectionPropertiesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Use this parameter only when you want QuickSight to use a VPC connection when
|
|
* connecting to your underlying source.</p>
|
|
*/
|
|
inline void SetVpcConnectionProperties(const VpcConnectionProperties& value) { m_vpcConnectionPropertiesHasBeenSet = true; m_vpcConnectionProperties = value; }
|
|
|
|
/**
|
|
* <p>Use this parameter only when you want QuickSight to use a VPC connection when
|
|
* connecting to your underlying source.</p>
|
|
*/
|
|
inline void SetVpcConnectionProperties(VpcConnectionProperties&& value) { m_vpcConnectionPropertiesHasBeenSet = true; m_vpcConnectionProperties = std::move(value); }
|
|
|
|
/**
|
|
* <p>Use this parameter only when you want QuickSight to use a VPC connection when
|
|
* connecting to your underlying source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithVpcConnectionProperties(const VpcConnectionProperties& value) { SetVpcConnectionProperties(value); return *this;}
|
|
|
|
/**
|
|
* <p>Use this parameter only when you want QuickSight to use a VPC connection when
|
|
* connecting to your underlying source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithVpcConnectionProperties(VpcConnectionProperties&& value) { SetVpcConnectionProperties(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to
|
|
* your underlying source.</p>
|
|
*/
|
|
inline const SslProperties& GetSslProperties() const{ return m_sslProperties; }
|
|
|
|
/**
|
|
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to
|
|
* your underlying source.</p>
|
|
*/
|
|
inline bool SslPropertiesHasBeenSet() const { return m_sslPropertiesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to
|
|
* your underlying source.</p>
|
|
*/
|
|
inline void SetSslProperties(const SslProperties& value) { m_sslPropertiesHasBeenSet = true; m_sslProperties = value; }
|
|
|
|
/**
|
|
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to
|
|
* your underlying source.</p>
|
|
*/
|
|
inline void SetSslProperties(SslProperties&& value) { m_sslPropertiesHasBeenSet = true; m_sslProperties = std::move(value); }
|
|
|
|
/**
|
|
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to
|
|
* your underlying source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithSslProperties(const SslProperties& value) { SetSslProperties(value); return *this;}
|
|
|
|
/**
|
|
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to
|
|
* your underlying source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithSslProperties(SslProperties&& value) { SetSslProperties(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned
|
|
* to the data source.</p>
|
|
*/
|
|
inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
|
|
|
|
/**
|
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned
|
|
* to the data source.</p>
|
|
*/
|
|
inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned
|
|
* to the data source.</p>
|
|
*/
|
|
inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
|
|
|
|
/**
|
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned
|
|
* to the data source.</p>
|
|
*/
|
|
inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
|
|
|
|
/**
|
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned
|
|
* to the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
|
|
|
|
/**
|
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned
|
|
* to the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned
|
|
* to the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned
|
|
* to the data source.</p>
|
|
*/
|
|
inline CreateDataSourceRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
|
|
|
|
private:
|
|
|
|
Aws::String m_awsAccountId;
|
|
bool m_awsAccountIdHasBeenSet;
|
|
|
|
Aws::String m_dataSourceId;
|
|
bool m_dataSourceIdHasBeenSet;
|
|
|
|
Aws::String m_name;
|
|
bool m_nameHasBeenSet;
|
|
|
|
DataSourceType m_type;
|
|
bool m_typeHasBeenSet;
|
|
|
|
DataSourceParameters m_dataSourceParameters;
|
|
bool m_dataSourceParametersHasBeenSet;
|
|
|
|
DataSourceCredentials m_credentials;
|
|
bool m_credentialsHasBeenSet;
|
|
|
|
Aws::Vector<ResourcePermission> m_permissions;
|
|
bool m_permissionsHasBeenSet;
|
|
|
|
VpcConnectionProperties m_vpcConnectionProperties;
|
|
bool m_vpcConnectionPropertiesHasBeenSet;
|
|
|
|
SslProperties m_sslProperties;
|
|
bool m_sslPropertiesHasBeenSet;
|
|
|
|
Aws::Vector<Tag> m_tags;
|
|
bool m_tagsHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace QuickSight
|
|
} // namespace Aws
|