CfnDatasetPropsMixin

class aws_cdk.cfn_property_mixins.aws_scn.CfnDatasetPropsMixin(props, *, strategy=None)

Bases: Mixin

Represents an AWS Supply Chain data lake dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html
CloudformationResource:: AWS::SCN::Dataset
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_dataset_props_mixin = scn.CfnDatasetPropsMixin(scn.CfnDatasetMixinProps(
    description="description",
    instance_id="instanceId",
    name="name",
    namespace="namespace",
    partition_spec=scn.CfnDatasetPropsMixin.PartitionSpecProperty(
        fields=[scn.CfnDatasetPropsMixin.DataLakeDatasetPartitionFieldProperty(
            name="name",
            transform=scn.CfnDatasetPropsMixin.TransformProperty(
                type="type"
            )
        )]
    ),
    schema=scn.CfnDatasetPropsMixin.SchemaProperty(
        fields=[scn.CfnDatasetPropsMixin.DataLakeDatasetSchemaFieldProperty(
            is_required=False,
            name="name",
            type="type"
        )],
        name="name",
        primary_keys=[scn.CfnDatasetPropsMixin.DataLakeDatasetPrimaryKeyFieldProperty(
            name="name"
        )]
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SCN::Dataset.

Parameters:

props (Union[CfnDatasetMixinProps, 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 = ['description', 'instanceId', 'name', 'namespace', 'partitionSpec', 'schema', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

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

DataLakeDatasetPartitionFieldProperty

class CfnDatasetPropsMixin.DataLakeDatasetPartitionFieldProperty(*, name=None, transform=None)

Bases: object

The partition field details.

Parameters:

name (Optional[str]) – The name of the partition field.
transform (Union[IResolvable, TransformProperty, Dict[str, Any], None]) – The transformation of the partition field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-datalakedatasetpartitionfield.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.cfn_property_mixins import aws_scn as scn

data_lake_dataset_partition_field_property = scn.CfnDatasetPropsMixin.DataLakeDatasetPartitionFieldProperty(
    name="name",
    transform=scn.CfnDatasetPropsMixin.TransformProperty(
        type="type"
    )
)

Attributes

name

The name of the partition field.

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

transform

The transformation of the partition field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-datalakedatasetpartitionfield.html#cfn-scn-dataset-datalakedatasetpartitionfield-transform

DataLakeDatasetPrimaryKeyFieldProperty

class CfnDatasetPropsMixin.DataLakeDatasetPrimaryKeyFieldProperty(*, name=None)

Bases: object

The primary key field details.

Parameters:: name (Optional[str]) – The name of the primary key field.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-datalakedatasetprimarykeyfield.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.cfn_property_mixins import aws_scn as scn

data_lake_dataset_primary_key_field_property = scn.CfnDatasetPropsMixin.DataLakeDatasetPrimaryKeyFieldProperty(
    name="name"
)

Attributes

name

The name of the primary key field.

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

DataLakeDatasetSchemaFieldProperty

class CfnDatasetPropsMixin.DataLakeDatasetSchemaFieldProperty(*, is_required=None, name=None, type=None)

Bases: object

The dataset field details.

Parameters:

is_required (Union[bool, IResolvable, None]) – Indicate if the field is required or not.
name (Optional[str]) – The dataset field name.
type (Optional[str]) – The dataset field type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-datalakedatasetschemafield.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.cfn_property_mixins import aws_scn as scn

data_lake_dataset_schema_field_property = scn.CfnDatasetPropsMixin.DataLakeDatasetSchemaFieldProperty(
    is_required=False,
    name="name",
    type="type"
)

Attributes

is_required

Indicate if the field is required or not.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-datalakedatasetschemafield.html#cfn-scn-dataset-datalakedatasetschemafield-isrequired

name

The dataset field name.

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

type

The dataset field type.

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

PartitionSpecProperty

class CfnDatasetPropsMixin.PartitionSpecProperty(*, fields=None)

Bases: object

The partition specification of the dataset.

Parameters:: fields (Union[IResolvable, Sequence[Union[IResolvable, DataLakeDatasetPartitionFieldProperty, Dict[str, Any]]], None]) – The partition fields.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-partitionspec.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.cfn_property_mixins import aws_scn as scn

partition_spec_property = scn.CfnDatasetPropsMixin.PartitionSpecProperty(
    fields=[scn.CfnDatasetPropsMixin.DataLakeDatasetPartitionFieldProperty(
        name="name",
        transform=scn.CfnDatasetPropsMixin.TransformProperty(
            type="type"
        )
    )]
)

Attributes

fields

The partition fields.

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

SchemaProperty

class CfnDatasetPropsMixin.SchemaProperty(*, fields=None, name=None, primary_keys=None)

Bases: object

The schema of the dataset.

Parameters:

fields (Union[IResolvable, Sequence[Union[IResolvable, DataLakeDatasetSchemaFieldProperty, Dict[str, Any]]], None]) – The list of field details of the dataset schema.
name (Optional[str]) – The name of the dataset schema.
primary_keys (Union[IResolvable, Sequence[Union[IResolvable, DataLakeDatasetPrimaryKeyFieldProperty, Dict[str, Any]]], None]) – The list of primary key fields for the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-schema.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.cfn_property_mixins import aws_scn as scn

schema_property = scn.CfnDatasetPropsMixin.SchemaProperty(
    fields=[scn.CfnDatasetPropsMixin.DataLakeDatasetSchemaFieldProperty(
        is_required=False,
        name="name",
        type="type"
    )],
    name="name",
    primary_keys=[scn.CfnDatasetPropsMixin.DataLakeDatasetPrimaryKeyFieldProperty(
        name="name"
    )]
)

Attributes

fields

The list of field details of the dataset schema.

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

name

The name of the dataset schema.

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

primary_keys

The list of primary key fields for the dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-schema.html#cfn-scn-dataset-schema-primarykeys

TransformProperty

class CfnDatasetPropsMixin.TransformProperty(*, type=None)

Bases: object

The transformation of the partition field.

Parameters:: type (Optional[str]) – The type of partitioning transformation.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-transform.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.cfn_property_mixins import aws_scn as scn

transform_property = scn.CfnDatasetPropsMixin.TransformProperty(
    type="type"
)

Attributes

type

The type of partitioning transformation.

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