AWS Native v0.102.0, Apr 16 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.quicksight.DataSource

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

Create DataSource Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DataSource(name: string, args?: DataSourceArgs, opts?: CustomResourceOptions);

@overload
def DataSource(resource_name: str,
               args: Optional[DataSourceArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def DataSource(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               alternate_data_source_parameters: Optional[Sequence[DataSourceParametersArgs]] = None,
               aws_account_id: Optional[str] = None,
               credentials: Optional[DataSourceCredentialsArgs] = None,
               data_source_id: Optional[str] = None,
               data_source_parameters: Optional[DataSourceParametersArgs] = None,
               error_info: Optional[DataSourceErrorInfoArgs] = None,
               name: Optional[str] = None,
               permissions: Optional[Sequence[DataSourceResourcePermissionArgs]] = None,
               ssl_properties: Optional[DataSourceSslPropertiesArgs] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
               type: Optional[DataSourceType] = None,
               vpc_connection_properties: Optional[DataSourceVpcConnectionPropertiesArgs] = None)

func NewDataSource(ctx *Context, name string, args *DataSourceArgs, opts ...ResourceOption) (*DataSource, error)

public DataSource(string name, DataSourceArgs? args = null, CustomResourceOptions? opts = null)

public DataSource(String name, DataSourceArgs args)
public DataSource(String name, DataSourceArgs args, CustomResourceOptions options)

type: aws-native:quicksight:DataSource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DataSourceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DataSourceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DataSourceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DataSourceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DataSourceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const exampledataSourceResourceResourceFromQuicksight = new aws_native.quicksight.DataSource("exampledataSourceResourceResourceFromQuicksight", {
    alternateDataSourceParameters: [{
        amazonElasticsearchParameters: {
            domain: "string",
        },
        amazonOpenSearchParameters: {
            domain: "string",
        },
        athenaParameters: {
            roleArn: "string",
            workGroup: "string",
        },
        auroraParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        auroraPostgreSqlParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        databricksParameters: {
            host: "string",
            port: 0,
            sqlEndpointPath: "string",
        },
        mariaDbParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        mySqlParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        oracleParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        postgreSqlParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        prestoParameters: {
            catalog: "string",
            host: "string",
            port: 0,
        },
        rdsParameters: {
            database: "string",
            instanceId: "string",
        },
        redshiftParameters: {
            database: "string",
            clusterId: "string",
            host: "string",
            port: 0,
        },
        s3Parameters: {
            manifestFileLocation: {
                bucket: "string",
                key: "string",
            },
            roleArn: "string",
        },
        snowflakeParameters: {
            database: "string",
            host: "string",
            warehouse: "string",
        },
        sparkParameters: {
            host: "string",
            port: 0,
        },
        sqlServerParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        starburstParameters: {
            catalog: "string",
            host: "string",
            port: 0,
            productType: aws_native.quicksight.DataSourceStarburstProductType.Galaxy,
        },
        teradataParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        trinoParameters: {
            catalog: "string",
            host: "string",
            port: 0,
        },
    }],
    awsAccountId: "string",
    credentials: {
        copySourceArn: "string",
        credentialPair: {
            password: "string",
            username: "string",
            alternateDataSourceParameters: [{
                amazonElasticsearchParameters: {
                    domain: "string",
                },
                amazonOpenSearchParameters: {
                    domain: "string",
                },
                athenaParameters: {
                    roleArn: "string",
                    workGroup: "string",
                },
                auroraParameters: {
                    database: "string",
                    host: "string",
                    port: 0,
                },
                auroraPostgreSqlParameters: {
                    database: "string",
                    host: "string",
                    port: 0,
                },
                databricksParameters: {
                    host: "string",
                    port: 0,
                    sqlEndpointPath: "string",
                },
                mariaDbParameters: {
                    database: "string",
                    host: "string",
                    port: 0,
                },
                mySqlParameters: {
                    database: "string",
                    host: "string",
                    port: 0,
                },
                oracleParameters: {
                    database: "string",
                    host: "string",
                    port: 0,
                },
                postgreSqlParameters: {
                    database: "string",
                    host: "string",
                    port: 0,
                },
                prestoParameters: {
                    catalog: "string",
                    host: "string",
                    port: 0,
                },
                rdsParameters: {
                    database: "string",
                    instanceId: "string",
                },
                redshiftParameters: {
                    database: "string",
                    clusterId: "string",
                    host: "string",
                    port: 0,
                },
                s3Parameters: {
                    manifestFileLocation: {
                        bucket: "string",
                        key: "string",
                    },
                    roleArn: "string",
                },
                snowflakeParameters: {
                    database: "string",
                    host: "string",
                    warehouse: "string",
                },
                sparkParameters: {
                    host: "string",
                    port: 0,
                },
                sqlServerParameters: {
                    database: "string",
                    host: "string",
                    port: 0,
                },
                starburstParameters: {
                    catalog: "string",
                    host: "string",
                    port: 0,
                    productType: aws_native.quicksight.DataSourceStarburstProductType.Galaxy,
                },
                teradataParameters: {
                    database: "string",
                    host: "string",
                    port: 0,
                },
                trinoParameters: {
                    catalog: "string",
                    host: "string",
                    port: 0,
                },
            }],
        },
        secretArn: "string",
    },
    dataSourceId: "string",
    dataSourceParameters: {
        amazonElasticsearchParameters: {
            domain: "string",
        },
        amazonOpenSearchParameters: {
            domain: "string",
        },
        athenaParameters: {
            roleArn: "string",
            workGroup: "string",
        },
        auroraParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        auroraPostgreSqlParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        databricksParameters: {
            host: "string",
            port: 0,
            sqlEndpointPath: "string",
        },
        mariaDbParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        mySqlParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        oracleParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        postgreSqlParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        prestoParameters: {
            catalog: "string",
            host: "string",
            port: 0,
        },
        rdsParameters: {
            database: "string",
            instanceId: "string",
        },
        redshiftParameters: {
            database: "string",
            clusterId: "string",
            host: "string",
            port: 0,
        },
        s3Parameters: {
            manifestFileLocation: {
                bucket: "string",
                key: "string",
            },
            roleArn: "string",
        },
        snowflakeParameters: {
            database: "string",
            host: "string",
            warehouse: "string",
        },
        sparkParameters: {
            host: "string",
            port: 0,
        },
        sqlServerParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        starburstParameters: {
            catalog: "string",
            host: "string",
            port: 0,
            productType: aws_native.quicksight.DataSourceStarburstProductType.Galaxy,
        },
        teradataParameters: {
            database: "string",
            host: "string",
            port: 0,
        },
        trinoParameters: {
            catalog: "string",
            host: "string",
            port: 0,
        },
    },
    errorInfo: {
        message: "string",
        type: aws_native.quicksight.DataSourceErrorInfoType.AccessDenied,
    },
    name: "string",
    permissions: [{
        actions: ["string"],
        principal: "string",
    }],
    sslProperties: {
        disableSsl: false,
    },
    tags: [{
        key: "string",
        value: "string",
    }],
    type: aws_native.quicksight.DataSourceType.AdobeAnalytics,
    vpcConnectionProperties: {
        vpcConnectionArn: "string",
    },
});

Coming soon!

DataSource Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DataSource resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the DataSource resource produces the following output properties:

Arn string
CreatedTime string
Id string: The provider-assigned unique ID for this managed resource.
LastUpdatedTime string
Status Pulumi.AwsNative.QuickSight.DataSourceResourceStatus

Arn string
CreatedTime string
Id string: The provider-assigned unique ID for this managed resource.
LastUpdatedTime string
Status DataSourceResourceStatus

arn String
createdTime String
id String: The provider-assigned unique ID for this managed resource.
lastUpdatedTime String
status DataSourceResourceStatus

arn string
createdTime string
id string: The provider-assigned unique ID for this managed resource.
lastUpdatedTime string
status DataSourceResourceStatus

arn str
created_time str
id str: The provider-assigned unique ID for this managed resource.
last_updated_time str
status DataSourceResourceStatus

arn String
createdTime String
id String: The provider-assigned unique ID for this managed resource.
lastUpdatedTime String
status "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED"

Supporting Types

DataSourceAmazonElasticsearchParameters, DataSourceAmazonElasticsearchParametersArgs

Domain string

Domain string

domain String

domain string

domain str

domain String

DataSourceAmazonOpenSearchParameters, DataSourceAmazonOpenSearchParametersArgs

Domain string

Domain string

domain String

domain string

domain str

domain String

DataSourceAthenaParameters, DataSourceAthenaParametersArgs

RoleArn string
WorkGroup string

RoleArn string
WorkGroup string

roleArn String
workGroup String

roleArn string
workGroup string

role_arn str
work_group str

roleArn String
workGroup String

DataSourceAuroraParameters, DataSourceAuroraParametersArgs

Database string
Host string
Port double

Database string
Host string
Port float64

database String
host String
port Double

database string
host string
port number

database str
host str
port float

database String
host String
port Number

DataSourceAuroraPostgreSqlParameters, DataSourceAuroraPostgreSqlParametersArgs

Database string
Host string
Port double

Database string
Host string
Port float64

database String
host String
port Double

database string
host string
port number

database str
host str
port float

database String
host String
port Number

Host string
Port float64
SqlEndpointPath string

host String
port Double
sqlEndpointPath String

host string
port number
sqlEndpointPath string

host str
port float
sql_endpoint_path str

host String
port Number
sqlEndpointPath String

DataSourceErrorInfo, DataSourceErrorInfoArgs

Message string
Type Pulumi.AwsNative.QuickSight.DataSourceErrorInfoType

Message string
Type DataSourceErrorInfoType

message String
type DataSourceErrorInfoType

message string
type DataSourceErrorInfoType

message str
type DataSourceErrorInfoType

message String
type "ACCESS_DENIED" | "COPY_SOURCE_NOT_FOUND" | "TIMEOUT" | "ENGINE_VERSION_NOT_SUPPORTED" | "UNKNOWN_HOST" | "GENERIC_SQL_FAILURE" | "CONFLICT" | "UNKNOWN"

DataSourceErrorInfoType, DataSourceErrorInfoTypeArgs

AccessDenied: ACCESS_DENIED
CopySourceNotFound: COPY_SOURCE_NOT_FOUND
Timeout: TIMEOUT
EngineVersionNotSupported: ENGINE_VERSION_NOT_SUPPORTED
UnknownHost: UNKNOWN_HOST
GenericSqlFailure: GENERIC_SQL_FAILURE
Conflict: CONFLICT
Unknown: UNKNOWN

DataSourceErrorInfoTypeAccessDenied: ACCESS_DENIED
DataSourceErrorInfoTypeCopySourceNotFound: COPY_SOURCE_NOT_FOUND
DataSourceErrorInfoTypeTimeout: TIMEOUT
DataSourceErrorInfoTypeEngineVersionNotSupported: ENGINE_VERSION_NOT_SUPPORTED
DataSourceErrorInfoTypeUnknownHost: UNKNOWN_HOST
DataSourceErrorInfoTypeGenericSqlFailure: GENERIC_SQL_FAILURE
DataSourceErrorInfoTypeConflict: CONFLICT
DataSourceErrorInfoTypeUnknown: UNKNOWN

AccessDenied: ACCESS_DENIED
CopySourceNotFound: COPY_SOURCE_NOT_FOUND
Timeout: TIMEOUT
EngineVersionNotSupported: ENGINE_VERSION_NOT_SUPPORTED
UnknownHost: UNKNOWN_HOST
GenericSqlFailure: GENERIC_SQL_FAILURE
Conflict: CONFLICT
Unknown: UNKNOWN