Class CfnDataSourceProps
Properties for defining a CfnDataSource
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public class CfnDataSourceProps : Object, ICfnDataSourceProps
Syntax (vb)
Public Class CfnDataSourceProps
Inherits Object
Implements ICfnDataSourceProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;
var cfnDataSourceProps = new CfnDataSourceProps {
AlternateDataSourceParameters = new [] { new DataSourceParametersProperty {
AmazonElasticsearchParameters = new AmazonElasticsearchParametersProperty {
Domain = "domain"
},
AmazonOpenSearchParameters = new AmazonOpenSearchParametersProperty {
Domain = "domain"
},
AthenaParameters = new AthenaParametersProperty {
RoleArn = "roleArn",
WorkGroup = "workGroup"
},
AuroraParameters = new AuroraParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
AuroraPostgreSqlParameters = new AuroraPostgreSqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
DatabricksParameters = new DatabricksParametersProperty {
Host = "host",
Port = 123,
SqlEndpointPath = "sqlEndpointPath"
},
MariaDbParameters = new MariaDbParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
MySqlParameters = new MySqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
OracleParameters = new OracleParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
PostgreSqlParameters = new PostgreSqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
PrestoParameters = new PrestoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
},
RdsParameters = new RdsParametersProperty {
Database = "database",
InstanceId = "instanceId"
},
RedshiftParameters = new RedshiftParametersProperty {
Database = "database",
// the properties below are optional
ClusterId = "clusterId",
Host = "host",
Port = 123
},
S3Parameters = new S3ParametersProperty {
ManifestFileLocation = new ManifestFileLocationProperty {
Bucket = "bucket",
Key = "key"
},
// the properties below are optional
RoleArn = "roleArn"
},
SnowflakeParameters = new SnowflakeParametersProperty {
Database = "database",
Host = "host",
Warehouse = "warehouse"
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
}
} },
AwsAccountId = "awsAccountId",
Credentials = new DataSourceCredentialsProperty {
CopySourceArn = "copySourceArn",
CredentialPair = new CredentialPairProperty {
Password = "password",
Username = "username",
// the properties below are optional
AlternateDataSourceParameters = new [] { new DataSourceParametersProperty {
AmazonElasticsearchParameters = new AmazonElasticsearchParametersProperty {
Domain = "domain"
},
AmazonOpenSearchParameters = new AmazonOpenSearchParametersProperty {
Domain = "domain"
},
AthenaParameters = new AthenaParametersProperty {
RoleArn = "roleArn",
WorkGroup = "workGroup"
},
AuroraParameters = new AuroraParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
AuroraPostgreSqlParameters = new AuroraPostgreSqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
DatabricksParameters = new DatabricksParametersProperty {
Host = "host",
Port = 123,
SqlEndpointPath = "sqlEndpointPath"
},
MariaDbParameters = new MariaDbParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
MySqlParameters = new MySqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
OracleParameters = new OracleParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
PostgreSqlParameters = new PostgreSqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
PrestoParameters = new PrestoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
},
RdsParameters = new RdsParametersProperty {
Database = "database",
InstanceId = "instanceId"
},
RedshiftParameters = new RedshiftParametersProperty {
Database = "database",
// the properties below are optional
ClusterId = "clusterId",
Host = "host",
Port = 123
},
S3Parameters = new S3ParametersProperty {
ManifestFileLocation = new ManifestFileLocationProperty {
Bucket = "bucket",
Key = "key"
},
// the properties below are optional
RoleArn = "roleArn"
},
SnowflakeParameters = new SnowflakeParametersProperty {
Database = "database",
Host = "host",
Warehouse = "warehouse"
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
}
} }
},
SecretArn = "secretArn"
},
DataSourceId = "dataSourceId",
DataSourceParameters = new DataSourceParametersProperty {
AmazonElasticsearchParameters = new AmazonElasticsearchParametersProperty {
Domain = "domain"
},
AmazonOpenSearchParameters = new AmazonOpenSearchParametersProperty {
Domain = "domain"
},
AthenaParameters = new AthenaParametersProperty {
RoleArn = "roleArn",
WorkGroup = "workGroup"
},
AuroraParameters = new AuroraParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
AuroraPostgreSqlParameters = new AuroraPostgreSqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
DatabricksParameters = new DatabricksParametersProperty {
Host = "host",
Port = 123,
SqlEndpointPath = "sqlEndpointPath"
},
MariaDbParameters = new MariaDbParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
MySqlParameters = new MySqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
OracleParameters = new OracleParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
PostgreSqlParameters = new PostgreSqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
PrestoParameters = new PrestoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
},
RdsParameters = new RdsParametersProperty {
Database = "database",
InstanceId = "instanceId"
},
RedshiftParameters = new RedshiftParametersProperty {
Database = "database",
// the properties below are optional
ClusterId = "clusterId",
Host = "host",
Port = 123
},
S3Parameters = new S3ParametersProperty {
ManifestFileLocation = new ManifestFileLocationProperty {
Bucket = "bucket",
Key = "key"
},
// the properties below are optional
RoleArn = "roleArn"
},
SnowflakeParameters = new SnowflakeParametersProperty {
Database = "database",
Host = "host",
Warehouse = "warehouse"
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
}
},
ErrorInfo = new DataSourceErrorInfoProperty {
Message = "message",
Type = "type"
},
Name = "name",
Permissions = new [] { new ResourcePermissionProperty {
Actions = new [] { "actions" },
Principal = "principal"
} },
SslProperties = new SslPropertiesProperty {
DisableSsl = false
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type",
VpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
}
};
Synopsis
Constructors
CfnDataSourceProps() |
Properties
AlternateDataSourceParameters | A set of alternate data source parameters that you want to share for the credentials stored with this data source. |
AwsAccountId | The AWS account ID. |
Credentials | The credentials Amazon QuickSight that uses to connect to your underlying source. |
DataSourceId | An ID for the data source. |
DataSourceParameters | The parameters that Amazon QuickSight uses to connect to your underlying source. |
ErrorInfo | Error information from the last update or the creation of the data source. |
Name | A display name for the data source. |
Permissions | A list of resource permissions on the data source. |
SslProperties | Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. |
Tags | Contains a map of the key-value pairs for the resource tag or tags assigned to the data source. |
Type | The type of the data source. To return a list of all data sources, use |
VpcConnectionProperties | Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. |
Constructors
CfnDataSourceProps()
public CfnDataSourceProps()
Properties
AlternateDataSourceParameters
A set of alternate data source parameters that you want to share for the credentials stored with this data source.
public object AlternateDataSourceParameters { get; set; }
Property Value
System.Object
Remarks
The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters
structure that's in the request with the structures in the AlternateDataSourceParameters
allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters
list is null, the Credentials
originally used with this DataSourceParameters
are automatically allowed.
AwsAccountId
The AWS account ID.
public string AwsAccountId { get; set; }
Property Value
System.String
Remarks
Credentials
The credentials Amazon QuickSight that uses to connect to your underlying source.
public object Credentials { get; set; }
Property Value
System.Object
Remarks
Currently, only credentials based on user name and password are supported.
DataSourceId
An ID for the data source.
public string DataSourceId { get; set; }
Property Value
System.String
Remarks
This ID is unique per AWS Region for each AWS account.
DataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source.
public object DataSourceParameters { get; set; }
Property Value
System.Object
Remarks
ErrorInfo
Error information from the last update or the creation of the data source.
public object ErrorInfo { get; set; }
Property Value
System.Object
Remarks
Name
A display name for the data source.
public string Name { get; set; }
Property Value
System.String
Remarks
Permissions
A list of resource permissions on the data source.
public object Permissions { get; set; }
Property Value
System.Object
Remarks
SslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
public object SslProperties { get; set; }
Property Value
System.Object
Remarks
Tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
Type
The type of the data source. To return a list of all data sources, use ListDataSources
.
public string Type { get; set; }
Property Value
System.String
Remarks
Use AMAZON_ELASTICSEARCH
for Amazon OpenSearch Service.
VpcConnectionProperties
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
public object VpcConnectionProperties { get; set; }
Property Value
System.Object