Skip to content

CreateDataSourceInput

Source code in docs_src/capo_datazone/types/create_data_source_input.py
class CreateDataSourceInput(TypedDict, closed=True):
    name: "capo_datazone.types.name.Name"
    """<p>The name of the data source.</p>"""
    description: NotRequired["capo_datazone.types.description.Description"]
    """<p>The description of the data source.</p>"""
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The ID of the Amazon DataZone domain where the data source is created.</p>"""
    project_identifier: "str"
    """<p>The identifier of the Amazon DataZone project in which you want to add this data source.</p>"""
    environment_identifier: NotRequired["str"]
    """<p>The unique identifier of the Amazon DataZone environment to which the data source publishes assets. </p>"""
    connection_identifier: NotRequired["str"]
    """<p>The ID of the connection.</p>"""
    type: "capo_datazone.types.data_source_type.DataSourceType"
    """<p>The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for Amazon Web Services Glue and Amazon Redshift.</p>"""
    configuration: NotRequired[
        "capo_datazone.types.data_source_configuration_input.DataSourceConfigurationInput"
    ]
    """<p>Specifies the configuration of the data source. It can be set to either <code>glueRunConfiguration</code> or <code>redshiftRunConfiguration</code>.</p>"""
    recommendation: NotRequired[
        "capo_datazone.types.recommendation_configuration.RecommendationConfiguration"
    ]
    """<p>Specifies whether the business name generation is to be enabled for this data source.</p>"""
    enable_setting: NotRequired["capo_datazone.types.enable_setting.EnableSetting"]
    """<p>Specifies whether the data source is enabled.</p>"""
    schedule: NotRequired[
        "capo_datazone.types.schedule_configuration.ScheduleConfiguration"
    ]
    """<p>The schedule of the data source runs.</p>"""
    publish_on_import: NotRequired["bool"]
    """<p>Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.</p>"""
    asset_forms_input: NotRequired["capo_datazone.types.form_input_list.FormInputList"]
    """<p>The metadata forms that are to be attached to the assets that this data source works with.</p>"""
    client_token: NotRequired["str"]
    """<p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>"""

asset_forms_input instance-attribute

asset_forms_input: NotRequired[FormInputList]

The metadata forms that are to be attached to the assets that this data source works with.

client_token instance-attribute

client_token: NotRequired[str]

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

configuration instance-attribute

configuration: NotRequired[DataSourceConfigurationInput]

Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

connection_identifier instance-attribute

connection_identifier: NotRequired[str]

The ID of the connection.

description instance-attribute

description: NotRequired[Description]

The description of the data source.

domain_identifier instance-attribute

domain_identifier: DomainId

The ID of the Amazon DataZone domain where the data source is created.

enable_setting instance-attribute

enable_setting: NotRequired[EnableSetting]

Specifies whether the data source is enabled.

environment_identifier instance-attribute

environment_identifier: NotRequired[str]

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

name instance-attribute

name: Name

The name of the data source.

project_identifier instance-attribute

project_identifier: str

The identifier of the Amazon DataZone project in which you want to add this data source.

publish_on_import instance-attribute

publish_on_import: NotRequired[bool]

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

recommendation instance-attribute

recommendation: NotRequired[RecommendationConfiguration]

Specifies whether the business name generation is to be enabled for this data source.

schedule instance-attribute

schedule: NotRequired[ScheduleConfiguration]

The schedule of the data source runs.

type instance-attribute

The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for Amazon Web Services Glue and Amazon Redshift.