CfnDataIntegrationFlow

class aws_cdk.aws_scn.CfnDataIntegrationFlow(scope, id, *, instance_id, name, sources, target, transformation, tags=None)

Bases: CfnResource

Represents an AWS Supply Chain data integration flow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataintegrationflow.html
CloudformationResource:: AWS::SCN::DataIntegrationFlow
ExampleMetadata:: fixture=_generated

Example:

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

cfn_data_integration_flow = scn.CfnDataIntegrationFlow(self, "MyCfnDataIntegrationFlow",
    instance_id="instanceId",
    name="name",
    sources=[scn.CfnDataIntegrationFlow.DataIntegrationFlowSourceProperty(
        source_name="sourceName",
        source_type="sourceType",

        # the properties below are optional
        dataset_source=scn.CfnDataIntegrationFlow.DatasetSourceConfigurationProperty(
            dataset_identifier="datasetIdentifier",

            # the properties below are optional
            options=scn.CfnDataIntegrationFlow.DatasetOptionsProperty(
                dedupe_records=False,
                dedupe_strategy=scn.CfnDataIntegrationFlow.DedupeStrategyProperty(
                    type="type",

                    # the properties below are optional
                    field_priority=scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
                        fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
                            name="name",
                            sort_order="sortOrder"
                        )]
                    )
                ),
                load_type="loadType"
            )
        ),
        s3_source=scn.CfnDataIntegrationFlow.S3SourceConfigurationProperty(
            bucket_name="bucketName",
            prefix="prefix",

            # the properties below are optional
            options=scn.CfnDataIntegrationFlow.S3OptionsProperty(
                file_type="fileType"
            )
        )
    )],
    target=scn.CfnDataIntegrationFlow.DataIntegrationFlowTargetProperty(
        target_type="targetType",

        # the properties below are optional
        dataset_target=scn.CfnDataIntegrationFlow.DatasetTargetConfigurationProperty(
            dataset_identifier="datasetIdentifier",

            # the properties below are optional
            options=scn.CfnDataIntegrationFlow.DatasetOptionsProperty(
                dedupe_records=False,
                dedupe_strategy=scn.CfnDataIntegrationFlow.DedupeStrategyProperty(
                    type="type",

                    # the properties below are optional
                    field_priority=scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
                        fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
                            name="name",
                            sort_order="sortOrder"
                        )]
                    )
                ),
                load_type="loadType"
            )
        )
    ),
    transformation=scn.CfnDataIntegrationFlow.DataIntegrationFlowTransformationProperty(
        transformation_type="transformationType",

        # the properties below are optional
        sql_transformation=scn.CfnDataIntegrationFlow.SqlTransformationConfigurationProperty(
            query="query"
        )
    ),

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::SCN::DataIntegrationFlow.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
instance_id (str) – The Amazon Web Services Supply Chain instance identifier.
name (str) – The name of the DataIntegrationFlow.
sources (Union[IResolvable, Sequence[Union[IResolvable, DataIntegrationFlowSourceProperty, Dict[str, Any]]]]) – The source configurations for the DataIntegrationFlow.
target (Union[IResolvable, DataIntegrationFlowTargetProperty, Dict[str, Any]]) – The DataIntegrationFlow target parameters.
transformation (Union[IResolvable, DataIntegrationFlowTransformationProperty, Dict[str, Any]]) – The DataIntegrationFlow transformation parameters.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags for the DataIntegrationFlow.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:

target (CfnResource)
reason (Optional[str])

Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)

Parameters:: cdk_property_name (str)
Return type:: Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:: List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Deprecated:: Use removeResourceDependency instead
Stability:: deprecated
Return type:: None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SCN::DataIntegrationFlow'

attr_arn

The Amazon Resource Name (ARN) of the DataIntegrationFlow.

CloudformationAttribute:: Arn

attr_created_time

The creation time of the DataIntegrationFlow.

CloudformationAttribute:: CreatedTime

attr_last_modified_time

The last modified time of the DataIntegrationFlow.

CloudformationAttribute:: LastModifiedTime

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

data_integration_flow_ref: A reference to a DataIntegrationFlow resource.

env

instance_id: The Amazon Web Services Supply Chain instance identifier.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the DataIntegrationFlow.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

sources: The source configurations for the DataIntegrationFlow.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: The tags for the DataIntegrationFlow.

target: The DataIntegrationFlow target parameters.

transformation: The DataIntegrationFlow transformation parameters.

Static Methods

classmethod arn_for_data_integration_flow(resource)

Parameters:: resource (IDataIntegrationFlowRef)
Return type:: str

classmethod is_cfn_data_integration_flow(x)

Checks whether the given object is a CfnDataIntegrationFlow.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

DataIntegrationFlowSourceProperty

class CfnDataIntegrationFlow.DataIntegrationFlowSourceProperty(*, source_name, source_type, dataset_source=None, s3_source=None)

Bases: object

The DataIntegrationFlow source parameters.

Parameters:

source_name (str) – The source name that can be used as table alias in SQL transformation query.
source_type (str) – The source type.
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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowsource.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_scn as scn

data_integration_flow_source_property = scn.CfnDataIntegrationFlow.DataIntegrationFlowSourceProperty(
    source_name="sourceName",
    source_type="sourceType",

    # the properties below are optional
    dataset_source=scn.CfnDataIntegrationFlow.DatasetSourceConfigurationProperty(
        dataset_identifier="datasetIdentifier",

        # the properties below are optional
        options=scn.CfnDataIntegrationFlow.DatasetOptionsProperty(
            dedupe_records=False,
            dedupe_strategy=scn.CfnDataIntegrationFlow.DedupeStrategyProperty(
                type="type",

                # the properties below are optional
                field_priority=scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
                    fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
                        name="name",
                        sort_order="sortOrder"
                    )]
                )
            ),
            load_type="loadType"
        )
    ),
    s3_source=scn.CfnDataIntegrationFlow.S3SourceConfigurationProperty(
        bucket_name="bucketName",
        prefix="prefix",

        # the properties below are optional
        options=scn.CfnDataIntegrationFlow.S3OptionsProperty(
            file_type="fileType"
        )
    )
)

Attributes

dataset_source

The dataset source configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowsource.html#cfn-scn-dataintegrationflow-dataintegrationflowsource-datasetsource

s3_source

The S3 source configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowsource.html#cfn-scn-dataintegrationflow-dataintegrationflowsource-s3source

source_name

The source name that can be used as table alias in SQL transformation query.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowsource.html#cfn-scn-dataintegrationflow-dataintegrationflowsource-sourcename

source_type

The source type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowsource.html#cfn-scn-dataintegrationflow-dataintegrationflowsource-sourcetype

DataIntegrationFlowTargetProperty

class CfnDataIntegrationFlow.DataIntegrationFlowTargetProperty(*, target_type, dataset_target=None)

Bases: object

The DataIntegrationFlow target parameters.

Parameters:

target_type (str) – The target type.
dataset_target (Union[IResolvable, DatasetTargetConfigurationProperty, Dict[str, Any], None]) – The dataset target configuration parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowtarget.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_scn as scn

data_integration_flow_target_property = scn.CfnDataIntegrationFlow.DataIntegrationFlowTargetProperty(
    target_type="targetType",

    # the properties below are optional
    dataset_target=scn.CfnDataIntegrationFlow.DatasetTargetConfigurationProperty(
        dataset_identifier="datasetIdentifier",

        # the properties below are optional
        options=scn.CfnDataIntegrationFlow.DatasetOptionsProperty(
            dedupe_records=False,
            dedupe_strategy=scn.CfnDataIntegrationFlow.DedupeStrategyProperty(
                type="type",

                # the properties below are optional
                field_priority=scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
                    fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
                        name="name",
                        sort_order="sortOrder"
                    )]
                )
            ),
            load_type="loadType"
        )
    )
)

Attributes

dataset_target

The dataset target configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowtarget.html#cfn-scn-dataintegrationflow-dataintegrationflowtarget-datasettarget

target_type

The target type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowtarget.html#cfn-scn-dataintegrationflow-dataintegrationflowtarget-targettype

DataIntegrationFlowTransformationProperty

class CfnDataIntegrationFlow.DataIntegrationFlowTransformationProperty(*, transformation_type, sql_transformation=None)

Bases: object

The DataIntegrationFlow transformation parameters.

Parameters:

transformation_type (str) – The transformation type.
sql_transformation (Union[IResolvable, SqlTransformationConfigurationProperty, Dict[str, Any], None]) – The SQL transformation configuration parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowtransformation.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_scn as scn

data_integration_flow_transformation_property = scn.CfnDataIntegrationFlow.DataIntegrationFlowTransformationProperty(
    transformation_type="transformationType",

    # the properties below are optional
    sql_transformation=scn.CfnDataIntegrationFlow.SqlTransformationConfigurationProperty(
        query="query"
    )
)

Attributes

sql_transformation

The SQL transformation configuration parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowtransformation.html#cfn-scn-dataintegrationflow-dataintegrationflowtransformation-sqltransformation

transformation_type

The transformation type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dataintegrationflowtransformation.html#cfn-scn-dataintegrationflow-dataintegrationflowtransformation-transformationtype

DatasetOptionsProperty

class CfnDataIntegrationFlow.DatasetOptionsProperty(*, dedupe_records=None, dedupe_strategy=None, load_type=None)

Bases: object

The 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasetoptions.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_scn as scn

dataset_options_property = scn.CfnDataIntegrationFlow.DatasetOptionsProperty(
    dedupe_records=False,
    dedupe_strategy=scn.CfnDataIntegrationFlow.DedupeStrategyProperty(
        type="type",

        # the properties below are optional
        field_priority=scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
            fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
                name="name",
                sort_order="sortOrder"
            )]
        )
    ),
    load_type="loadType"
)

Attributes

dedupe_records

The option to perform deduplication on data records sharing same primary key values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasetoptions.html#cfn-scn-dataintegrationflow-datasetoptions-deduperecords

dedupe_strategy

The deduplication strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasetoptions.html#cfn-scn-dataintegrationflow-datasetoptions-dedupestrategy

load_type

The load type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasetoptions.html#cfn-scn-dataintegrationflow-datasetoptions-loadtype

DatasetSourceConfigurationProperty

class CfnDataIntegrationFlow.DatasetSourceConfigurationProperty(*, dataset_identifier, options=None)

Bases: object

The dataset source configuration parameters.

Parameters:

dataset_identifier (str) – The ARN of the dataset.
options (Union[IResolvable, DatasetOptionsProperty, Dict[str, Any], None]) – The dataset options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasetsourceconfiguration.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_scn as scn

dataset_source_configuration_property = scn.CfnDataIntegrationFlow.DatasetSourceConfigurationProperty(
    dataset_identifier="datasetIdentifier",

    # the properties below are optional
    options=scn.CfnDataIntegrationFlow.DatasetOptionsProperty(
        dedupe_records=False,
        dedupe_strategy=scn.CfnDataIntegrationFlow.DedupeStrategyProperty(
            type="type",

            # the properties below are optional
            field_priority=scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
                fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
                    name="name",
                    sort_order="sortOrder"
                )]
            )
        ),
        load_type="loadType"
    )
)

Attributes

dataset_identifier

The ARN of the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasetsourceconfiguration.html#cfn-scn-dataintegrationflow-datasetsourceconfiguration-datasetidentifier

options

The dataset options.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasetsourceconfiguration.html#cfn-scn-dataintegrationflow-datasetsourceconfiguration-options

DatasetTargetConfigurationProperty

class CfnDataIntegrationFlow.DatasetTargetConfigurationProperty(*, dataset_identifier, options=None)

Bases: object

The dataset target configuration parameters.

Parameters:

dataset_identifier (str) – The dataset ARN.
options (Union[IResolvable, DatasetOptionsProperty, Dict[str, Any], None]) – The dataset options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasettargetconfiguration.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_scn as scn

dataset_target_configuration_property = scn.CfnDataIntegrationFlow.DatasetTargetConfigurationProperty(
    dataset_identifier="datasetIdentifier",

    # the properties below are optional
    options=scn.CfnDataIntegrationFlow.DatasetOptionsProperty(
        dedupe_records=False,
        dedupe_strategy=scn.CfnDataIntegrationFlow.DedupeStrategyProperty(
            type="type",

            # the properties below are optional
            field_priority=scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
                fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
                    name="name",
                    sort_order="sortOrder"
                )]
            )
        ),
        load_type="loadType"
    )
)

Attributes

dataset_identifier

The dataset ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasettargetconfiguration.html#cfn-scn-dataintegrationflow-datasettargetconfiguration-datasetidentifier

options

The dataset options.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-datasettargetconfiguration.html#cfn-scn-dataintegrationflow-datasettargetconfiguration-options

DedupeStrategyProperty

class CfnDataIntegrationFlow.DedupeStrategyProperty(*, type, field_priority=None)

Bases: object

The deduplication strategy.

Parameters:

type (str) – The deduplication strategy type.
field_priority (Union[IResolvable, FieldPriorityDedupeStrategyConfigurationProperty, Dict[str, Any], None]) – The field priority deduplication strategy configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dedupestrategy.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_scn as scn

dedupe_strategy_property = scn.CfnDataIntegrationFlow.DedupeStrategyProperty(
    type="type",

    # the properties below are optional
    field_priority=scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
        fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
            name="name",
            sort_order="sortOrder"
        )]
    )
)

Attributes

field_priority

The field priority deduplication strategy configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dedupestrategy.html#cfn-scn-dataintegrationflow-dedupestrategy-fieldpriority

type

The deduplication strategy type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-dedupestrategy.html#cfn-scn-dataintegrationflow-dedupestrategy-type

FieldPriorityDedupeFieldProperty

class CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(*, name, sort_order)

Bases: object

A deduplication field.

Parameters:

name (str) – The name of the deduplication field.
sort_order (str) – The sort order.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-fieldprioritydedupefield.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_scn as scn

field_priority_dedupe_field_property = scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
    name="name",
    sort_order="sortOrder"
)

Attributes

name

The name of the deduplication field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-fieldprioritydedupefield.html#cfn-scn-dataintegrationflow-fieldprioritydedupefield-name

sort_order

The sort order.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-fieldprioritydedupefield.html#cfn-scn-dataintegrationflow-fieldprioritydedupefield-sortorder

FieldPriorityDedupeStrategyConfigurationProperty

class CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(*, fields)

Bases: object

The field priority deduplication strategy configuration.

Parameters:: fields (Union[IResolvable, Sequence[Union[IResolvable, FieldPriorityDedupeFieldProperty, Dict[str, Any]]]]) – The list of field names and their sort order for deduplication.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-fieldprioritydedupestrategyconfiguration.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_scn as scn

field_priority_dedupe_strategy_configuration_property = scn.CfnDataIntegrationFlow.FieldPriorityDedupeStrategyConfigurationProperty(
    fields=[scn.CfnDataIntegrationFlow.FieldPriorityDedupeFieldProperty(
        name="name",
        sort_order="sortOrder"
    )]
)

Attributes

fields

The list of field names and their sort order for deduplication.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-fieldprioritydedupestrategyconfiguration.html#cfn-scn-dataintegrationflow-fieldprioritydedupestrategyconfiguration-fields

S3OptionsProperty

class CfnDataIntegrationFlow.S3OptionsProperty(*, file_type=None)

Bases: object

The Amazon S3 options.

Parameters:: file_type (Optional[str]) – The file type.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-s3options.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_scn as scn

s3_options_property = scn.CfnDataIntegrationFlow.S3OptionsProperty(
    file_type="fileType"
)

Attributes

file_type

The file type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-s3options.html#cfn-scn-dataintegrationflow-s3options-filetype

S3SourceConfigurationProperty

class CfnDataIntegrationFlow.S3SourceConfigurationProperty(*, bucket_name, prefix, options=None)

Bases: object

The S3 source configuration parameters.

Parameters:

bucket_name (str) – The S3 bucket name.
prefix (str) – The S3 prefix.
options (Union[IResolvable, S3OptionsProperty, Dict[str, Any], None]) – The Amazon S3 options.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-s3sourceconfiguration.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_scn as scn

s3_source_configuration_property = scn.CfnDataIntegrationFlow.S3SourceConfigurationProperty(
    bucket_name="bucketName",
    prefix="prefix",

    # the properties below are optional
    options=scn.CfnDataIntegrationFlow.S3OptionsProperty(
        file_type="fileType"
    )
)

Attributes

bucket_name

The S3 bucket name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-s3sourceconfiguration.html#cfn-scn-dataintegrationflow-s3sourceconfiguration-bucketname

options

The Amazon S3 options.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-s3sourceconfiguration.html#cfn-scn-dataintegrationflow-s3sourceconfiguration-options

prefix

The S3 prefix.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-s3sourceconfiguration.html#cfn-scn-dataintegrationflow-s3sourceconfiguration-prefix

SqlTransformationConfigurationProperty

class CfnDataIntegrationFlow.SqlTransformationConfigurationProperty(*, query)

Bases: object

The SQL transformation configuration parameters.

Parameters:: query (str) – The transformation SQL query body based on SparkSQL.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-sqltransformationconfiguration.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_scn as scn

sql_transformation_configuration_property = scn.CfnDataIntegrationFlow.SqlTransformationConfigurationProperty(
    query="query"
)

Attributes

query

The transformation SQL query body based on SparkSQL.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataintegrationflow-sqltransformationconfiguration.html#cfn-scn-dataintegrationflow-sqltransformationconfiguration-query