CfnDataIntegrationFlowPropsMixin
- class aws_cdk.cfn_property_mixins.aws_scn.CfnDataIntegrationFlowPropsMixin(props, *, strategy=None)
Bases:
MixinRepresents an AWS Supply Chain data integration flow.
- See:
- CloudformationResource:
AWS::SCN::DataIntegrationFlow
- 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.cfn_property_mixins import aws_scn as scn import aws_cdk as cdk # merge_strategy: cdk.IMergeStrategy cfn_data_integration_flow_props_mixin = scn.CfnDataIntegrationFlowPropsMixin(scn.CfnDataIntegrationFlowMixinProps( instance_id="instanceId", name="name", sources=[scn.CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowSourceProperty( dataset_source=scn.CfnDataIntegrationFlowPropsMixin.DatasetSourceConfigurationProperty( dataset_identifier="datasetIdentifier", options=scn.CfnDataIntegrationFlowPropsMixin.DatasetOptionsProperty( dedupe_records=False, dedupe_strategy=scn.CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty( field_priority=scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] ), type="type" ), load_type="loadType" ) ), s3_source=scn.CfnDataIntegrationFlowPropsMixin.S3SourceConfigurationProperty( bucket_name="bucketName", options=scn.CfnDataIntegrationFlowPropsMixin.S3OptionsProperty( file_type="fileType" ), prefix="prefix" ), source_name="sourceName", source_type="sourceType" )], tags=[cdk.CfnTag( key="key", value="value" )], target=scn.CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowTargetProperty( dataset_target=scn.CfnDataIntegrationFlowPropsMixin.DatasetTargetConfigurationProperty( dataset_identifier="datasetIdentifier", options=scn.CfnDataIntegrationFlowPropsMixin.DatasetOptionsProperty( dedupe_records=False, dedupe_strategy=scn.CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty( field_priority=scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] ), type="type" ), load_type="loadType" ) ), target_type="targetType" ), transformation=scn.CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowTransformationProperty( sql_transformation=scn.CfnDataIntegrationFlowPropsMixin.SqlTransformationConfigurationProperty( query="query" ), transformation_type="transformationType" ) ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::SCN::DataIntegrationFlow.- Parameters:
props (
Union[CfnDataIntegrationFlowMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['instanceId', 'name', 'sources', 'tags', 'target', 'transformation']
Static Methods
- classmethod is_mixin(x)
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.
DataIntegrationFlowSourceProperty
- class CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowSourceProperty(*, dataset_source=None, s3_source=None, source_name=None, source_type=None)
Bases:
objectThe DataIntegrationFlow source parameters.
- Parameters:
dataset_source (
Union[IResolvable,DatasetSourceConfigurationProperty,Dict[str,Any],None]) – The dataset source configuration parameters.s3_source (
Union[IResolvable,S3SourceConfigurationProperty,Dict[str,Any],None]) – The S3 source configuration parameters.source_name (
Optional[str]) – The source name that can be used as table alias in SQL transformation query.source_type (
Optional[str]) – The source 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.cfn_property_mixins import aws_scn as scn data_integration_flow_source_property = scn.CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowSourceProperty( dataset_source=scn.CfnDataIntegrationFlowPropsMixin.DatasetSourceConfigurationProperty( dataset_identifier="datasetIdentifier", options=scn.CfnDataIntegrationFlowPropsMixin.DatasetOptionsProperty( dedupe_records=False, dedupe_strategy=scn.CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty( field_priority=scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] ), type="type" ), load_type="loadType" ) ), s3_source=scn.CfnDataIntegrationFlowPropsMixin.S3SourceConfigurationProperty( bucket_name="bucketName", options=scn.CfnDataIntegrationFlowPropsMixin.S3OptionsProperty( file_type="fileType" ), prefix="prefix" ), source_name="sourceName", source_type="sourceType" )
Attributes
- dataset_source
The dataset source configuration parameters.
- s3_source
The S3 source configuration parameters.
- source_name
The source name that can be used as table alias in SQL transformation query.
DataIntegrationFlowTargetProperty
- class CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowTargetProperty(*, dataset_target=None, target_type=None)
Bases:
objectThe DataIntegrationFlow target parameters.
- Parameters:
dataset_target (
Union[IResolvable,DatasetTargetConfigurationProperty,Dict[str,Any],None]) – The dataset target configuration parameters.target_type (
Optional[str]) – The target 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.cfn_property_mixins import aws_scn as scn data_integration_flow_target_property = scn.CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowTargetProperty( dataset_target=scn.CfnDataIntegrationFlowPropsMixin.DatasetTargetConfigurationProperty( dataset_identifier="datasetIdentifier", options=scn.CfnDataIntegrationFlowPropsMixin.DatasetOptionsProperty( dedupe_records=False, dedupe_strategy=scn.CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty( field_priority=scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] ), type="type" ), load_type="loadType" ) ), target_type="targetType" )
Attributes
- dataset_target
The dataset target configuration parameters.
DataIntegrationFlowTransformationProperty
- class CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowTransformationProperty(*, sql_transformation=None, transformation_type=None)
Bases:
objectThe DataIntegrationFlow transformation parameters.
- Parameters:
sql_transformation (
Union[IResolvable,SqlTransformationConfigurationProperty,Dict[str,Any],None]) – The SQL transformation configuration parameters.transformation_type (
Optional[str]) – The transformation 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.cfn_property_mixins import aws_scn as scn data_integration_flow_transformation_property = scn.CfnDataIntegrationFlowPropsMixin.DataIntegrationFlowTransformationProperty( sql_transformation=scn.CfnDataIntegrationFlowPropsMixin.SqlTransformationConfigurationProperty( query="query" ), transformation_type="transformationType" )
Attributes
- sql_transformation
The SQL transformation configuration parameters.
DatasetOptionsProperty
- class CfnDataIntegrationFlowPropsMixin.DatasetOptionsProperty(*, dedupe_records=None, dedupe_strategy=None, load_type=None)
Bases:
objectThe dataset options.
- Parameters:
dedupe_records (
Union[bool,IResolvable,None]) – The option to perform deduplication on data records sharing same primary key values.dedupe_strategy (
Union[IResolvable,DedupeStrategyProperty,Dict[str,Any],None]) – The deduplication strategy.load_type (
Optional[str]) – The load 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.cfn_property_mixins import aws_scn as scn dataset_options_property = scn.CfnDataIntegrationFlowPropsMixin.DatasetOptionsProperty( dedupe_records=False, dedupe_strategy=scn.CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty( field_priority=scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] ), type="type" ), load_type="loadType" )
Attributes
- dedupe_records
The option to perform deduplication on data records sharing same primary key values.
- dedupe_strategy
The deduplication strategy.
DatasetSourceConfigurationProperty
- class CfnDataIntegrationFlowPropsMixin.DatasetSourceConfigurationProperty(*, dataset_identifier=None, options=None)
Bases:
objectThe dataset source configuration parameters.
- Parameters:
dataset_identifier (
Optional[str]) – The ARN of the dataset.options (
Union[IResolvable,DatasetOptionsProperty,Dict[str,Any],None]) – The dataset options.
- 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.cfn_property_mixins import aws_scn as scn dataset_source_configuration_property = scn.CfnDataIntegrationFlowPropsMixin.DatasetSourceConfigurationProperty( dataset_identifier="datasetIdentifier", options=scn.CfnDataIntegrationFlowPropsMixin.DatasetOptionsProperty( dedupe_records=False, dedupe_strategy=scn.CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty( field_priority=scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] ), type="type" ), load_type="loadType" ) )
Attributes
- dataset_identifier
The ARN of the dataset.
DatasetTargetConfigurationProperty
- class CfnDataIntegrationFlowPropsMixin.DatasetTargetConfigurationProperty(*, dataset_identifier=None, options=None)
Bases:
objectThe dataset target configuration parameters.
- Parameters:
dataset_identifier (
Optional[str]) – The dataset ARN.options (
Union[IResolvable,DatasetOptionsProperty,Dict[str,Any],None]) – The dataset options.
- 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.cfn_property_mixins import aws_scn as scn dataset_target_configuration_property = scn.CfnDataIntegrationFlowPropsMixin.DatasetTargetConfigurationProperty( dataset_identifier="datasetIdentifier", options=scn.CfnDataIntegrationFlowPropsMixin.DatasetOptionsProperty( dedupe_records=False, dedupe_strategy=scn.CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty( field_priority=scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] ), type="type" ), load_type="loadType" ) )
Attributes
- dataset_identifier
The dataset ARN.
DedupeStrategyProperty
- class CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty(*, field_priority=None, type=None)
Bases:
objectThe deduplication strategy.
- Parameters:
field_priority (
Union[IResolvable,FieldPriorityDedupeStrategyConfigurationProperty,Dict[str,Any],None]) – The field priority deduplication strategy configuration.type (
Optional[str]) – The deduplication strategy 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.cfn_property_mixins import aws_scn as scn dedupe_strategy_property = scn.CfnDataIntegrationFlowPropsMixin.DedupeStrategyProperty( field_priority=scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] ), type="type" )
Attributes
- field_priority
The field priority deduplication strategy configuration.
- type
The deduplication strategy type.
FieldPriorityDedupeFieldProperty
- class CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty(*, name=None, sort_order=None)
Bases:
objectA deduplication field.
- Parameters:
name (
Optional[str]) – The name of the deduplication field.sort_order (
Optional[str]) – The sort order.
- 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.cfn_property_mixins import aws_scn as scn field_priority_dedupe_field_property = scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )
Attributes
- name
The name of the deduplication field.
FieldPriorityDedupeStrategyConfigurationProperty
- class CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty(*, fields=None)
Bases:
objectThe field priority deduplication strategy configuration.
- Parameters:
fields (
Union[IResolvable,Sequence[Union[IResolvable,FieldPriorityDedupeFieldProperty,Dict[str,Any]]],None]) – The list of field names and their sort order for deduplication.- 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.cfn_property_mixins import aws_scn as scn field_priority_dedupe_strategy_configuration_property = scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeStrategyConfigurationProperty( fields=[scn.CfnDataIntegrationFlowPropsMixin.FieldPriorityDedupeFieldProperty( name="name", sort_order="sortOrder" )] )
Attributes
- fields
The list of field names and their sort order for deduplication.
S3OptionsProperty
- class CfnDataIntegrationFlowPropsMixin.S3OptionsProperty(*, file_type=None)
Bases:
objectThe Amazon S3 options.
- Parameters:
file_type (
Optional[str]) – The file 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.cfn_property_mixins import aws_scn as scn s3_options_property = scn.CfnDataIntegrationFlowPropsMixin.S3OptionsProperty( file_type="fileType" )
Attributes
S3SourceConfigurationProperty
- class CfnDataIntegrationFlowPropsMixin.S3SourceConfigurationProperty(*, bucket_name=None, options=None, prefix=None)
Bases:
objectThe S3 source configuration parameters.
- Parameters:
bucket_name (
Optional[str]) – The S3 bucket name.options (
Union[IResolvable,S3OptionsProperty,Dict[str,Any],None]) – The Amazon S3 options.prefix (
Optional[str]) – The S3 prefix.
- 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.cfn_property_mixins import aws_scn as scn s3_source_configuration_property = scn.CfnDataIntegrationFlowPropsMixin.S3SourceConfigurationProperty( bucket_name="bucketName", options=scn.CfnDataIntegrationFlowPropsMixin.S3OptionsProperty( file_type="fileType" ), prefix="prefix" )
Attributes
- bucket_name
The S3 bucket name.
- options
The Amazon S3 options.
SqlTransformationConfigurationProperty
- class CfnDataIntegrationFlowPropsMixin.SqlTransformationConfigurationProperty(*, query=None)
Bases:
objectThe SQL transformation configuration parameters.
- Parameters:
query (
Optional[str]) – The transformation SQL query body based on SparkSQL.- 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.cfn_property_mixins import aws_scn as scn sql_transformation_configuration_property = scn.CfnDataIntegrationFlowPropsMixin.SqlTransformationConfigurationProperty( query="query" )
Attributes
- query
The transformation SQL query body based on SparkSQL.