CfnDataset

class aws_cdk.aws_iotanalytics.CfnDataset(scope, id, *, actions, content_delivery_rules=None, dataset_name=None, late_data_rules=None, retention_period=None, tags=None, triggers=None, versioning_configuration=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::IoTAnalytics::Dataset.

CloudformationResource

AWS::IoTAnalytics::Dataset

Link

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

Create a new AWS::IoTAnalytics::Dataset.

Parameters

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_depends_on(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_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

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:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
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"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate 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.

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 resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

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

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::Dataset'
actions

AWS::IoTAnalytics::Dataset.Actions.

Link

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

Return type

Union[IResolvable, List[Union[ActionProperty, IResolvable]]]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

content_delivery_rules

AWS::IoTAnalytics::Dataset.ContentDeliveryRules.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, DatasetContentDeliveryRuleProperty]], None]

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.

Return type

List[str]

dataset_name

AWS::IoTAnalytics::Dataset.DatasetName.

Link

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

Return type

Optional[str]

late_data_rules

AWS::IoTAnalytics::Dataset.LateDataRules.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, LateDataRuleProperty]], None]

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

Return type

str

Returns

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

node

The construct tree node associated with this construct.

Return type

ConstructNode

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

Return type

str

retention_period

AWS::IoTAnalytics::Dataset.RetentionPeriod.

Link

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

Return type

Union[IResolvable, RetentionPeriodProperty, None]

stack

The stack in which this element is defined.

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

Return type

Stack

tags

AWS::IoTAnalytics::Dataset.Tags.

Link

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

Return type

TagManager

triggers

AWS::IoTAnalytics::Dataset.Triggers.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, TriggerProperty]], None]

versioning_configuration

AWS::IoTAnalytics::Dataset.VersioningConfiguration.

Link

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

Return type

Union[IResolvable, VersioningConfigurationProperty, None]

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(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ActionProperty

class CfnDataset.ActionProperty(*, action_name, container_action=None, query_action=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html

Attributes

action_name

CfnDataset.ActionProperty.ActionName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-actionname

Return type

str

container_action

CfnDataset.ActionProperty.ContainerAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-containeraction

Return type

Union[IResolvable, ContainerActionProperty, None]

query_action

CfnDataset.ActionProperty.QueryAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-queryaction

Return type

Union[IResolvable, QueryActionProperty, None]

ContainerActionProperty

class CfnDataset.ContainerActionProperty(*, execution_role_arn, image, resource_configuration, variables=None)

Bases: object

Parameters
  • execution_role_arn (str) – CfnDataset.ContainerActionProperty.ExecutionRoleArn.

  • image (str) – CfnDataset.ContainerActionProperty.Image.

  • resource_configuration (Union[IResolvable, ResourceConfigurationProperty]) – CfnDataset.ContainerActionProperty.ResourceConfiguration.

  • variables (Union[IResolvable, Sequence[Union[IResolvable, VariableProperty]], None]) – CfnDataset.ContainerActionProperty.Variables.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html

Attributes

execution_role_arn

CfnDataset.ContainerActionProperty.ExecutionRoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-executionrolearn

Return type

str

image

CfnDataset.ContainerActionProperty.Image.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-image

Return type

str

resource_configuration

CfnDataset.ContainerActionProperty.ResourceConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-resourceconfiguration

Return type

Union[IResolvable, ResourceConfigurationProperty]

variables

CfnDataset.ContainerActionProperty.Variables.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-variables

Return type

Union[IResolvable, List[Union[IResolvable, VariableProperty]], None]

DatasetContentDeliveryRuleDestinationProperty

class CfnDataset.DatasetContentDeliveryRuleDestinationProperty(*, iot_events_destination_configuration=None, s3_destination_configuration=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html

Attributes

iot_events_destination_configuration

CfnDataset.DatasetContentDeliveryRuleDestinationProperty.IotEventsDestinationConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-ioteventsdestinationconfiguration

Return type

Union[IResolvable, IotEventsDestinationConfigurationProperty, None]

s3_destination_configuration

CfnDataset.DatasetContentDeliveryRuleDestinationProperty.S3DestinationConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-s3destinationconfiguration

Return type

Union[IResolvable, S3DestinationConfigurationProperty, None]

DatasetContentDeliveryRuleProperty

class CfnDataset.DatasetContentDeliveryRuleProperty(*, destination, entry_name=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html

Attributes

destination

CfnDataset.DatasetContentDeliveryRuleProperty.Destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-destination

Return type

Union[IResolvable, DatasetContentDeliveryRuleDestinationProperty]

entry_name

CfnDataset.DatasetContentDeliveryRuleProperty.EntryName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-entryname

Return type

Optional[str]

DatasetContentVersionValueProperty

class CfnDataset.DatasetContentVersionValueProperty(*, dataset_name=None)

Bases: object

Parameters

dataset_name (Optional[str]) – CfnDataset.DatasetContentVersionValueProperty.DatasetName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-datasetcontentversionvalue.html

Attributes

dataset_name

CfnDataset.DatasetContentVersionValueProperty.DatasetName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-datasetcontentversionvalue.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue-datasetname

Return type

Optional[str]

DeltaTimeProperty

class CfnDataset.DeltaTimeProperty(*, offset_seconds, time_expression)

Bases: object

Parameters
  • offset_seconds (Union[int, float]) – CfnDataset.DeltaTimeProperty.OffsetSeconds.

  • time_expression (str) – CfnDataset.DeltaTimeProperty.TimeExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html

Attributes

offset_seconds

CfnDataset.DeltaTimeProperty.OffsetSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-offsetseconds

Return type

Union[int, float]

time_expression

CfnDataset.DeltaTimeProperty.TimeExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-timeexpression

Return type

str

DeltaTimeSessionWindowConfigurationProperty

class CfnDataset.DeltaTimeSessionWindowConfigurationProperty(*, timeout_in_minutes)

Bases: object

Parameters

timeout_in_minutes (Union[int, float]) – CfnDataset.DeltaTimeSessionWindowConfigurationProperty.TimeoutInMinutes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.html

Attributes

timeout_in_minutes

CfnDataset.DeltaTimeSessionWindowConfigurationProperty.TimeoutInMinutes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.html#cfn-iotanalytics-dataset-deltatimesessionwindowconfiguration-timeoutinminutes

Return type

Union[int, float]

FilterProperty

class CfnDataset.FilterProperty(*, delta_time=None)

Bases: object

Parameters

delta_time (Union[IResolvable, DeltaTimeProperty, None]) – CfnDataset.FilterProperty.DeltaTime.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html

Attributes

delta_time

CfnDataset.FilterProperty.DeltaTime.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html#cfn-iotanalytics-dataset-filter-deltatime

Return type

Union[IResolvable, DeltaTimeProperty, None]

GlueConfigurationProperty

class CfnDataset.GlueConfigurationProperty(*, database_name, table_name)

Bases: object

Parameters
  • database_name (str) – CfnDataset.GlueConfigurationProperty.DatabaseName.

  • table_name (str) – CfnDataset.GlueConfigurationProperty.TableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html

Attributes

database_name

CfnDataset.GlueConfigurationProperty.DatabaseName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-databasename

Return type

str

table_name

CfnDataset.GlueConfigurationProperty.TableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-tablename

Return type

str

IotEventsDestinationConfigurationProperty

class CfnDataset.IotEventsDestinationConfigurationProperty(*, input_name, role_arn)

Bases: object

Parameters
  • input_name (str) – CfnDataset.IotEventsDestinationConfigurationProperty.InputName.

  • role_arn (str) – CfnDataset.IotEventsDestinationConfigurationProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html

Attributes

input_name

CfnDataset.IotEventsDestinationConfigurationProperty.InputName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-inputname

Return type

str

role_arn

CfnDataset.IotEventsDestinationConfigurationProperty.RoleArn.

Link

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

Return type

str

LateDataRuleConfigurationProperty

class CfnDataset.LateDataRuleConfigurationProperty(*, delta_time_session_window_configuration=None)

Bases: object

Parameters

delta_time_session_window_configuration (Union[IResolvable, DeltaTimeSessionWindowConfigurationProperty, None]) – CfnDataset.LateDataRuleConfigurationProperty.DeltaTimeSessionWindowConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedataruleconfiguration.html

Attributes

delta_time_session_window_configuration

CfnDataset.LateDataRuleConfigurationProperty.DeltaTimeSessionWindowConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedataruleconfiguration.html#cfn-iotanalytics-dataset-latedataruleconfiguration-deltatimesessionwindowconfiguration

Return type

Union[IResolvable, DeltaTimeSessionWindowConfigurationProperty, None]

LateDataRuleProperty

class CfnDataset.LateDataRuleProperty(*, rule_configuration, rule_name=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html

Attributes

rule_configuration

CfnDataset.LateDataRuleProperty.RuleConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html#cfn-iotanalytics-dataset-latedatarule-ruleconfiguration

Return type

Union[IResolvable, LateDataRuleConfigurationProperty]

rule_name

CfnDataset.LateDataRuleProperty.RuleName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html#cfn-iotanalytics-dataset-latedatarule-rulename

Return type

Optional[str]

OutputFileUriValueProperty

class CfnDataset.OutputFileUriValueProperty(*, file_name=None)

Bases: object

Parameters

file_name (Optional[str]) – CfnDataset.OutputFileUriValueProperty.FileName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-outputfileurivalue.html

Attributes

file_name

CfnDataset.OutputFileUriValueProperty.FileName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable-outputfileurivalue.html#cfn-iotanalytics-dataset-variable-outputfileurivalue-filename

Return type

Optional[str]

QueryActionProperty

class CfnDataset.QueryActionProperty(*, sql_query, filters=None)

Bases: object

Parameters
  • sql_query (str) – CfnDataset.QueryActionProperty.SqlQuery.

  • filters (Union[IResolvable, Sequence[Union[IResolvable, FilterProperty]], None]) – CfnDataset.QueryActionProperty.Filters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html

Attributes

filters

CfnDataset.QueryActionProperty.Filters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-filters

Return type

Union[IResolvable, List[Union[IResolvable, FilterProperty]], None]

sql_query

CfnDataset.QueryActionProperty.SqlQuery.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-sqlquery

Return type

str

ResourceConfigurationProperty

class CfnDataset.ResourceConfigurationProperty(*, compute_type, volume_size_in_gb)

Bases: object

Parameters
  • compute_type (str) – CfnDataset.ResourceConfigurationProperty.ComputeType.

  • volume_size_in_gb (Union[int, float]) – CfnDataset.ResourceConfigurationProperty.VolumeSizeInGB.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html

Attributes

compute_type

CfnDataset.ResourceConfigurationProperty.ComputeType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-computetype

Return type

str

volume_size_in_gb

CfnDataset.ResourceConfigurationProperty.VolumeSizeInGB.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-volumesizeingb

Return type

Union[int, float]

RetentionPeriodProperty

class CfnDataset.RetentionPeriodProperty(*, number_of_days, unlimited)

Bases: object

Parameters
  • number_of_days (Union[int, float]) – CfnDataset.RetentionPeriodProperty.NumberOfDays.

  • unlimited (Union[bool, IResolvable]) – CfnDataset.RetentionPeriodProperty.Unlimited.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html

Attributes

number_of_days

CfnDataset.RetentionPeriodProperty.NumberOfDays.

Link

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

Return type

Union[int, float]

unlimited

CfnDataset.RetentionPeriodProperty.Unlimited.

Link

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

Return type

Union[bool, IResolvable]

S3DestinationConfigurationProperty

class CfnDataset.S3DestinationConfigurationProperty(*, bucket, key, role_arn, glue_configuration=None)

Bases: object

Parameters
  • bucket (str) – CfnDataset.S3DestinationConfigurationProperty.Bucket.

  • key (str) – CfnDataset.S3DestinationConfigurationProperty.Key.

  • role_arn (str) – CfnDataset.S3DestinationConfigurationProperty.RoleArn.

  • glue_configuration (Union[IResolvable, GlueConfigurationProperty, None]) – CfnDataset.S3DestinationConfigurationProperty.GlueConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html

Attributes

bucket

CfnDataset.S3DestinationConfigurationProperty.Bucket.

Link

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

Return type

str

glue_configuration

CfnDataset.S3DestinationConfigurationProperty.GlueConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-glueconfiguration

Return type

Union[IResolvable, GlueConfigurationProperty, None]

key

CfnDataset.S3DestinationConfigurationProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-key

Return type

str

role_arn

CfnDataset.S3DestinationConfigurationProperty.RoleArn.

Link

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

Return type

str

ScheduleProperty

class CfnDataset.ScheduleProperty(*, schedule_expression)

Bases: object

Parameters

schedule_expression (str) – CfnDataset.ScheduleProperty.ScheduleExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger-schedule.html

Attributes

schedule_expression

CfnDataset.ScheduleProperty.ScheduleExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger-schedule.html#cfn-iotanalytics-dataset-trigger-schedule-scheduleexpression

Return type

str

TriggerProperty

class CfnDataset.TriggerProperty(*, schedule=None, triggering_dataset=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html

Attributes

schedule

CfnDataset.TriggerProperty.Schedule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-schedule

Return type

Union[IResolvable, ScheduleProperty, None]

triggering_dataset

CfnDataset.TriggerProperty.TriggeringDataset.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-triggeringdataset

Return type

Union[IResolvable, TriggeringDatasetProperty, None]

TriggeringDatasetProperty

class CfnDataset.TriggeringDatasetProperty(*, dataset_name)

Bases: object

Parameters

dataset_name (str) – CfnDataset.TriggeringDatasetProperty.DatasetName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html

Attributes

dataset_name

CfnDataset.TriggeringDatasetProperty.DatasetName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html#cfn-iotanalytics-dataset-triggeringdataset-datasetname

Return type

str

VariableProperty

class CfnDataset.VariableProperty(*, variable_name, dataset_content_version_value=None, double_value=None, output_file_uri_value=None, string_value=None)

Bases: object

Parameters
  • variable_name (str) – CfnDataset.VariableProperty.VariableName.

  • dataset_content_version_value (Union[IResolvable, DatasetContentVersionValueProperty, None]) – CfnDataset.VariableProperty.DatasetContentVersionValue.

  • double_value (Union[int, float, None]) – CfnDataset.VariableProperty.DoubleValue.

  • output_file_uri_value (Union[IResolvable, OutputFileUriValueProperty, None]) – CfnDataset.VariableProperty.OutputFileUriValue.

  • string_value (Optional[str]) – CfnDataset.VariableProperty.StringValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html

Attributes

dataset_content_version_value

CfnDataset.VariableProperty.DatasetContentVersionValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue

Return type

Union[IResolvable, DatasetContentVersionValueProperty, None]

double_value

CfnDataset.VariableProperty.DoubleValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-doublevalue

Return type

Union[int, float, None]

output_file_uri_value

CfnDataset.VariableProperty.OutputFileUriValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-outputfileurivalue

Return type

Union[IResolvable, OutputFileUriValueProperty, None]

string_value

CfnDataset.VariableProperty.StringValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-stringvalue

Return type

Optional[str]

variable_name

CfnDataset.VariableProperty.VariableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-variablename

Return type

str

VersioningConfigurationProperty

class CfnDataset.VersioningConfigurationProperty(*, max_versions=None, unlimited=None)

Bases: object

Parameters
  • max_versions (Union[int, float, None]) – CfnDataset.VersioningConfigurationProperty.MaxVersions.

  • unlimited (Union[bool, IResolvable, None]) – CfnDataset.VersioningConfigurationProperty.Unlimited.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html

Attributes

max_versions

CfnDataset.VersioningConfigurationProperty.MaxVersions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-maxversions

Return type

Union[int, float, None]

unlimited

CfnDataset.VersioningConfigurationProperty.Unlimited.

Link

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

Return type

Union[bool, IResolvable, None]