CfnDataSourceProps

class aws_cdk.aws_datazone.CfnDataSourceProps(*, domain_identifier, environment_identifier, name, project_identifier, type, asset_forms_input=None, configuration=None, description=None, enable_setting=None, publish_on_import=None, recommendation=None, schedule=None)

Bases: object

Properties for defining a CfnDataSource.

Parameters:

domain_identifier (str) – The ID of the Amazon DataZone domain where the data source is created.
environment_identifier (str) – The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
name (str) – The name of the data source.
project_identifier (str) – The identifier of the Amazon DataZone project in which you want to add this data source.
type (str) – The type of the data source.
asset_forms_input (Union[IResolvable, Sequence[Union[IResolvable, FormInputProperty, Dict[str, Any]]], None]) – The metadata forms attached to the assets that the data source works with.
configuration (Union[IResolvable, DataSourceConfigurationInputProperty, Dict[str, Any], None]) – The configuration of the data source.
description (Optional[str]) – The description of the data source.
enable_setting (Optional[str]) – Specifies whether the data source is enabled.
publish_on_import (Union[bool, IResolvable, None]) – Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
recommendation (Union[IResolvable, RecommendationConfigurationProperty, Dict[str, Any], None]) – Specifies whether the business name generation is to be enabled for this data source.
schedule (Union[IResolvable, ScheduleConfigurationProperty, Dict[str, Any], None]) – The schedule of the data source runs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

cfn_data_source_props = datazone.CfnDataSourceProps(
    domain_identifier="domainIdentifier",
    environment_identifier="environmentIdentifier",
    name="name",
    project_identifier="projectIdentifier",
    type="type",

    # the properties below are optional
    asset_forms_input=[datazone.CfnDataSource.FormInputProperty(
        form_name="formName",

        # the properties below are optional
        content="content",
        type_identifier="typeIdentifier",
        type_revision="typeRevision"
    )],
    configuration=datazone.CfnDataSource.DataSourceConfigurationInputProperty(
        glue_run_configuration=datazone.CfnDataSource.GlueRunConfigurationInputProperty(
            relational_filter_configurations=[datazone.CfnDataSource.RelationalFilterConfigurationProperty(
                database_name="databaseName",

                # the properties below are optional
                filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
                    expression="expression",
                    type="type"
                )],
                schema_name="schemaName"
            )],

            # the properties below are optional
            auto_import_data_quality_result=False,
            data_access_role="dataAccessRole"
        ),
        redshift_run_configuration=datazone.CfnDataSource.RedshiftRunConfigurationInputProperty(
            redshift_credential_configuration=datazone.CfnDataSource.RedshiftCredentialConfigurationProperty(
                secret_manager_arn="secretManagerArn"
            ),
            redshift_storage=datazone.CfnDataSource.RedshiftStorageProperty(
                redshift_cluster_source=datazone.CfnDataSource.RedshiftClusterStorageProperty(
                    cluster_name="clusterName"
                ),
                redshift_serverless_source=datazone.CfnDataSource.RedshiftServerlessStorageProperty(
                    workgroup_name="workgroupName"
                )
            ),
            relational_filter_configurations=[datazone.CfnDataSource.RelationalFilterConfigurationProperty(
                database_name="databaseName",

                # the properties below are optional
                filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
                    expression="expression",
                    type="type"
                )],
                schema_name="schemaName"
            )],

            # the properties below are optional
            data_access_role="dataAccessRole"
        )
    ),
    description="description",
    enable_setting="enableSetting",
    publish_on_import=False,
    recommendation=datazone.CfnDataSource.RecommendationConfigurationProperty(
        enable_business_name_generation=False
    ),
    schedule=datazone.CfnDataSource.ScheduleConfigurationProperty(
        schedule="schedule",
        timezone="timezone"
    )
)