Skip to content

CreateDataSourceRequest

Source code in docs_src/capo_quicksight/types/create_data_source_request.py
class CreateDataSourceRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId"
    """<p>The Amazon Web Services account ID.</p>"""
    data_source_id: "capo_quicksight.types.resource_id.ResourceId"
    """<p>An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>"""
    name: "capo_quicksight.types.resource_name.ResourceName"
    """<p>A display name for the data source.</p>"""
    type: "capo_quicksight.types.data_source_type.DataSourceType"
    """<p>The type of the data source. To return a list of all data sources, use <code>ListDataSources</code>.</p> <p>Use <code>AMAZON_ELASTICSEARCH</code> for Amazon OpenSearch Service.</p>"""
    data_source_parameters: NotRequired[
        "capo_quicksight.types.data_source_parameters.DataSourceParameters"
    ]
    """<p>The parameters that Amazon Quick Sight uses to connect to your underlying source.</p>"""
    credentials: NotRequired[
        "capo_quicksight.types.data_source_credentials.DataSourceCredentials"
    ]
    """<p>The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.</p>"""
    permissions: NotRequired[
        "capo_quicksight.types.resource_permission_list.ResourcePermissionList"
    ]
    """<p>A list of resource permissions on the data source.</p>"""
    vpc_connection_properties: NotRequired[
        "capo_quicksight.types.vpc_connection_properties.VpcConnectionProperties"
    ]
    """<p>Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.</p>"""
    ssl_properties: NotRequired["capo_quicksight.types.ssl_properties.SslProperties"]
    """<p>Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.</p>"""
    tags: NotRequired["capo_quicksight.types.tag_list.TagList"]
    """<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</p>"""
    folder_arns: NotRequired["capo_quicksight.types.folder_arn_list.FolderArnList"]
    """<p>When you create the data source, Amazon Quick Sight adds the data source to these folders.</p>"""

aws_account_id instance-attribute

aws_account_id: AwsAccountId

The Amazon Web Services account ID.

credentials instance-attribute

credentials: NotRequired[DataSourceCredentials]

The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

data_source_id instance-attribute

data_source_id: ResourceId

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

data_source_parameters instance-attribute

data_source_parameters: NotRequired[DataSourceParameters]

The parameters that Amazon Quick Sight uses to connect to your underlying source.

folder_arns instance-attribute

folder_arns: NotRequired[FolderArnList]

When you create the data source, Amazon Quick Sight adds the data source to these folders.

name instance-attribute

A display name for the data source.

permissions instance-attribute

permissions: NotRequired[ResourcePermissionList]

A list of resource permissions on the data source.

ssl_properties instance-attribute

ssl_properties: NotRequired[SslProperties]

Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

tags instance-attribute

tags: NotRequired[TagList]

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

type instance-attribute

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

vpc_connection_properties instance-attribute

vpc_connection_properties: NotRequired[VpcConnectionProperties]

Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.