Class CfnDataSource
Creates a data source.
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataSource : CfnResource, IInspectable, ITaggableSyntax (vb)
Public Class CfnDataSource Inherits CfnResource Implements IInspectable, ITaggableRemarks
CloudformationResource: AWS::QuickSight::DataSource
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 cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", new CfnDataSourceProps {
Name = "name",
Type = "type",
// 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",
IamParameters = new RedshiftIAMParametersProperty {
RoleArn = "roleArn",
// the properties below are optional
AutoCreateDatabaseUser = false,
DatabaseGroups = new [] { "databaseGroups" },
DatabaseUser = "databaseUser"
},
IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
EnableIdentityPropagation = false
},
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",
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
}
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
StarburstParameters = new StarburstParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123,
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
},
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
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",
IamParameters = new RedshiftIAMParametersProperty {
RoleArn = "roleArn",
// the properties below are optional
AutoCreateDatabaseUser = false,
DatabaseGroups = new [] { "databaseGroups" },
DatabaseUser = "databaseUser"
},
IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
EnableIdentityPropagation = false
},
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",
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
}
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
StarburstParameters = new StarburstParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123,
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
},
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
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",
IamParameters = new RedshiftIAMParametersProperty {
RoleArn = "roleArn",
// the properties below are optional
AutoCreateDatabaseUser = false,
DatabaseGroups = new [] { "databaseGroups" },
DatabaseUser = "databaseUser"
},
IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
EnableIdentityPropagation = false
},
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",
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
}
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
StarburstParameters = new StarburstParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123,
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
},
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
}
},
ErrorInfo = new DataSourceErrorInfoProperty {
Message = "message",
Type = "type"
},
FolderArns = new [] { "folderArns" },
Permissions = new [] { new ResourcePermissionProperty {
Actions = new [] { "actions" },
Principal = "principal",
// the properties below are optional
Resource = "resource"
} },
SslProperties = new SslPropertiesProperty {
DisableSsl = false
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
}
});Synopsis
Constructors
| CfnDataSource(Construct, string, ICfnDataSourceProps) | Creates a data source. |
Properties
| AlternateDataSourceParameters | A set of alternate data source parameters that you want to share for the credentials stored with this data source. |
| AttrArn | The Amazon Resource Name (ARN) of the dataset. |
| AttrCreatedTime | The time that this data source was created. |
| AttrLastUpdatedTime | The last time that this data source was updated. |
| AttrStatus | The HTTP status of the request. |
| AwsAccountId | The AWS account ID. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | Creates a data source. |
| 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. |
| FolderArns | Creates a 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 | Tag Manager which manages the tags for this resource. |
| TagsRaw | 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. |
| VpcConnectionProperties | Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<string, object>) | Creates a data source. |
Constructors
CfnDataSource(Construct, string, ICfnDataSourceProps)
Creates a data source.
public CfnDataSource(Construct scope, string id, ICfnDataSourceProps props)Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnDataSourceProps
Resource properties.
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
Properties
AlternateDataSourceParameters
A set of alternate data source parameters that you want to share for the credentials stored with this data source.
public virtual object? AlternateDataSourceParameters { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
AttrArn
The Amazon Resource Name (ARN) of the dataset.
public virtual string AttrArn { get; }Property Value
Remarks
CloudformationAttribute: Arn
AttrCreatedTime
The time that this data source was created.
public virtual string AttrCreatedTime { get; }Property Value
Remarks
CloudformationAttribute: CreatedTime
AttrLastUpdatedTime
The last time that this data source was updated.
public virtual string AttrLastUpdatedTime { get; }Property Value
Remarks
CloudformationAttribute: LastUpdatedTime
AttrStatus
The HTTP status of the request.
public virtual string AttrStatus { get; }Property Value
Remarks
CloudformationAttribute: Status
AwsAccountId
The AWS account ID.
public virtual string? AwsAccountId { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
CfnProperties
Creates a data source.
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Overrides
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
Credentials
The credentials Amazon QuickSight that uses to connect to your underlying source.
public virtual object? Credentials { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
DataSourceId
An ID for the data source.
public virtual string? DataSourceId { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
DataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source.
public virtual object? DataSourceParameters { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
ErrorInfo
Error information from the last update or the creation of the data source.
public virtual object? ErrorInfo { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
FolderArns
Creates a data source.
public virtual string[]? FolderArns { get; set; }Property Value
string[]
Remarks
CloudformationResource: AWS::QuickSight::DataSource
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 cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", new CfnDataSourceProps {
Name = "name",
Type = "type",
// 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",
IamParameters = new RedshiftIAMParametersProperty {
RoleArn = "roleArn",
// the properties below are optional
AutoCreateDatabaseUser = false,
DatabaseGroups = new [] { "databaseGroups" },
DatabaseUser = "databaseUser"
},
IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
EnableIdentityPropagation = false
},
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",
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
}
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
StarburstParameters = new StarburstParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123,
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
},
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
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",
IamParameters = new RedshiftIAMParametersProperty {
RoleArn = "roleArn",
// the properties below are optional
AutoCreateDatabaseUser = false,
DatabaseGroups = new [] { "databaseGroups" },
DatabaseUser = "databaseUser"
},
IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
EnableIdentityPropagation = false
},
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",
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
}
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
StarburstParameters = new StarburstParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123,
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
},
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
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",
IamParameters = new RedshiftIAMParametersProperty {
RoleArn = "roleArn",
// the properties below are optional
AutoCreateDatabaseUser = false,
DatabaseGroups = new [] { "databaseGroups" },
DatabaseUser = "databaseUser"
},
IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
EnableIdentityPropagation = false
},
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",
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
}
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
StarburstParameters = new StarburstParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123,
// the properties below are optional
AuthenticationType = "authenticationType",
DatabaseAccessControlRole = "databaseAccessControlRole",
OAuthParameters = new OAuthParametersProperty {
TokenProviderUrl = "tokenProviderUrl",
// the properties below are optional
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope"
},
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
}
},
ErrorInfo = new DataSourceErrorInfoProperty {
Message = "message",
Type = "type"
},
FolderArns = new [] { "folderArns" },
Permissions = new [] { new ResourcePermissionProperty {
Actions = new [] { "actions" },
Principal = "principal",
// the properties below are optional
Resource = "resource"
} },
SslProperties = new SslPropertiesProperty {
DisableSsl = false
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
}
});Name
A display name for the data source.
public virtual string Name { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
Permissions
A list of resource permissions on the data source.
public virtual object? Permissions { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
SslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
public virtual object? SslProperties { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
TagsRaw
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
public virtual ICfnTag[]? TagsRaw { get; set; }Property Value
ICfnTag[]
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
Type
The type of the data source.
public virtual string Type { get; set; }Property Value
Remarks
To return a list of all data sources, use ListDataSources .
VpcConnectionProperties
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
public virtual object? VpcConnectionProperties { get; set; }Property Value
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Creates a data source.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::QuickSight::DataSource
ExampleMetadata: fixture=_generated