CfnDetectorModel

class aws_cdk.aws_iotevents.CfnDetectorModel(scope, id, *, detector_model_definition, role_arn, detector_model_description=None, detector_model_name=None, evaluation_method=None, key=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::IoTEvents::DetectorModel.

CloudformationResource

AWS::IoTEvents::DetectorModel

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html

Create a new AWS::IoTEvents::DetectorModel.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • detector_model_definition (Union[DetectorModelDefinitionProperty, IResolvable]) – AWS::IoTEvents::DetectorModel.DetectorModelDefinition.

  • role_arn (str) – AWS::IoTEvents::DetectorModel.RoleArn.

  • detector_model_description (Optional[str]) – AWS::IoTEvents::DetectorModel.DetectorModelDescription.

  • detector_model_name (Optional[str]) – AWS::IoTEvents::DetectorModel.DetectorModelName.

  • evaluation_method (Optional[str]) – AWS::IoTEvents::DetectorModel.EvaluationMethod.

  • key (Optional[str]) – AWS::IoTEvents::DetectorModel.Key.

  • tags (Optional[Sequence[CfnTag]]) – AWS::IoTEvents::DetectorModel.Tags.

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)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

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::IoTEvents::DetectorModel'
cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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]

detector_model_definition

AWS::IoTEvents::DetectorModel.DetectorModelDefinition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldefinition

Return type

Union[DetectorModelDefinitionProperty, IResolvable]

detector_model_description

AWS::IoTEvents::DetectorModel.DetectorModelDescription.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldescription

Return type

Optional[str]

detector_model_name

AWS::IoTEvents::DetectorModel.DetectorModelName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodelname

Return type

Optional[str]

evaluation_method

AWS::IoTEvents::DetectorModel.EvaluationMethod.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-evaluationmethod

Return type

Optional[str]

key

AWS::IoTEvents::DetectorModel.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-key

Return type

Optional[str]

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

role_arn

AWS::IoTEvents::DetectorModel.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-rolearn

Return type

str

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::IoTEvents::DetectorModel.Tags.

Link

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

Return type

TagManager

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 CfnDetectorModel.ActionProperty(*, clear_timer=None, dynamo_db=None, dynamo_d_bv2=None, firehose=None, iot_events=None, iot_site_wise=None, iot_topic_publish=None, lambda_=None, reset_timer=None, set_timer=None, set_variable=None, sns=None, sqs=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html

Attributes

clear_timer

CfnDetectorModel.ActionProperty.ClearTimer.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-cleartimer

Return type

Union[IResolvable, ClearTimerProperty, None]

dynamo_d_bv2

CfnDetectorModel.ActionProperty.DynamoDBv2.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-dynamodbv2

Return type

Union[IResolvable, DynamoDBv2Property, None]

dynamo_db

CfnDetectorModel.ActionProperty.DynamoDB.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-dynamodb

Return type

Union[IResolvable, DynamoDBProperty, None]

firehose

CfnDetectorModel.ActionProperty.Firehose.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-firehose

Return type

Union[IResolvable, FirehoseProperty, None]

iot_events

CfnDetectorModel.ActionProperty.IotEvents.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iotevents

Return type

Union[IResolvable, IotEventsProperty, None]

iot_site_wise

CfnDetectorModel.ActionProperty.IotSiteWise.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iotsitewise

Return type

Union[IResolvable, IotSiteWiseProperty, None]

iot_topic_publish

CfnDetectorModel.ActionProperty.IotTopicPublish.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iottopicpublish

Return type

Union[IResolvable, IotTopicPublishProperty, None]

lambda_

CfnDetectorModel.ActionProperty.Lambda.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-lambda

Return type

Union[IResolvable, LambdaProperty, None]

reset_timer

CfnDetectorModel.ActionProperty.ResetTimer.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-resettimer

Return type

Union[IResolvable, ResetTimerProperty, None]

set_timer

CfnDetectorModel.ActionProperty.SetTimer.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-settimer

Return type

Union[IResolvable, SetTimerProperty, None]

set_variable

CfnDetectorModel.ActionProperty.SetVariable.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-setvariable

Return type

Union[IResolvable, SetVariableProperty, None]

sns

CfnDetectorModel.ActionProperty.Sns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-sns

Return type

Union[IResolvable, SnsProperty, None]

sqs

CfnDetectorModel.ActionProperty.Sqs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-sqs

Return type

Union[IResolvable, SqsProperty, None]

AssetPropertyTimestampProperty

class CfnDetectorModel.AssetPropertyTimestampProperty(*, time_in_seconds, offset_in_nanos=None)

Bases: object

Parameters
  • time_in_seconds (str) – CfnDetectorModel.AssetPropertyTimestampProperty.TimeInSeconds.

  • offset_in_nanos (Optional[str]) – CfnDetectorModel.AssetPropertyTimestampProperty.OffsetInNanos.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html

Attributes

offset_in_nanos

CfnDetectorModel.AssetPropertyTimestampProperty.OffsetInNanos.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html#cfn-iotevents-detectormodel-assetpropertytimestamp-offsetinnanos

Return type

Optional[str]

time_in_seconds

CfnDetectorModel.AssetPropertyTimestampProperty.TimeInSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html#cfn-iotevents-detectormodel-assetpropertytimestamp-timeinseconds

Return type

str

AssetPropertyValueProperty

class CfnDetectorModel.AssetPropertyValueProperty(*, value, quality=None, timestamp=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html

Attributes

quality

CfnDetectorModel.AssetPropertyValueProperty.Quality.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-quality

Return type

Optional[str]

timestamp

CfnDetectorModel.AssetPropertyValueProperty.Timestamp.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-timestamp

Return type

Union[IResolvable, AssetPropertyTimestampProperty, None]

value

CfnDetectorModel.AssetPropertyValueProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-value

Return type

Union[IResolvable, AssetPropertyVariantProperty]

AssetPropertyVariantProperty

class CfnDetectorModel.AssetPropertyVariantProperty(*, boolean_value=None, double_value=None, integer_value=None, string_value=None)

Bases: object

Parameters
  • boolean_value (Optional[str]) – CfnDetectorModel.AssetPropertyVariantProperty.BooleanValue.

  • double_value (Optional[str]) – CfnDetectorModel.AssetPropertyVariantProperty.DoubleValue.

  • integer_value (Optional[str]) – CfnDetectorModel.AssetPropertyVariantProperty.IntegerValue.

  • string_value (Optional[str]) – CfnDetectorModel.AssetPropertyVariantProperty.StringValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html

Attributes

boolean_value

CfnDetectorModel.AssetPropertyVariantProperty.BooleanValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-booleanvalue

Return type

Optional[str]

double_value

CfnDetectorModel.AssetPropertyVariantProperty.DoubleValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-doublevalue

Return type

Optional[str]

integer_value

CfnDetectorModel.AssetPropertyVariantProperty.IntegerValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-integervalue

Return type

Optional[str]

string_value

CfnDetectorModel.AssetPropertyVariantProperty.StringValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-stringvalue

Return type

Optional[str]

ClearTimerProperty

class CfnDetectorModel.ClearTimerProperty(*, timer_name)

Bases: object

Parameters

timer_name (str) – CfnDetectorModel.ClearTimerProperty.TimerName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-cleartimer.html

Attributes

timer_name

CfnDetectorModel.ClearTimerProperty.TimerName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-cleartimer.html#cfn-iotevents-detectormodel-cleartimer-timername

Return type

str

DetectorModelDefinitionProperty

class CfnDetectorModel.DetectorModelDefinitionProperty(*, initial_state_name, states)

Bases: object

Parameters
  • initial_state_name (str) – CfnDetectorModel.DetectorModelDefinitionProperty.InitialStateName.

  • states (Union[IResolvable, Sequence[Union[IResolvable, StateProperty]]]) – CfnDetectorModel.DetectorModelDefinitionProperty.States.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html

Attributes

initial_state_name

CfnDetectorModel.DetectorModelDefinitionProperty.InitialStateName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html#cfn-iotevents-detectormodel-detectormodeldefinition-initialstatename

Return type

str

states

CfnDetectorModel.DetectorModelDefinitionProperty.States.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html#cfn-iotevents-detectormodel-detectormodeldefinition-states

Return type

Union[IResolvable, List[Union[IResolvable, StateProperty]]]

DynamoDBProperty

class CfnDetectorModel.DynamoDBProperty(*, hash_key_field, hash_key_value, table_name, hash_key_type=None, operation=None, payload=None, payload_field=None, range_key_field=None, range_key_type=None, range_key_value=None)

Bases: object

Parameters
  • hash_key_field (str) – CfnDetectorModel.DynamoDBProperty.HashKeyField.

  • hash_key_value (str) – CfnDetectorModel.DynamoDBProperty.HashKeyValue.

  • table_name (str) – CfnDetectorModel.DynamoDBProperty.TableName.

  • hash_key_type (Optional[str]) – CfnDetectorModel.DynamoDBProperty.HashKeyType.

  • operation (Optional[str]) – CfnDetectorModel.DynamoDBProperty.Operation.

  • payload (Union[IResolvable, PayloadProperty, None]) – CfnDetectorModel.DynamoDBProperty.Payload.

  • payload_field (Optional[str]) – CfnDetectorModel.DynamoDBProperty.PayloadField.

  • range_key_field (Optional[str]) – CfnDetectorModel.DynamoDBProperty.RangeKeyField.

  • range_key_type (Optional[str]) – CfnDetectorModel.DynamoDBProperty.RangeKeyType.

  • range_key_value (Optional[str]) – CfnDetectorModel.DynamoDBProperty.RangeKeyValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html

Attributes

hash_key_field

CfnDetectorModel.DynamoDBProperty.HashKeyField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeyfield

Return type

str

hash_key_type

CfnDetectorModel.DynamoDBProperty.HashKeyType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeytype

Return type

Optional[str]

hash_key_value

CfnDetectorModel.DynamoDBProperty.HashKeyValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeyvalue

Return type

str

operation

CfnDetectorModel.DynamoDBProperty.Operation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-operation

Return type

Optional[str]

payload

CfnDetectorModel.DynamoDBProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-payload

Return type

Union[IResolvable, PayloadProperty, None]

payload_field

CfnDetectorModel.DynamoDBProperty.PayloadField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-payloadfield

Return type

Optional[str]

range_key_field

CfnDetectorModel.DynamoDBProperty.RangeKeyField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeyfield

Return type

Optional[str]

range_key_type

CfnDetectorModel.DynamoDBProperty.RangeKeyType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeytype

Return type

Optional[str]

range_key_value

CfnDetectorModel.DynamoDBProperty.RangeKeyValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeyvalue

Return type

Optional[str]

table_name

CfnDetectorModel.DynamoDBProperty.TableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-tablename

Return type

str

DynamoDBv2Property

class CfnDetectorModel.DynamoDBv2Property(*, table_name, payload=None)

Bases: object

Parameters
  • table_name (str) – CfnDetectorModel.DynamoDBv2Property.TableName.

  • payload (Union[IResolvable, PayloadProperty, None]) – CfnDetectorModel.DynamoDBv2Property.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html

Attributes

payload

CfnDetectorModel.DynamoDBv2Property.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html#cfn-iotevents-detectormodel-dynamodbv2-payload

Return type

Union[IResolvable, PayloadProperty, None]

table_name

CfnDetectorModel.DynamoDBv2Property.TableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html#cfn-iotevents-detectormodel-dynamodbv2-tablename

Return type

str

EventProperty

class CfnDetectorModel.EventProperty(*, event_name, actions=None, condition=None)

Bases: object

Parameters
  • event_name (str) – CfnDetectorModel.EventProperty.EventName.

  • actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty]], None]) – CfnDetectorModel.EventProperty.Actions.

  • condition (Optional[str]) – CfnDetectorModel.EventProperty.Condition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html

Attributes

actions

CfnDetectorModel.EventProperty.Actions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-actions

Return type

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

condition

CfnDetectorModel.EventProperty.Condition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-condition

Return type

Optional[str]

event_name

CfnDetectorModel.EventProperty.EventName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-eventname

Return type

str

FirehoseProperty

class CfnDetectorModel.FirehoseProperty(*, delivery_stream_name, payload=None, separator=None)

Bases: object

Parameters
  • delivery_stream_name (str) – CfnDetectorModel.FirehoseProperty.DeliveryStreamName.

  • payload (Union[IResolvable, PayloadProperty, None]) – CfnDetectorModel.FirehoseProperty.Payload.

  • separator (Optional[str]) – CfnDetectorModel.FirehoseProperty.Separator.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html

Attributes

delivery_stream_name

CfnDetectorModel.FirehoseProperty.DeliveryStreamName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-deliverystreamname

Return type

str

payload

CfnDetectorModel.FirehoseProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-payload

Return type

Union[IResolvable, PayloadProperty, None]

separator

CfnDetectorModel.FirehoseProperty.Separator.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-separator

Return type

Optional[str]

IotEventsProperty

class CfnDetectorModel.IotEventsProperty(*, input_name, payload=None)

Bases: object

Parameters
  • input_name (str) – CfnDetectorModel.IotEventsProperty.InputName.

  • payload (Union[IResolvable, PayloadProperty, None]) – CfnDetectorModel.IotEventsProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html

Attributes

input_name

CfnDetectorModel.IotEventsProperty.InputName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html#cfn-iotevents-detectormodel-iotevents-inputname

Return type

str

payload

CfnDetectorModel.IotEventsProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html#cfn-iotevents-detectormodel-iotevents-payload

Return type

Union[IResolvable, PayloadProperty, None]

IotSiteWiseProperty

class CfnDetectorModel.IotSiteWiseProperty(*, property_value, asset_id=None, entry_id=None, property_alias=None, property_id=None)

Bases: object

Parameters
  • property_value (Union[IResolvable, AssetPropertyValueProperty]) – CfnDetectorModel.IotSiteWiseProperty.PropertyValue.

  • asset_id (Optional[str]) – CfnDetectorModel.IotSiteWiseProperty.AssetId.

  • entry_id (Optional[str]) – CfnDetectorModel.IotSiteWiseProperty.EntryId.

  • property_alias (Optional[str]) – CfnDetectorModel.IotSiteWiseProperty.PropertyAlias.

  • property_id (Optional[str]) – CfnDetectorModel.IotSiteWiseProperty.PropertyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html

Attributes

asset_id

CfnDetectorModel.IotSiteWiseProperty.AssetId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-assetid

Return type

Optional[str]

entry_id

CfnDetectorModel.IotSiteWiseProperty.EntryId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-entryid

Return type

Optional[str]

property_alias

CfnDetectorModel.IotSiteWiseProperty.PropertyAlias.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyalias

Return type

Optional[str]

property_id

CfnDetectorModel.IotSiteWiseProperty.PropertyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyid

Return type

Optional[str]

property_value

CfnDetectorModel.IotSiteWiseProperty.PropertyValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyvalue

Return type

Union[IResolvable, AssetPropertyValueProperty]

IotTopicPublishProperty

class CfnDetectorModel.IotTopicPublishProperty(*, mqtt_topic, payload=None)

Bases: object

Parameters
  • mqtt_topic (str) – CfnDetectorModel.IotTopicPublishProperty.MqttTopic.

  • payload (Union[IResolvable, PayloadProperty, None]) – CfnDetectorModel.IotTopicPublishProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html

Attributes

mqtt_topic

CfnDetectorModel.IotTopicPublishProperty.MqttTopic.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html#cfn-iotevents-detectormodel-iottopicpublish-mqtttopic

Return type

str

payload

CfnDetectorModel.IotTopicPublishProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html#cfn-iotevents-detectormodel-iottopicpublish-payload

Return type

Union[IResolvable, PayloadProperty, None]

LambdaProperty

class CfnDetectorModel.LambdaProperty(*, function_arn, payload=None)

Bases: object

Parameters
  • function_arn (str) – CfnDetectorModel.LambdaProperty.FunctionArn.

  • payload (Union[IResolvable, PayloadProperty, None]) – CfnDetectorModel.LambdaProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html

Attributes

function_arn

CfnDetectorModel.LambdaProperty.FunctionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html#cfn-iotevents-detectormodel-lambda-functionarn

Return type

str

payload

CfnDetectorModel.LambdaProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html#cfn-iotevents-detectormodel-lambda-payload

Return type

Union[IResolvable, PayloadProperty, None]

OnEnterProperty

class CfnDetectorModel.OnEnterProperty(*, events=None)

Bases: object

Parameters

events (Union[IResolvable, Sequence[Union[IResolvable, EventProperty]], None]) – CfnDetectorModel.OnEnterProperty.Events.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html

Attributes

events

CfnDetectorModel.OnEnterProperty.Events.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html#cfn-iotevents-detectormodel-onenter-events

Return type

Union[IResolvable, List[Union[IResolvable, EventProperty]], None]

OnExitProperty

class CfnDetectorModel.OnExitProperty(*, events=None)

Bases: object

Parameters

events (Union[IResolvable, Sequence[Union[IResolvable, EventProperty]], None]) – CfnDetectorModel.OnExitProperty.Events.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html

Attributes

events

CfnDetectorModel.OnExitProperty.Events.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html#cfn-iotevents-detectormodel-onexit-events

Return type

Union[IResolvable, List[Union[IResolvable, EventProperty]], None]

OnInputProperty

class CfnDetectorModel.OnInputProperty(*, events=None, transition_events=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html

Attributes

events

CfnDetectorModel.OnInputProperty.Events.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html#cfn-iotevents-detectormodel-oninput-events

Return type

Union[IResolvable, List[Union[IResolvable, EventProperty]], None]

transition_events

CfnDetectorModel.OnInputProperty.TransitionEvents.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html#cfn-iotevents-detectormodel-oninput-transitionevents

Return type

Union[IResolvable, List[Union[IResolvable, TransitionEventProperty]], None]

PayloadProperty

class CfnDetectorModel.PayloadProperty(*, content_expression, type)

Bases: object

Parameters
  • content_expression (str) – CfnDetectorModel.PayloadProperty.ContentExpression.

  • type (str) – CfnDetectorModel.PayloadProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html

Attributes

content_expression

CfnDetectorModel.PayloadProperty.ContentExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html#cfn-iotevents-detectormodel-payload-contentexpression

Return type

str

type

CfnDetectorModel.PayloadProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html#cfn-iotevents-detectormodel-payload-type

Return type

str

ResetTimerProperty

class CfnDetectorModel.ResetTimerProperty(*, timer_name)

Bases: object

Parameters

timer_name (str) – CfnDetectorModel.ResetTimerProperty.TimerName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-resettimer.html

Attributes

timer_name

CfnDetectorModel.ResetTimerProperty.TimerName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-resettimer.html#cfn-iotevents-detectormodel-resettimer-timername

Return type

str

SetTimerProperty

class CfnDetectorModel.SetTimerProperty(*, timer_name, duration_expression=None, seconds=None)

Bases: object

Parameters
  • timer_name (str) – CfnDetectorModel.SetTimerProperty.TimerName.

  • duration_expression (Optional[str]) – CfnDetectorModel.SetTimerProperty.DurationExpression.

  • seconds (Union[int, float, None]) – CfnDetectorModel.SetTimerProperty.Seconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html

Attributes

duration_expression

CfnDetectorModel.SetTimerProperty.DurationExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-durationexpression

Return type

Optional[str]

seconds

CfnDetectorModel.SetTimerProperty.Seconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-seconds

Return type

Union[int, float, None]

timer_name

CfnDetectorModel.SetTimerProperty.TimerName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-timername

Return type

str

SetVariableProperty

class CfnDetectorModel.SetVariableProperty(*, value, variable_name)

Bases: object

Parameters
  • value (str) – CfnDetectorModel.SetVariableProperty.Value.

  • variable_name (str) – CfnDetectorModel.SetVariableProperty.VariableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html

Attributes

value

CfnDetectorModel.SetVariableProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html#cfn-iotevents-detectormodel-setvariable-value

Return type

str

variable_name

CfnDetectorModel.SetVariableProperty.VariableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html#cfn-iotevents-detectormodel-setvariable-variablename

Return type

str

SnsProperty

class CfnDetectorModel.SnsProperty(*, target_arn, payload=None)

Bases: object

Parameters
  • target_arn (str) – CfnDetectorModel.SnsProperty.TargetArn.

  • payload (Union[IResolvable, PayloadProperty, None]) – CfnDetectorModel.SnsProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html

Attributes

payload

CfnDetectorModel.SnsProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html#cfn-iotevents-detectormodel-sns-payload

Return type

Union[IResolvable, PayloadProperty, None]

target_arn

CfnDetectorModel.SnsProperty.TargetArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html#cfn-iotevents-detectormodel-sns-targetarn

Return type

str

SqsProperty

class CfnDetectorModel.SqsProperty(*, queue_url, payload=None, use_base64=None)

Bases: object

Parameters
  • queue_url (str) – CfnDetectorModel.SqsProperty.QueueUrl.

  • payload (Union[IResolvable, PayloadProperty, None]) – CfnDetectorModel.SqsProperty.Payload.

  • use_base64 (Union[bool, IResolvable, None]) – CfnDetectorModel.SqsProperty.UseBase64.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html

Attributes

payload

CfnDetectorModel.SqsProperty.Payload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-payload

Return type

Union[IResolvable, PayloadProperty, None]

queue_url

CfnDetectorModel.SqsProperty.QueueUrl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-queueurl

Return type

str

use_base64

CfnDetectorModel.SqsProperty.UseBase64.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-usebase64

Return type

Union[bool, IResolvable, None]

StateProperty

class CfnDetectorModel.StateProperty(*, state_name, on_enter=None, on_exit=None, on_input=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html

Attributes

on_enter

CfnDetectorModel.StateProperty.OnEnter.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onenter

Return type

Union[IResolvable, OnEnterProperty, None]

on_exit

CfnDetectorModel.StateProperty.OnExit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onexit

Return type

Union[IResolvable, OnExitProperty, None]

on_input

CfnDetectorModel.StateProperty.OnInput.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-oninput

Return type

Union[IResolvable, OnInputProperty, None]

state_name

CfnDetectorModel.StateProperty.StateName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-statename

Return type

str

TransitionEventProperty

class CfnDetectorModel.TransitionEventProperty(*, condition, event_name, next_state, actions=None)

Bases: object

Parameters
  • condition (str) – CfnDetectorModel.TransitionEventProperty.Condition.

  • event_name (str) – CfnDetectorModel.TransitionEventProperty.EventName.

  • next_state (str) – CfnDetectorModel.TransitionEventProperty.NextState.

  • actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty]], None]) – CfnDetectorModel.TransitionEventProperty.Actions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html

Attributes

actions

CfnDetectorModel.TransitionEventProperty.Actions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-actions

Return type

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

condition

CfnDetectorModel.TransitionEventProperty.Condition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-condition

Return type

str

event_name

CfnDetectorModel.TransitionEventProperty.EventName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-eventname

Return type

str

next_state

CfnDetectorModel.TransitionEventProperty.NextState.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-nextstate

Return type

str