Interface CfnDataSourcePropsMixin.ICredentialPairProperty
The combination of user name and password that are used as credentials.
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QuickSight
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public interface CfnDataSourcePropsMixin.ICredentialPairPropertySyntax (vb)
Public Interface CfnDataSourcePropsMixin.ICredentialPairPropertyRemarks
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.CfnPropertyMixins.AWS.QuickSight;
var credentialPairProperty = new CredentialPairProperty {
AlternateDataSourceParameters = new [] { new DataSourceParametersProperty {
AmazonElasticsearchParameters = new AmazonElasticsearchParametersProperty {
Domain = "domain"
},
AmazonOpenSearchParameters = new AmazonOpenSearchParametersProperty {
Domain = "domain"
},
AthenaParameters = new AthenaParametersProperty {
IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
EnableIdentityPropagation = false
},
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,
UseServiceName = false
},
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 {
ClusterId = "clusterId",
Database = "database",
Host = "host",
IamParameters = new RedshiftIAMParametersProperty {
AutoCreateDatabaseUser = false,
DatabaseGroups = new [] { "databaseGroups" },
DatabaseUser = "databaseUser",
RoleArn = "roleArn"
},
IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
EnableIdentityPropagation = false
},
Port = 123
},
S3Parameters = new S3ParametersProperty {
ManifestFileLocation = new ManifestFileLocationProperty {
Bucket = "bucket",
Key = "key"
},
RoleArn = "roleArn"
},
SnowflakeParameters = new SnowflakeParametersProperty {
AuthenticationType = "authenticationType",
Database = "database",
DatabaseAccessControlRole = "databaseAccessControlRole",
Host = "host",
OAuthParameters = new OAuthParametersProperty {
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope",
TokenProviderUrl = "tokenProviderUrl"
},
Warehouse = "warehouse"
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
StarburstParameters = new StarburstParametersProperty {
AuthenticationType = "authenticationType",
Catalog = "catalog",
DatabaseAccessControlRole = "databaseAccessControlRole",
Host = "host",
OAuthParameters = new OAuthParametersProperty {
IdentityProviderResourceUri = "identityProviderResourceUri",
IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
VpcConnectionArn = "vpcConnectionArn"
},
OAuthScope = "oAuthScope",
TokenProviderUrl = "tokenProviderUrl"
},
Port = 123,
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
}
} },
Password = "password",
Username = "username"
};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.
object? AlternateDataSourceParameters { get; }Property Value
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.
Type union: either IResolvable or (either IResolvable or CfnDataSourcePropsMixin.IDataSourceParametersProperty)[]
Password
Password.
string? Password { get; }Property Value
Remarks
Username
User name.
string? Username { get; }