DataSource ¶

class DataSource(TypedDict, closed=True):
    arn: NotRequired["capo_quicksight.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the data source.</p>"""
    data_source_id: NotRequired["capo_quicksight.types.resource_id.ResourceId"]
    """<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"""
    name: NotRequired["capo_quicksight.types.resource_name.ResourceName"]
    """<p>A display name for the data source.</p>"""
    type: NotRequired["capo_quicksight.types.data_source_type.DataSourceType"]
    """<p>The type of the data source. This type indicates which database engine the data source connects to.</p>"""
    status: NotRequired["capo_quicksight.types.resource_status.ResourceStatus"]
    """<p>The HTTP status of the request.</p>"""
    created_time: NotRequired["capo_quicksight.types.timestamp.Timestamp"]
    """<p>The time that this data source was created.</p>"""
    last_updated_time: NotRequired["capo_quicksight.types.timestamp.Timestamp"]
    """<p>The last time that this data source was updated.</p>"""
    data_source_parameters: NotRequired[
        "capo_quicksight.types.data_source_parameters.DataSourceParameters"
    ]
    """<p>The parameters that Quick Sight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"""
    alternate_data_source_parameters: NotRequired[
        "capo_quicksight.types.data_source_parameters_list.DataSourceParametersList"
    ]
    """<p>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 <code>DataSourceParameters</code> structure that's in the request with the structures in the <code>AlternateDataSourceParameters</code> allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the <code>AlternateDataSourceParameters</code> list is null, the <code>Credentials</code> originally used with this <code>DataSourceParameters</code> are automatically allowed.</p>"""
    vpc_connection_properties: NotRequired[
        "capo_quicksight.types.vpc_connection_properties.VpcConnectionProperties"
    ]
    """<p>The VPC connection information. You need to use this parameter only when you want 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 Quick Sight connects to your underlying source.</p>"""
    error_info: NotRequired[
        "capo_quicksight.types.data_source_error_info.DataSourceErrorInfo"
    ]
    """<p>Error information from the last update or the creation of the data source.</p>"""
    secret_arn: NotRequired["capo_quicksight.types.secret_arn.SecretArn"]
    """<p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p>"""
    credential_status: NotRequired[
        "capo_quicksight.types.credential_status.CredentialStatus"
    ]
    """<p>The credential verification status of the data source. Valid values include:</p> <ul> <li> <p> <code>CONNECTED</code> – Credential validation succeeded.</p> </li> <li> <p> <code>AUTH_FAILED</code> – Credential validation failed.</p> </li> <li> <p> <code>NOT_VERIFIED</code> – Credential validation has not been performed.</p> </li> </ul>"""
    last_credential_verified_at: NotRequired[
        "capo_quicksight.types.timestamp.Timestamp"
    ]
    """<p>The time that the credentials were last verified.</p>"""