Interface CfnDataSource.ICredentialPairProperty
The combination of user name and password that are used as credentials.
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICredentialPairProperty
Syntax (vb)
Public Interface ICredentialPairProperty
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 credentialPairProperty = 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
}
} }
};
Synopsis
Properties
AlternateDataSourceParameters | A set of alternate data source parameters that you want to share for these credentials. |
Password | Password. |
Username | User name. |
Properties
AlternateDataSourceParameters
A set of alternate data source parameters that you want to share for these credentials.
virtual object AlternateDataSourceParameters { get; }
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 new data source with the existing credentials. If the AlternateDataSourceParameters
list is null, the DataSourceParameters
originally used with these Credentials
is automatically allowed.
Password
Password.
string Password { get; }
Property Value
System.String
Remarks
Username
User name.
string Username { get; }
Property Value
System.String