Class CfnDataSourcePropsMixin.DataSourceCredentialsProperty

Data source credentials.

Inheritance

object

CfnDataSourcePropsMixin.DataSourceCredentialsProperty

Implements

CfnDataSourcePropsMixin.IDataSourceCredentialsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QuickSight

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.DataSourceCredentialsProperty : CfnDataSourcePropsMixin.IDataSourceCredentialsProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.DataSourceCredentialsProperty Implements CfnDataSourcePropsMixin.IDataSourceCredentialsProperty

Remarks

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html

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 dataSourceCredentialsProperty = new DataSourceCredentialsProperty {
                 CopySourceArn = "copySourceArn",
                 CredentialPair = 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"
                 },
                 KeyPairCredentials = new KeyPairCredentialsProperty {
                     KeyPairUsername = "keyPairUsername",
                     PrivateKey = "privateKey",
                     PrivateKeyPassphrase = "privateKeyPassphrase"
                 },
                 SecretArn = "secretArn"
             };

Synopsis

Constructors

DataSourceCredentialsProperty()

Data source credentials.

Properties

CopySourceArn	The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.
CredentialPair	Credential pair.
KeyPairCredentials	The credentials for connecting using key-pair.
SecretArn	The Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager .

Constructors

DataSourceCredentialsProperty()

Data source credentials.

public DataSourceCredentialsProperty()

Remarks

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html

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 dataSourceCredentialsProperty = new DataSourceCredentialsProperty {
                 CopySourceArn = "copySourceArn",
                 CredentialPair = 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"
                 },
                 KeyPairCredentials = new KeyPairCredentialsProperty {
                     KeyPairUsername = "keyPairUsername",
                     PrivateKey = "privateKey",
                     PrivateKeyPassphrase = "privateKeyPassphrase"
                 },
                 SecretArn = "secretArn"
             };

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

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-copysourcearn

CredentialPair

Credential pair.

public object? CredentialPair { get; set; }

Property Value

object

Remarks

For more information, see CredentialPair .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-credentialpair

Type union: either IResolvable or CfnDataSourcePropsMixin.ICredentialPairProperty

KeyPairCredentials

The credentials for connecting using key-pair.

public object? KeyPairCredentials { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-keypaircredentials

Type union: either IResolvable or CfnDataSourcePropsMixin.IKeyPairCredentialsProperty

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-secretarn

Implements

CfnDataSourcePropsMixin.IDataSourceCredentialsProperty