Class CfnDataSource.DataSourceCredentialsProperty
Data source credentials.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DataSourceCredentialsProperty : Object, CfnDataSource.IDataSourceCredentialsProperty
Syntax (vb)
Public Class DataSourceCredentialsProperty
Inherits Object
Implements CfnDataSource.IDataSourceCredentialsProperty
Remarks
This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
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 dataSourceCredentialsProperty = 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
},
StarburstParameters = new StarburstParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123,
// the properties below are optional
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
}
} }
},
SecretArn = "secretArn"
};
Synopsis
Constructors
DataSourceCredentialsProperty() |
Properties
CopySourceArn | The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. |
CredentialPair | Credential pair. |
SecretArn | The Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager . |
Constructors
DataSourceCredentialsProperty()
public DataSourceCredentialsProperty()
Properties
CopySourceArn
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.
public string CopySourceArn { get; set; }
Property Value
System.String
Remarks
When CopySourceArn
is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials
structure.
CredentialPair
Credential pair.
public object CredentialPair { get; set; }
Property Value
System.Object
Remarks
SecretArn
The Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager .
public string SecretArn { get; set; }
Property Value
System.String