CfnDatastore

class aws_cdk.aws_iotanalytics.CfnDatastore(scope, id, *, datastore_name=None, datastore_partitions=None, datastore_storage=None, file_format_configuration=None, retention_period=None, tags=None)

Bases: CfnResource

AWS::IoTAnalytics::Datastore resource is a repository for messages.

For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html

CloudformationResource:

AWS::IoTAnalytics::Datastore

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_iotanalytics as iotanalytics

# json_configuration: Any
# service_managed_s3: Any

cfn_datastore = iotanalytics.CfnDatastore(self, "MyCfnDatastore",
    datastore_name="datastoreName",
    datastore_partitions=iotanalytics.CfnDatastore.DatastorePartitionsProperty(
        partitions=[iotanalytics.CfnDatastore.DatastorePartitionProperty(
            partition=iotanalytics.CfnDatastore.PartitionProperty(
                attribute_name="attributeName"
            ),
            timestamp_partition=iotanalytics.CfnDatastore.TimestampPartitionProperty(
                attribute_name="attributeName",

                # the properties below are optional
                timestamp_format="timestampFormat"
            )
        )]
    ),
    datastore_storage=iotanalytics.CfnDatastore.DatastoreStorageProperty(
        customer_managed_s3=iotanalytics.CfnDatastore.CustomerManagedS3Property(
            bucket="bucket",
            role_arn="roleArn",

            # the properties below are optional
            key_prefix="keyPrefix"
        ),
        iot_site_wise_multi_layer_storage=iotanalytics.CfnDatastore.IotSiteWiseMultiLayerStorageProperty(
            customer_managed_s3_storage=iotanalytics.CfnDatastore.CustomerManagedS3StorageProperty(
                bucket="bucket",

                # the properties below are optional
                key_prefix="keyPrefix"
            )
        ),
        service_managed_s3=service_managed_s3
    ),
    file_format_configuration=iotanalytics.CfnDatastore.FileFormatConfigurationProperty(
        json_configuration=json_configuration,
        parquet_configuration=iotanalytics.CfnDatastore.ParquetConfigurationProperty(
            schema_definition=iotanalytics.CfnDatastore.SchemaDefinitionProperty(
                columns=[iotanalytics.CfnDatastore.ColumnProperty(
                    name="name",
                    type="type"
                )]
            )
        )
    ),
    retention_period=iotanalytics.CfnDatastore.RetentionPeriodProperty(
        number_of_days=123,
        unlimited=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • datastore_name (Optional[str]) – The name of the data store.

  • datastore_partitions (Union[IResolvable, DatastorePartitionsProperty, Dict[str, Any], None]) – Information about the partition dimensions in a data store.

  • datastore_storage (Union[IResolvable, DatastoreStorageProperty, Dict[str, Any], None]) – Where data store data is stored.

  • file_format_configuration (Union[IResolvable, FileFormatConfigurationProperty, Dict[str, Any], None]) – Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet . The default file format is JSON. You can specify only one format. You can’t change the file format after you create the data store.

  • retention_period (Union[IResolvable, RetentionPeriodProperty, Dict[str, Any], None]) – How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata which can be used to manage the data store. For more information, see Tag .

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)

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.

Parameters:

target (CfnResource) –

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.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

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

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

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 this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[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)

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:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTAnalytics::Datastore'
attr_id

Id

Type:

cloudformationAttribute

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.

datastore_name

The name of the data store.

datastore_partitions

Information about the partition dimensions in a data store.

datastore_storage

Where data store data is stored.

file_format_configuration

Contains the configuration information of file formats.

AWS IoT Analytics data stores support JSON and Parquet .

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.

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 }).

retention_period

How long, in days, message data is kept for the data store.

stack

The stack in which this element is defined.

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

tags

Tag Manager which manages the tags for this resource.

tags_raw

Metadata which can be used to manage the data store.

Static Methods

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.

ColumnProperty

class CfnDatastore.ColumnProperty(*, name, type)

Bases: object

Contains information about a column that stores your data.

Parameters:

  • name (str) – The name of the column.

  • type (str) – The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.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_iotanalytics as iotanalytics

column_property = iotanalytics.CfnDatastore.ColumnProperty(
    name="name",
    type="type"
)

Attributes

name

The name of the column.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.html#cfn-iotanalytics-datastore-column-name

type

The type of data.

For more information about the supported data types, see Common data types in the AWS Glue Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.html#cfn-iotanalytics-datastore-column-type

CustomerManagedS3Property

class CfnDatastore.CustomerManagedS3Property(*, bucket, role_arn, key_prefix=None)

Bases: object

S3-customer-managed;

When you choose customer-managed storage, the retentionPeriod parameter is ignored. You can’t change the choice of Amazon S3 storage after your data store is created.

Parameters:

  • bucket (str) – The name of the Amazon S3 bucket where your data is stored.

  • role_arn (str) – The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

  • key_prefix (Optional[str]) – (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.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_iotanalytics as iotanalytics

customer_managed_s3_property = iotanalytics.CfnDatastore.CustomerManagedS3Property(
    bucket="bucket",
    role_arn="roleArn",

    # the properties below are optional
    key_prefix="keyPrefix"
)

Attributes

bucket

The name of the Amazon S3 bucket where your data is stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-bucket

key_prefix

(Optional) The prefix used to create the keys of the data store data objects.

Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-keyprefix

role_arn

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-rolearn

CustomerManagedS3StorageProperty

class CfnDatastore.CustomerManagedS3StorageProperty(*, bucket, key_prefix=None)

Bases: object

Amazon S3 -customer-managed;

When you choose customer-managed storage, the retentionPeriod parameter is ignored. You can’t change the choice of Amazon S3 storage after your data store is created.

Parameters:

  • bucket (str) – The name of the Amazon S3 bucket where your data is stored.

  • key_prefix (Optional[str]) – (Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.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_iotanalytics as iotanalytics

customer_managed_s3_storage_property = iotanalytics.CfnDatastore.CustomerManagedS3StorageProperty(
    bucket="bucket",

    # the properties below are optional
    key_prefix="keyPrefix"
)

Attributes

bucket

The name of the Amazon S3 bucket where your data is stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.html#cfn-iotanalytics-datastore-customermanageds3storage-bucket

key_prefix

(Optional) The prefix used to create the keys of the data store data objects.

Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.html#cfn-iotanalytics-datastore-customermanageds3storage-keyprefix

DatastorePartitionProperty

class CfnDatastore.DatastorePartitionProperty(*, partition=None, timestamp_partition=None)

Bases: object

A single dimension to partition a data store.

The dimension must be an AttributePartition or a TimestampPartition .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.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_iotanalytics as iotanalytics

datastore_partition_property = iotanalytics.CfnDatastore.DatastorePartitionProperty(
    partition=iotanalytics.CfnDatastore.PartitionProperty(
        attribute_name="attributeName"
    ),
    timestamp_partition=iotanalytics.CfnDatastore.TimestampPartitionProperty(
        attribute_name="attributeName",

        # the properties below are optional
        timestamp_format="timestampFormat"
    )
)

Attributes

partition

A partition dimension defined by an attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.html#cfn-iotanalytics-datastore-datastorepartition-partition

timestamp_partition

A partition dimension defined by a timestamp attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.html#cfn-iotanalytics-datastore-datastorepartition-timestamppartition

DatastorePartitionsProperty

class CfnDatastore.DatastorePartitionsProperty(*, partitions=None)

Bases: object

Information about the partition dimensions in a data store.

Parameters:

partitions (Union[IResolvable, Sequence[Union[IResolvable, DatastorePartitionProperty, Dict[str, Any]]], None]) – A list of partition dimensions in a data store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartitions.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_iotanalytics as iotanalytics

datastore_partitions_property = iotanalytics.CfnDatastore.DatastorePartitionsProperty(
    partitions=[iotanalytics.CfnDatastore.DatastorePartitionProperty(
        partition=iotanalytics.CfnDatastore.PartitionProperty(
            attribute_name="attributeName"
        ),
        timestamp_partition=iotanalytics.CfnDatastore.TimestampPartitionProperty(
            attribute_name="attributeName",

            # the properties below are optional
            timestamp_format="timestampFormat"
        )
    )]
)

Attributes

partitions

A list of partition dimensions in a data store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartitions.html#cfn-iotanalytics-datastore-datastorepartitions-partitions

DatastoreStorageProperty

class CfnDatastore.DatastoreStorageProperty(*, customer_managed_s3=None, iot_site_wise_multi_layer_storage=None, service_managed_s3=None)

Bases: object

Where data store data is stored.

Parameters:

  • customer_managed_s3 (Union[IResolvable, CustomerManagedS3Property, Dict[str, Any], None]) – Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

  • iot_site_wise_multi_layer_storage (Union[IResolvable, IotSiteWiseMultiLayerStorageProperty, Dict[str, Any], None]) – Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can’t change the choice of Amazon S3 storage after your data store is created.

  • service_managed_s3 (Optional[Any]) – Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.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_iotanalytics as iotanalytics

# service_managed_s3: Any

datastore_storage_property = iotanalytics.CfnDatastore.DatastoreStorageProperty(
    customer_managed_s3=iotanalytics.CfnDatastore.CustomerManagedS3Property(
        bucket="bucket",
        role_arn="roleArn",

        # the properties below are optional
        key_prefix="keyPrefix"
    ),
    iot_site_wise_multi_layer_storage=iotanalytics.CfnDatastore.IotSiteWiseMultiLayerStorageProperty(
        customer_managed_s3_storage=iotanalytics.CfnDatastore.CustomerManagedS3StorageProperty(
            bucket="bucket",

            # the properties below are optional
            key_prefix="keyPrefix"
        )
    ),
    service_managed_s3=service_managed_s3
)

Attributes

customer_managed_s3

Use this to store data store data in an S3 bucket that you manage.

The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-customermanageds3

iot_site_wise_multi_layer_storage

Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.

You can’t change the choice of Amazon S3 storage after your data store is created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-iotsitewisemultilayerstorage

service_managed_s3

Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service.

The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-servicemanageds3

FileFormatConfigurationProperty

class CfnDatastore.FileFormatConfigurationProperty(*, json_configuration=None, parquet_configuration=None)

Bases: object

Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet .

The default file format is JSON. You can specify only one format.

You can’t change the file format after you create the data store.

Parameters:

  • json_configuration (Optional[Any]) – Contains the configuration information of the JSON format.

  • parquet_configuration (Union[IResolvable, ParquetConfigurationProperty, Dict[str, Any], None]) – Contains the configuration information of the Parquet format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.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_iotanalytics as iotanalytics

# json_configuration: Any

file_format_configuration_property = iotanalytics.CfnDatastore.FileFormatConfigurationProperty(
    json_configuration=json_configuration,
    parquet_configuration=iotanalytics.CfnDatastore.ParquetConfigurationProperty(
        schema_definition=iotanalytics.CfnDatastore.SchemaDefinitionProperty(
            columns=[iotanalytics.CfnDatastore.ColumnProperty(
                name="name",
                type="type"
            )]
        )
    )
)

Attributes

json_configuration

Contains the configuration information of the JSON format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.html#cfn-iotanalytics-datastore-fileformatconfiguration-jsonconfiguration

parquet_configuration

Contains the configuration information of the Parquet format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.html#cfn-iotanalytics-datastore-fileformatconfiguration-parquetconfiguration

IotSiteWiseMultiLayerStorageProperty

class CfnDatastore.IotSiteWiseMultiLayerStorageProperty(*, customer_managed_s3_storage=None)

Bases: object

Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.

You can’t change the choice of Amazon S3 storage after your data store is created.

Parameters:

customer_managed_s3_storage (Union[IResolvable, CustomerManagedS3StorageProperty, Dict[str, Any], None]) – Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-iotsitewisemultilayerstorage.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_iotanalytics as iotanalytics

iot_site_wise_multi_layer_storage_property = iotanalytics.CfnDatastore.IotSiteWiseMultiLayerStorageProperty(
    customer_managed_s3_storage=iotanalytics.CfnDatastore.CustomerManagedS3StorageProperty(
        bucket="bucket",

        # the properties below are optional
        key_prefix="keyPrefix"
    )
)

Attributes

customer_managed_s3_storage

Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-iotsitewisemultilayerstorage.html#cfn-iotanalytics-datastore-iotsitewisemultilayerstorage-customermanageds3storage

ParquetConfigurationProperty

class CfnDatastore.ParquetConfigurationProperty(*, schema_definition=None)

Bases: object

Contains the configuration information of the Parquet format.

Parameters:

schema_definition (Union[IResolvable, SchemaDefinitionProperty, Dict[str, Any], None]) – Information needed to define a schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-parquetconfiguration.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_iotanalytics as iotanalytics

parquet_configuration_property = iotanalytics.CfnDatastore.ParquetConfigurationProperty(
    schema_definition=iotanalytics.CfnDatastore.SchemaDefinitionProperty(
        columns=[iotanalytics.CfnDatastore.ColumnProperty(
            name="name",
            type="type"
        )]
    )
)

Attributes

schema_definition

Information needed to define a schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-parquetconfiguration.html#cfn-iotanalytics-datastore-parquetconfiguration-schemadefinition

PartitionProperty

class CfnDatastore.PartitionProperty(*, attribute_name)

Bases: object

A single dimension to partition a data store.

The dimension must be an AttributePartition or a TimestampPartition .

Parameters:

attribute_name (str) – The name of the attribute that defines a partition dimension.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-partition.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_iotanalytics as iotanalytics

partition_property = iotanalytics.CfnDatastore.PartitionProperty(
    attribute_name="attributeName"
)

Attributes

attribute_name

The name of the attribute that defines a partition dimension.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-partition.html#cfn-iotanalytics-datastore-partition-attributename

RetentionPeriodProperty

class CfnDatastore.RetentionPeriodProperty(*, number_of_days=None, unlimited=None)

Bases: object

How long, in days, message data is kept.

Parameters:

  • number_of_days (Union[int, float, None]) – The number of days that message data is kept. The unlimited parameter must be false.

  • unlimited (Union[bool, IResolvable, None]) – If true, message data is kept indefinitely.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.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_iotanalytics as iotanalytics

retention_period_property = iotanalytics.CfnDatastore.RetentionPeriodProperty(
    number_of_days=123,
    unlimited=False
)

Attributes

number_of_days

The number of days that message data is kept.

The unlimited parameter must be false.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-numberofdays

unlimited

If true, message data is kept indefinitely.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-unlimited

SchemaDefinitionProperty

class CfnDatastore.SchemaDefinitionProperty(*, columns=None)

Bases: object

Information needed to define a schema.

Parameters:

columns (Union[IResolvable, Sequence[Union[IResolvable, ColumnProperty, Dict[str, Any]]], None]) – Specifies one or more columns that store your data. Each schema can have up to 100 columns. Each column can have up to 100 nested types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-schemadefinition.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_iotanalytics as iotanalytics

schema_definition_property = iotanalytics.CfnDatastore.SchemaDefinitionProperty(
    columns=[iotanalytics.CfnDatastore.ColumnProperty(
        name="name",
        type="type"
    )]
)

Attributes

columns

Specifies one or more columns that store your data.

Each schema can have up to 100 columns. Each column can have up to 100 nested types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-schemadefinition.html#cfn-iotanalytics-datastore-schemadefinition-columns

TimestampPartitionProperty

class CfnDatastore.TimestampPartitionProperty(*, attribute_name, timestamp_format=None)

Bases: object

A partition dimension defined by a timestamp attribute.

Parameters:

  • attribute_name (str) – The attribute name of the partition defined by a timestamp.

  • timestamp_format (Optional[str]) – The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.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_iotanalytics as iotanalytics

timestamp_partition_property = iotanalytics.CfnDatastore.TimestampPartitionProperty(
    attribute_name="attributeName",

    # the properties below are optional
    timestamp_format="timestampFormat"
)

Attributes

attribute_name

The attribute name of the partition defined by a timestamp.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.html#cfn-iotanalytics-datastore-timestamppartition-attributename

timestamp_format

The timestamp format of a partition defined by a timestamp.

The default format is seconds since epoch (January 1, 1970 at midnight UTC time).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.html#cfn-iotanalytics-datastore-timestamppartition-timestampformat