CfnDataSourceProps (software.amazon.awscdk:quicksight 1.182.0 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:37.755Z")
 @Stability(value=Stable)
public interface CfnDataSourceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDataSource`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CfnDataSourceProps cfnDataSourceProps = CfnDataSourceProps.builder()
         .alternateDataSourceParameters(List.of(DataSourceParametersProperty.builder()
                 .amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
                         .domain("domain")
                         .build())
                 .amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
                         .domain("domain")
                         .build())
                 .athenaParameters(AthenaParametersProperty.builder()
                         .workGroup("workGroup")
                         .build())
                 .auroraParameters(AuroraParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .mariaDbParameters(MariaDbParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .mySqlParameters(MySqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .oracleParameters(OracleParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .postgreSqlParameters(PostgreSqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .prestoParameters(PrestoParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         .build())
                 .rdsParameters(RdsParametersProperty.builder()
                         .database("database")
                         .instanceId("instanceId")
                         .build())
                 .redshiftParameters(RedshiftParametersProperty.builder()
                         .database("database")
                         // the properties below are optional
                         .clusterId("clusterId")
                         .host("host")
                         .port(123)
                         .build())
                 .s3Parameters(S3ParametersProperty.builder()
                         .manifestFileLocation(ManifestFileLocationProperty.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .build())
                         .build())
                 .snowflakeParameters(SnowflakeParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .warehouse("warehouse")
                         .build())
                 .sparkParameters(SparkParametersProperty.builder()
                         .host("host")
                         .port(123)
                         .build())
                 .sqlServerParameters(SqlServerParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .teradataParameters(TeradataParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .build()))
         .awsAccountId("awsAccountId")
         .credentials(DataSourceCredentialsProperty.builder()
                 .copySourceArn("copySourceArn")
                 .credentialPair(CredentialPairProperty.builder()
                         .password("password")
                         .username("username")
                         // the properties below are optional
                         .alternateDataSourceParameters(List.of(DataSourceParametersProperty.builder()
                                 .amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
                                         .domain("domain")
                                         .build())
                                 .amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
                                         .domain("domain")
                                         .build())
                                 .athenaParameters(AthenaParametersProperty.builder()
                                         .workGroup("workGroup")
                                         .build())
                                 .auroraParameters(AuroraParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .mariaDbParameters(MariaDbParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .mySqlParameters(MySqlParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .oracleParameters(OracleParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .postgreSqlParameters(PostgreSqlParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .prestoParameters(PrestoParametersProperty.builder()
                                         .catalog("catalog")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .rdsParameters(RdsParametersProperty.builder()
                                         .database("database")
                                         .instanceId("instanceId")
                                         .build())
                                 .redshiftParameters(RedshiftParametersProperty.builder()
                                         .database("database")
                                         // the properties below are optional
                                         .clusterId("clusterId")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .s3Parameters(S3ParametersProperty.builder()
                                         .manifestFileLocation(ManifestFileLocationProperty.builder()
                                                 .bucket("bucket")
                                                 .key("key")
                                                 .build())
                                         .build())
                                 .snowflakeParameters(SnowflakeParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .warehouse("warehouse")
                                         .build())
                                 .sparkParameters(SparkParametersProperty.builder()
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .sqlServerParameters(SqlServerParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .teradataParameters(TeradataParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .build()))
                         .build())
                 .secretArn("secretArn")
                 .build())
         .dataSourceId("dataSourceId")
         .dataSourceParameters(DataSourceParametersProperty.builder()
                 .amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
                         .domain("domain")
                         .build())
                 .amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
                         .domain("domain")
                         .build())
                 .athenaParameters(AthenaParametersProperty.builder()
                         .workGroup("workGroup")
                         .build())
                 .auroraParameters(AuroraParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .mariaDbParameters(MariaDbParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .mySqlParameters(MySqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .oracleParameters(OracleParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .postgreSqlParameters(PostgreSqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .prestoParameters(PrestoParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         .build())
                 .rdsParameters(RdsParametersProperty.builder()
                         .database("database")
                         .instanceId("instanceId")
                         .build())
                 .redshiftParameters(RedshiftParametersProperty.builder()
                         .database("database")
                         // the properties below are optional
                         .clusterId("clusterId")
                         .host("host")
                         .port(123)
                         .build())
                 .s3Parameters(S3ParametersProperty.builder()
                         .manifestFileLocation(ManifestFileLocationProperty.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .build())
                         .build())
                 .snowflakeParameters(SnowflakeParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .warehouse("warehouse")
                         .build())
                 .sparkParameters(SparkParametersProperty.builder()
                         .host("host")
                         .port(123)
                         .build())
                 .sqlServerParameters(SqlServerParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .teradataParameters(TeradataParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .build())
         .errorInfo(DataSourceErrorInfoProperty.builder()
                 .message("message")
                 .type("type")
                 .build())
         .name("name")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .sslProperties(SslPropertiesProperty.builder()
                 .disableSsl(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .vpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                 .vpcConnectionArn("vpcConnectionArn")
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnDataSourceProps.Builder` A builder for `CfnDataSourceProps`
`static class`	`CfnDataSourceProps.Jsii$Proxy` An implementation for `CfnDataSourceProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnDataSourceProps.Builder`	`builder()`
`default Object`	`getAlternateDataSourceParameters()` A set of alternate data source parameters that you want to share for the credentials stored with this data source.
`default String`	`getAwsAccountId()` The AWS account ID.
`default Object`	`getCredentials()` The credentials Amazon QuickSight that uses to connect to your underlying source.
`default String`	`getDataSourceId()` An ID for the data source.
`default Object`	`getDataSourceParameters()` The parameters that Amazon QuickSight uses to connect to your underlying source.
`default Object`	`getErrorInfo()` Error information from the last update or the creation of the data source.
`default String`	`getName()` A display name for the data source.
`default Object`	`getPermissions()` A list of resource permissions on the data source.
`default Object`	`getSslProperties()` Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
`default List<CfnTag>`	`getTags()` Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
`default String`	`getType()` The type of the data source.
`default Object`	`getVpcConnectionProperties()` Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getAlternateDataSourceParameters
```
@Stability(value=Stable)
 @Nullable
default Object getAlternateDataSourceParameters()
```
    A set of alternate data source parameters that you want to share for the credentials stored with this data source.
    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 credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
  - getAwsAccountId
```
@Stability(value=Stable)
 @Nullable
default String getAwsAccountId()
```
    The AWS account ID.
  - getCredentials
```
@Stability(value=Stable)
 @Nullable
default Object getCredentials()
```
    The credentials Amazon QuickSight that uses to connect to your underlying source.
    Currently, only credentials based on user name and password are supported.
  - getDataSourceId
```
@Stability(value=Stable)
 @Nullable
default String getDataSourceId()
```
    An ID for the data source.
    This ID is unique per AWS Region for each AWS account.
  - getDataSourceParameters
```
@Stability(value=Stable)
 @Nullable
default Object getDataSourceParameters()
```
    The parameters that Amazon QuickSight uses to connect to your underlying source.
  - getErrorInfo
```
@Stability(value=Stable)
 @Nullable
default Object getErrorInfo()
```
    Error information from the last update or the creation of the data source.
  - getName
```
@Stability(value=Stable)
 @Nullable
default String getName()
```
    A display name for the data source.
  - getPermissions
```
@Stability(value=Stable)
 @Nullable
default Object getPermissions()
```
    A list of resource permissions on the data source.
  - getSslProperties
```
@Stability(value=Stable)
 @Nullable
default Object getSslProperties()
```
    Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
  - getType
```
@Stability(value=Stable)
 @Nullable
default String getType()
```
    The type of the data source. To return a list of all data sources, use `ListDataSources` .
    Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
  - getVpcConnectionProperties
```
@Stability(value=Stable)
 @Nullable
default Object getVpcConnectionProperties()
```
    Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
  - builder
```
@Stability(value=Stable)
static CfnDataSourceProps.Builder builder()
```
    Returns:
    
    a CfnDataSourceProps.Builder of CfnDataSourceProps

Interface CfnDataSourceProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getAlternateDataSourceParameters

getAwsAccountId

getCredentials

getDataSourceId

getDataSourceParameters

getErrorInfo

getName

getPermissions

getSslProperties

getTags

getType

getVpcConnectionProperties

builder