CfnDatasetMixinProps

class aws_cdk.cfn_property_mixins.aws_scn.CfnDatasetMixinProps(*, description=None, instance_id=None, name=None, namespace=None, partition_spec=None, schema=None, tags=None)

Bases: object

Properties for CfnDatasetPropsMixin.

Parameters:
  • description (Optional[str]) – The description of the dataset.

  • instance_id (Optional[str]) – The Amazon Web Services Supply Chain instance identifier.

  • name (Optional[str]) – The name of the dataset.

  • namespace (Optional[str]) – The namespace of the dataset.

  • partition_spec (Union[IResolvable, PartitionSpecProperty, Dict[str, Any], None]) – The partition specification of the dataset.

  • schema (Union[IResolvable, SchemaProperty, Dict[str, Any], None]) – The schema of the dataset.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags for the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

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.cfn_property_mixins import aws_scn as scn

cfn_dataset_mixin_props = 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=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html#cfn-scn-dataset-description

instance_id

The Amazon Web Services Supply Chain instance identifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html#cfn-scn-dataset-instanceid

name

The name of the dataset.

See:

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

namespace

The namespace of the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html#cfn-scn-dataset-namespace

partition_spec

The partition specification of the dataset.

See:

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

schema

The schema of the dataset.

See:

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

tags

The tags for the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html#cfn-scn-dataset-tags