CfnDatasetProps

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

Bases: object

Properties for defining a CfnDataset.

Parameters:

instance_id (str) – The Amazon Web Services Supply Chain instance identifier.
name (str) – The name of the dataset.
namespace (str) – The namespace of the dataset.
description (Optional[str]) – The description 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 import aws_scn as scn

cfn_dataset_props = scn.CfnDatasetProps(
    instance_id="instanceId",
    name="name",
    namespace="namespace",

    # the properties below are optional
    description="description",
    partition_spec=scn.CfnDataset.PartitionSpecProperty(
        fields=[scn.CfnDataset.DataLakeDatasetPartitionFieldProperty(
            name="name",
            transform=scn.CfnDataset.TransformProperty(
                type="type"
            )
        )]
    ),
    schema=scn.CfnDataset.SchemaProperty(
        fields=[scn.CfnDataset.DataLakeDatasetSchemaFieldProperty(
            is_required=False,
            name="name",
            type="type"
        )],
        name="name",

        # the properties below are optional
        primary_keys=[scn.CfnDataset.DataLakeDatasetPrimaryKeyFieldProperty(
            name="name"
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)