CfnDataSourcePropsMixin
- class aws_cdk.mixins_preview.aws_datazone.mixins.CfnDataSourcePropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::DataZone::DataSourceresource specifies an Amazon DataZone data source that is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html
- CloudformationResource:
AWS::DataZone::DataSource
- Mixin:
true
- 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.mixins_preview import mixins from aws_cdk.mixins_preview.aws_datazone import mixins as datazone_mixins cfn_data_source_props_mixin = datazone_mixins.CfnDataSourcePropsMixin(datazone_mixins.CfnDataSourceMixinProps( asset_forms_input=[datazone_mixins.CfnDataSourcePropsMixin.FormInputProperty( content="content", form_name="formName", type_identifier="typeIdentifier", type_revision="typeRevision" )], configuration=datazone_mixins.CfnDataSourcePropsMixin.DataSourceConfigurationInputProperty( glue_run_configuration=datazone_mixins.CfnDataSourcePropsMixin.GlueRunConfigurationInputProperty( auto_import_data_quality_result=False, catalog_name="catalogName", data_access_role="dataAccessRole", relational_filter_configurations=[datazone_mixins.CfnDataSourcePropsMixin.RelationalFilterConfigurationProperty( database_name="databaseName", filter_expressions=[datazone_mixins.CfnDataSourcePropsMixin.FilterExpressionProperty( expression="expression", type="type" )], schema_name="schemaName" )] ), redshift_run_configuration=datazone_mixins.CfnDataSourcePropsMixin.RedshiftRunConfigurationInputProperty( data_access_role="dataAccessRole", redshift_credential_configuration=datazone_mixins.CfnDataSourcePropsMixin.RedshiftCredentialConfigurationProperty( secret_manager_arn="secretManagerArn" ), redshift_storage=datazone_mixins.CfnDataSourcePropsMixin.RedshiftStorageProperty( redshift_cluster_source=datazone_mixins.CfnDataSourcePropsMixin.RedshiftClusterStorageProperty( cluster_name="clusterName" ), redshift_serverless_source=datazone_mixins.CfnDataSourcePropsMixin.RedshiftServerlessStorageProperty( workgroup_name="workgroupName" ) ), relational_filter_configurations=[datazone_mixins.CfnDataSourcePropsMixin.RelationalFilterConfigurationProperty( database_name="databaseName", filter_expressions=[datazone_mixins.CfnDataSourcePropsMixin.FilterExpressionProperty( expression="expression", type="type" )], schema_name="schemaName" )] ), sage_maker_run_configuration=datazone_mixins.CfnDataSourcePropsMixin.SageMakerRunConfigurationInputProperty( tracking_assets={ "tracking_assets_key": ["trackingAssets"] } ) ), connection_identifier="connectionIdentifier", description="description", domain_identifier="domainIdentifier", enable_setting="enableSetting", environment_identifier="environmentIdentifier", name="name", project_identifier="projectIdentifier", publish_on_import=False, recommendation=datazone_mixins.CfnDataSourcePropsMixin.RecommendationConfigurationProperty( enable_business_name_generation=False ), schedule=datazone_mixins.CfnDataSourcePropsMixin.ScheduleConfigurationProperty( schedule="schedule", timezone="timezone" ), type="type" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::DataZone::DataSource.- Parameters:
props (
Union[CfnDataSourceMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['assetFormsInput', 'configuration', 'connectionIdentifier', 'description', 'domainIdentifier', 'enableSetting', 'environmentIdentifier', 'name', 'projectIdentifier', 'publishOnImport', 'recommendation', 'schedule', 'type']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
DataSourceConfigurationInputProperty
- class CfnDataSourcePropsMixin.DataSourceConfigurationInputProperty(*, glue_run_configuration=None, redshift_run_configuration=None, sage_maker_run_configuration=None)
Bases:
objectThe configuration of the data source.
- Parameters:
glue_run_configuration (
Union[IResolvable,GlueRunConfigurationInputProperty,Dict[str,Any],None]) – The configuration of the AWS Glue data source.redshift_run_configuration (
Union[IResolvable,RedshiftRunConfigurationInputProperty,Dict[str,Any],None]) – The configuration of the Amazon Redshift data source.sage_maker_run_configuration (
Union[IResolvable,SageMakerRunConfigurationInputProperty,Dict[str,Any],None]) – The configuration details of the Amazon SageMaker data source.
- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins data_source_configuration_input_property = datazone_mixins.CfnDataSourcePropsMixin.DataSourceConfigurationInputProperty( glue_run_configuration=datazone_mixins.CfnDataSourcePropsMixin.GlueRunConfigurationInputProperty( auto_import_data_quality_result=False, catalog_name="catalogName", data_access_role="dataAccessRole", relational_filter_configurations=[datazone_mixins.CfnDataSourcePropsMixin.RelationalFilterConfigurationProperty( database_name="databaseName", filter_expressions=[datazone_mixins.CfnDataSourcePropsMixin.FilterExpressionProperty( expression="expression", type="type" )], schema_name="schemaName" )] ), redshift_run_configuration=datazone_mixins.CfnDataSourcePropsMixin.RedshiftRunConfigurationInputProperty( data_access_role="dataAccessRole", redshift_credential_configuration=datazone_mixins.CfnDataSourcePropsMixin.RedshiftCredentialConfigurationProperty( secret_manager_arn="secretManagerArn" ), redshift_storage=datazone_mixins.CfnDataSourcePropsMixin.RedshiftStorageProperty( redshift_cluster_source=datazone_mixins.CfnDataSourcePropsMixin.RedshiftClusterStorageProperty( cluster_name="clusterName" ), redshift_serverless_source=datazone_mixins.CfnDataSourcePropsMixin.RedshiftServerlessStorageProperty( workgroup_name="workgroupName" ) ), relational_filter_configurations=[datazone_mixins.CfnDataSourcePropsMixin.RelationalFilterConfigurationProperty( database_name="databaseName", filter_expressions=[datazone_mixins.CfnDataSourcePropsMixin.FilterExpressionProperty( expression="expression", type="type" )], schema_name="schemaName" )] ), sage_maker_run_configuration=datazone_mixins.CfnDataSourcePropsMixin.SageMakerRunConfigurationInputProperty( tracking_assets={ "tracking_assets_key": ["trackingAssets"] } ) )
Attributes
- glue_run_configuration
The configuration of the AWS Glue data source.
- redshift_run_configuration
The configuration of the Amazon Redshift data source.
- sage_maker_run_configuration
The configuration details of the Amazon SageMaker data source.
FilterExpressionProperty
- class CfnDataSourcePropsMixin.FilterExpressionProperty(*, expression=None, type=None)
Bases:
objectA filter expression in Amazon DataZone.
- Parameters:
expression (
Optional[str]) – The search filter expression.type (
Optional[str]) – The search filter explresison type.
- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins filter_expression_property = datazone_mixins.CfnDataSourcePropsMixin.FilterExpressionProperty( expression="expression", type="type" )
Attributes
- expression
The search filter expression.
- type
The search filter explresison type.
FormInputProperty
- class CfnDataSourcePropsMixin.FormInputProperty(*, content=None, form_name=None, type_identifier=None, type_revision=None)
Bases:
objectThe details of a metadata form.
- Parameters:
content (
Optional[str]) – The content of the metadata form.form_name (
Optional[str]) – The name of the metadata form.type_identifier (
Optional[str]) – The ID of the metadata form type.type_revision (
Optional[str]) – The revision of the metadata form type.
- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins form_input_property = datazone_mixins.CfnDataSourcePropsMixin.FormInputProperty( content="content", form_name="formName", type_identifier="typeIdentifier", type_revision="typeRevision" )
Attributes
- content
The content of the metadata form.
- form_name
The name of the metadata form.
- type_identifier
The ID of the metadata form type.
- type_revision
The revision of the metadata form type.
GlueRunConfigurationInputProperty
- class CfnDataSourcePropsMixin.GlueRunConfigurationInputProperty(*, auto_import_data_quality_result=None, catalog_name=None, data_access_role=None, relational_filter_configurations=None)
Bases:
objectThe configuration details of the AWS Glue data source.
- Parameters:
auto_import_data_quality_result (
Union[bool,IResolvable,None]) – Specifies whether to automatically import data quality metrics as part of the data source run.catalog_name (
Optional[str]) – The catalog name in the AWS Glue run configuration.data_access_role (
Optional[str]) – The data access role included in the configuration details of the AWS Glue data source.relational_filter_configurations (
Union[IResolvable,Sequence[Union[IResolvable,RelationalFilterConfigurationProperty,Dict[str,Any]]],None]) – The relational filter configurations included in the configuration details of the AWS Glue data source.
- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins glue_run_configuration_input_property = datazone_mixins.CfnDataSourcePropsMixin.GlueRunConfigurationInputProperty( auto_import_data_quality_result=False, catalog_name="catalogName", data_access_role="dataAccessRole", relational_filter_configurations=[datazone_mixins.CfnDataSourcePropsMixin.RelationalFilterConfigurationProperty( database_name="databaseName", filter_expressions=[datazone_mixins.CfnDataSourcePropsMixin.FilterExpressionProperty( expression="expression", type="type" )], schema_name="schemaName" )] )
Attributes
- auto_import_data_quality_result
Specifies whether to automatically import data quality metrics as part of the data source run.
- catalog_name
The catalog name in the AWS Glue run configuration.
- data_access_role
The data access role included in the configuration details of the AWS Glue data source.
- relational_filter_configurations
The relational filter configurations included in the configuration details of the AWS Glue data source.
RecommendationConfigurationProperty
- class CfnDataSourcePropsMixin.RecommendationConfigurationProperty(*, enable_business_name_generation=None)
Bases:
objectThe recommendation configuration for the data source.
- Parameters:
enable_business_name_generation (
Union[bool,IResolvable,None]) – Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins recommendation_configuration_property = datazone_mixins.CfnDataSourcePropsMixin.RecommendationConfigurationProperty( enable_business_name_generation=False )
Attributes
- enable_business_name_generation
Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.
RedshiftClusterStorageProperty
- class CfnDataSourcePropsMixin.RedshiftClusterStorageProperty(*, cluster_name=None)
Bases:
objectThe details of the Amazon Redshift cluster storage.
- Parameters:
cluster_name (
Optional[str]) – The name of an Amazon Redshift cluster.- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins redshift_cluster_storage_property = datazone_mixins.CfnDataSourcePropsMixin.RedshiftClusterStorageProperty( cluster_name="clusterName" )
Attributes
- cluster_name
The name of an Amazon Redshift cluster.
RedshiftCredentialConfigurationProperty
- class CfnDataSourcePropsMixin.RedshiftCredentialConfigurationProperty(*, secret_manager_arn=None)
Bases:
objectThe details of the credentials required to access an Amazon Redshift cluster.
- Parameters:
secret_manager_arn (
Optional[str]) – The ARN of a secret manager for an Amazon Redshift cluster.- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins redshift_credential_configuration_property = datazone_mixins.CfnDataSourcePropsMixin.RedshiftCredentialConfigurationProperty( secret_manager_arn="secretManagerArn" )
Attributes
- secret_manager_arn
The ARN of a secret manager for an Amazon Redshift cluster.
RedshiftRunConfigurationInputProperty
- class CfnDataSourcePropsMixin.RedshiftRunConfigurationInputProperty(*, data_access_role=None, redshift_credential_configuration=None, redshift_storage=None, relational_filter_configurations=None)
Bases:
objectThe relational filter configurations included in the configuration details of the Amazon Redshift data source.
- Parameters:
data_access_role (
Optional[str]) – The data access role included in the configuration details of the Amazon Redshift data source.redshift_credential_configuration (
Union[IResolvable,RedshiftCredentialConfigurationProperty,Dict[str,Any],None]) – The details of the credentials required to access an Amazon Redshift cluster.redshift_storage (
Union[IResolvable,RedshiftStorageProperty,Dict[str,Any],None]) – The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.relational_filter_configurations (
Union[IResolvable,Sequence[Union[IResolvable,RelationalFilterConfigurationProperty,Dict[str,Any]]],None]) – The relational filter configurations included in the configuration details of the AWS Glue data source.
- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins redshift_run_configuration_input_property = datazone_mixins.CfnDataSourcePropsMixin.RedshiftRunConfigurationInputProperty( data_access_role="dataAccessRole", redshift_credential_configuration=datazone_mixins.CfnDataSourcePropsMixin.RedshiftCredentialConfigurationProperty( secret_manager_arn="secretManagerArn" ), redshift_storage=datazone_mixins.CfnDataSourcePropsMixin.RedshiftStorageProperty( redshift_cluster_source=datazone_mixins.CfnDataSourcePropsMixin.RedshiftClusterStorageProperty( cluster_name="clusterName" ), redshift_serverless_source=datazone_mixins.CfnDataSourcePropsMixin.RedshiftServerlessStorageProperty( workgroup_name="workgroupName" ) ), relational_filter_configurations=[datazone_mixins.CfnDataSourcePropsMixin.RelationalFilterConfigurationProperty( database_name="databaseName", filter_expressions=[datazone_mixins.CfnDataSourcePropsMixin.FilterExpressionProperty( expression="expression", type="type" )], schema_name="schemaName" )] )
Attributes
- data_access_role
The data access role included in the configuration details of the Amazon Redshift data source.
- redshift_credential_configuration
The details of the credentials required to access an Amazon Redshift cluster.
- redshift_storage
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
- relational_filter_configurations
The relational filter configurations included in the configuration details of the AWS Glue data source.
RedshiftServerlessStorageProperty
- class CfnDataSourcePropsMixin.RedshiftServerlessStorageProperty(*, workgroup_name=None)
Bases:
objectThe details of the Amazon Redshift Serverless workgroup storage.
- Parameters:
workgroup_name (
Optional[str]) – The name of the Amazon Redshift Serverless workgroup.- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins redshift_serverless_storage_property = datazone_mixins.CfnDataSourcePropsMixin.RedshiftServerlessStorageProperty( workgroup_name="workgroupName" )
Attributes
- workgroup_name
The name of the Amazon Redshift Serverless workgroup.
RedshiftStorageProperty
- class CfnDataSourcePropsMixin.RedshiftStorageProperty(*, redshift_cluster_source=None, redshift_serverless_source=None)
Bases:
objectThe details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
- Parameters:
redshift_cluster_source (
Union[IResolvable,RedshiftClusterStorageProperty,Dict[str,Any],None]) – The details of the Amazon Redshift cluster source.redshift_serverless_source (
Union[IResolvable,RedshiftServerlessStorageProperty,Dict[str,Any],None]) – The details of the Amazon Redshift Serverless workgroup source.
- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins redshift_storage_property = datazone_mixins.CfnDataSourcePropsMixin.RedshiftStorageProperty( redshift_cluster_source=datazone_mixins.CfnDataSourcePropsMixin.RedshiftClusterStorageProperty( cluster_name="clusterName" ), redshift_serverless_source=datazone_mixins.CfnDataSourcePropsMixin.RedshiftServerlessStorageProperty( workgroup_name="workgroupName" ) )
Attributes
- redshift_cluster_source
The details of the Amazon Redshift cluster source.
- redshift_serverless_source
The details of the Amazon Redshift Serverless workgroup source.
RelationalFilterConfigurationProperty
- class CfnDataSourcePropsMixin.RelationalFilterConfigurationProperty(*, database_name=None, filter_expressions=None, schema_name=None)
Bases:
objectThe relational filter configuration for the data source.
- Parameters:
database_name (
Optional[str]) – The database name specified in the relational filter configuration for the data source.filter_expressions (
Union[IResolvable,Sequence[Union[IResolvable,FilterExpressionProperty,Dict[str,Any]]],None]) – The filter expressions specified in the relational filter configuration for the data source.schema_name (
Optional[str]) – The schema name specified in the relational filter configuration for the data source.
- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins relational_filter_configuration_property = datazone_mixins.CfnDataSourcePropsMixin.RelationalFilterConfigurationProperty( database_name="databaseName", filter_expressions=[datazone_mixins.CfnDataSourcePropsMixin.FilterExpressionProperty( expression="expression", type="type" )], schema_name="schemaName" )
Attributes
- database_name
The database name specified in the relational filter configuration for the data source.
- filter_expressions
The filter expressions specified in the relational filter configuration for the data source.
- schema_name
The schema name specified in the relational filter configuration for the data source.
SageMakerRunConfigurationInputProperty
- class CfnDataSourcePropsMixin.SageMakerRunConfigurationInputProperty(*, tracking_assets=None)
Bases:
objectThe configuration details of the Amazon SageMaker data source.
- Parameters:
tracking_assets (
Union[IResolvable,Mapping[str,Sequence[str]],None]) – The tracking assets of the Amazon SageMaker run.- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins sage_maker_run_configuration_input_property = datazone_mixins.CfnDataSourcePropsMixin.SageMakerRunConfigurationInputProperty( tracking_assets={ "tracking_assets_key": ["trackingAssets"] } )
Attributes
- tracking_assets
The tracking assets of the Amazon SageMaker run.
ScheduleConfigurationProperty
- class CfnDataSourcePropsMixin.ScheduleConfigurationProperty(*, schedule=None, timezone=None)
Bases:
objectThe details of the schedule of the data source runs.
- Parameters:
schedule (
Optional[str]) – The schedule of the data source runs.timezone (
Optional[str]) – The timezone of the data source run.
- See:
- 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.mixins_preview.aws_datazone import mixins as datazone_mixins schedule_configuration_property = datazone_mixins.CfnDataSourcePropsMixin.ScheduleConfigurationProperty( schedule="schedule", timezone="timezone" )
Attributes
- schedule
The schedule of the data source runs.
- timezone
The timezone of the data source run.