CfnTopicRule

class aws_cdk.aws_iot.CfnTopicRule(scope, id, *, topic_rule_payload, rule_name=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::IoT::TopicRule.

CloudformationResource

AWS::IoT::TopicRule

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html

Create a new AWS::IoT::TopicRule.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • topic_rule_payload (Union[IResolvable, TopicRulePayloadProperty]) – AWS::IoT::TopicRule.TopicRulePayload.

  • rule_name (Optional[str]) – AWS::IoT::TopicRule.RuleName.

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::IoT::TopicRule'
attr_arn

Arn

Type

cloudformationAttribute

Return type

str

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]

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

rule_name

AWS::IoT::TopicRule.RuleName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html#cfn-iot-topicrule-rulename

Return type

Optional[str]

stack

The stack in which this element is defined.

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

Return type

Stack

topic_rule_payload

AWS::IoT::TopicRule.TopicRulePayload.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html#cfn-iot-topicrule-topicrulepayload

Return type

Union[IResolvable, TopicRulePayloadProperty]

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 CfnTopicRule.ActionProperty(*, cloudwatch_alarm=None, cloudwatch_metric=None, dynamo_db=None, dynamo_d_bv2=None, elasticsearch=None, firehose=None, http=None, iot_analytics=None, iot_events=None, iot_site_wise=None, kinesis=None, lambda_=None, republish=None, s3=None, sns=None, sqs=None, step_functions=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html

Attributes

cloudwatch_alarm

CfnTopicRule.ActionProperty.CloudwatchAlarm.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchalarm

Return type

Union[IResolvable, CloudwatchAlarmActionProperty, None]

cloudwatch_metric

CfnTopicRule.ActionProperty.CloudwatchMetric.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchmetric

Return type

Union[IResolvable, CloudwatchMetricActionProperty, None]

dynamo_d_bv2

CfnTopicRule.ActionProperty.DynamoDBv2.

Link

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

Return type

Union[IResolvable, DynamoDBv2ActionProperty, None]

dynamo_db

CfnTopicRule.ActionProperty.DynamoDB.

Link

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

Return type

Union[IResolvable, DynamoDBActionProperty, None]

elasticsearch

CfnTopicRule.ActionProperty.Elasticsearch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-elasticsearch

Return type

Union[IResolvable, ElasticsearchActionProperty, None]

firehose

CfnTopicRule.ActionProperty.Firehose.

Link

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

Return type

Union[IResolvable, FirehoseActionProperty, None]

http

CfnTopicRule.ActionProperty.Http.

Link

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

Return type

Union[IResolvable, HttpActionProperty, None]

iot_analytics

CfnTopicRule.ActionProperty.IotAnalytics.

Link

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

Return type

Union[IResolvable, IotAnalyticsActionProperty, None]

iot_events

CfnTopicRule.ActionProperty.IotEvents.

Link

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

Return type

Union[IResolvable, IotEventsActionProperty, None]

iot_site_wise

CfnTopicRule.ActionProperty.IotSiteWise.

Link

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

Return type

Union[IResolvable, IotSiteWiseActionProperty, None]

kinesis

CfnTopicRule.ActionProperty.Kinesis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-kinesis

Return type

Union[IResolvable, KinesisActionProperty, None]

lambda_

CfnTopicRule.ActionProperty.Lambda.

Link

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

Return type

Union[IResolvable, LambdaActionProperty, None]

republish

CfnTopicRule.ActionProperty.Republish.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-republish

Return type

Union[IResolvable, RepublishActionProperty, None]

s3

CfnTopicRule.ActionProperty.S3.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-s3

Return type

Union[IResolvable, S3ActionProperty, None]

sns

CfnTopicRule.ActionProperty.Sns.

Link

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

Return type

Union[IResolvable, SnsActionProperty, None]

sqs

CfnTopicRule.ActionProperty.Sqs.

Link

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

Return type

Union[IResolvable, SqsActionProperty, None]

step_functions

CfnTopicRule.ActionProperty.StepFunctions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-stepfunctions

Return type

Union[IResolvable, StepFunctionsActionProperty, None]

AssetPropertyTimestampProperty

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

Bases: object

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

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertytimestamp.html

Attributes

offset_in_nanos

CfnTopicRule.AssetPropertyTimestampProperty.OffsetInNanos.

Link

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

Return type

Optional[str]

time_in_seconds

CfnTopicRule.AssetPropertyTimestampProperty.TimeInSeconds.

Link

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

Return type

str

AssetPropertyValueProperty

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

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvalue.html

Attributes

quality

CfnTopicRule.AssetPropertyValueProperty.Quality.

Link

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

Return type

Optional[str]

timestamp

CfnTopicRule.AssetPropertyValueProperty.Timestamp.

Link

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

Return type

Union[IResolvable, AssetPropertyTimestampProperty]

value

CfnTopicRule.AssetPropertyValueProperty.Value.

Link

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

Return type

Union[IResolvable, AssetPropertyVariantProperty]

AssetPropertyVariantProperty

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

Bases: object

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

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

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

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-assetpropertyvariant.html

Attributes

boolean_value

CfnTopicRule.AssetPropertyVariantProperty.BooleanValue.

Link

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

Return type

Optional[str]

double_value

CfnTopicRule.AssetPropertyVariantProperty.DoubleValue.

Link

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

Return type

Optional[str]

integer_value

CfnTopicRule.AssetPropertyVariantProperty.IntegerValue.

Link

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

Return type

Optional[str]

string_value

CfnTopicRule.AssetPropertyVariantProperty.StringValue.

Link

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

Return type

Optional[str]

CloudwatchAlarmActionProperty

class CfnTopicRule.CloudwatchAlarmActionProperty(*, alarm_name, role_arn, state_reason, state_value)

Bases: object

Parameters
  • alarm_name (str) – CfnTopicRule.CloudwatchAlarmActionProperty.AlarmName.

  • role_arn (str) – CfnTopicRule.CloudwatchAlarmActionProperty.RoleArn.

  • state_reason (str) – CfnTopicRule.CloudwatchAlarmActionProperty.StateReason.

  • state_value (str) – CfnTopicRule.CloudwatchAlarmActionProperty.StateValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html

Attributes

alarm_name

CfnTopicRule.CloudwatchAlarmActionProperty.AlarmName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-alarmname

Return type

str

role_arn

CfnTopicRule.CloudwatchAlarmActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-rolearn

Return type

str

state_reason

CfnTopicRule.CloudwatchAlarmActionProperty.StateReason.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statereason

Return type

str

state_value

CfnTopicRule.CloudwatchAlarmActionProperty.StateValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statevalue

Return type

str

CloudwatchMetricActionProperty

class CfnTopicRule.CloudwatchMetricActionProperty(*, metric_name, metric_namespace, metric_unit, metric_value, role_arn, metric_timestamp=None)

Bases: object

Parameters
  • metric_name (str) – CfnTopicRule.CloudwatchMetricActionProperty.MetricName.

  • metric_namespace (str) – CfnTopicRule.CloudwatchMetricActionProperty.MetricNamespace.

  • metric_unit (str) – CfnTopicRule.CloudwatchMetricActionProperty.MetricUnit.

  • metric_value (str) – CfnTopicRule.CloudwatchMetricActionProperty.MetricValue.

  • role_arn (str) – CfnTopicRule.CloudwatchMetricActionProperty.RoleArn.

  • metric_timestamp (Optional[str]) – CfnTopicRule.CloudwatchMetricActionProperty.MetricTimestamp.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html

Attributes

metric_name

CfnTopicRule.CloudwatchMetricActionProperty.MetricName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricname

Return type

str

metric_namespace

CfnTopicRule.CloudwatchMetricActionProperty.MetricNamespace.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricnamespace

Return type

str

metric_timestamp

CfnTopicRule.CloudwatchMetricActionProperty.MetricTimestamp.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metrictimestamp

Return type

Optional[str]

metric_unit

CfnTopicRule.CloudwatchMetricActionProperty.MetricUnit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricunit

Return type

str

metric_value

CfnTopicRule.CloudwatchMetricActionProperty.MetricValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricvalue

Return type

str

role_arn

CfnTopicRule.CloudwatchMetricActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-rolearn

Return type

str

DynamoDBActionProperty

class CfnTopicRule.DynamoDBActionProperty(*, hash_key_field, hash_key_value, role_arn, table_name, hash_key_type=None, payload_field=None, range_key_field=None, range_key_type=None, range_key_value=None)

Bases: object

Parameters
  • hash_key_field (str) – CfnTopicRule.DynamoDBActionProperty.HashKeyField.

  • hash_key_value (str) – CfnTopicRule.DynamoDBActionProperty.HashKeyValue.

  • role_arn (str) – CfnTopicRule.DynamoDBActionProperty.RoleArn.

  • table_name (str) – CfnTopicRule.DynamoDBActionProperty.TableName.

  • hash_key_type (Optional[str]) – CfnTopicRule.DynamoDBActionProperty.HashKeyType.

  • payload_field (Optional[str]) – CfnTopicRule.DynamoDBActionProperty.PayloadField.

  • range_key_field (Optional[str]) – CfnTopicRule.DynamoDBActionProperty.RangeKeyField.

  • range_key_type (Optional[str]) – CfnTopicRule.DynamoDBActionProperty.RangeKeyType.

  • range_key_value (Optional[str]) – CfnTopicRule.DynamoDBActionProperty.RangeKeyValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html

Attributes

hash_key_field

CfnTopicRule.DynamoDBActionProperty.HashKeyField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyfield

Return type

str

hash_key_type

CfnTopicRule.DynamoDBActionProperty.HashKeyType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeytype

Return type

Optional[str]

hash_key_value

CfnTopicRule.DynamoDBActionProperty.HashKeyValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyvalue

Return type

str

payload_field

CfnTopicRule.DynamoDBActionProperty.PayloadField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-payloadfield

Return type

Optional[str]

range_key_field

CfnTopicRule.DynamoDBActionProperty.RangeKeyField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyfield

Return type

Optional[str]

range_key_type

CfnTopicRule.DynamoDBActionProperty.RangeKeyType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeytype

Return type

Optional[str]

range_key_value

CfnTopicRule.DynamoDBActionProperty.RangeKeyValue.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyvalue

Return type

Optional[str]

role_arn

CfnTopicRule.DynamoDBActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rolearn

Return type

str

table_name

CfnTopicRule.DynamoDBActionProperty.TableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-tablename

Return type

str

DynamoDBv2ActionProperty

class CfnTopicRule.DynamoDBv2ActionProperty(*, put_item=None, role_arn=None)

Bases: object

Parameters
  • put_item (Union[IResolvable, PutItemInputProperty, None]) – CfnTopicRule.DynamoDBv2ActionProperty.PutItem.

  • role_arn (Optional[str]) – CfnTopicRule.DynamoDBv2ActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html

Attributes

put_item

CfnTopicRule.DynamoDBv2ActionProperty.PutItem.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-putitem

Return type

Union[IResolvable, PutItemInputProperty, None]

role_arn

CfnTopicRule.DynamoDBv2ActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-rolearn

Return type

Optional[str]

ElasticsearchActionProperty

class CfnTopicRule.ElasticsearchActionProperty(*, endpoint, id, index, role_arn, type)

Bases: object

Parameters
  • endpoint (str) – CfnTopicRule.ElasticsearchActionProperty.Endpoint.

  • id (str) – CfnTopicRule.ElasticsearchActionProperty.Id.

  • index (str) – CfnTopicRule.ElasticsearchActionProperty.Index.

  • role_arn (str) – CfnTopicRule.ElasticsearchActionProperty.RoleArn.

  • type (str) – CfnTopicRule.ElasticsearchActionProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html

Attributes

endpoint

CfnTopicRule.ElasticsearchActionProperty.Endpoint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-endpoint

Return type

str

id

CfnTopicRule.ElasticsearchActionProperty.Id.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-id

Return type

str

index

CfnTopicRule.ElasticsearchActionProperty.Index.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-index

Return type

str

role_arn

CfnTopicRule.ElasticsearchActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-rolearn

Return type

str

type

CfnTopicRule.ElasticsearchActionProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-type

Return type

str

FirehoseActionProperty

class CfnTopicRule.FirehoseActionProperty(*, delivery_stream_name, role_arn, separator=None)

Bases: object

Parameters
  • delivery_stream_name (str) – CfnTopicRule.FirehoseActionProperty.DeliveryStreamName.

  • role_arn (str) – CfnTopicRule.FirehoseActionProperty.RoleArn.

  • separator (Optional[str]) – CfnTopicRule.FirehoseActionProperty.Separator.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html

Attributes

delivery_stream_name

CfnTopicRule.FirehoseActionProperty.DeliveryStreamName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-deliverystreamname

Return type

str

role_arn

CfnTopicRule.FirehoseActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-rolearn

Return type

str

separator

CfnTopicRule.FirehoseActionProperty.Separator.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-separator

Return type

Optional[str]

HttpActionHeaderProperty

class CfnTopicRule.HttpActionHeaderProperty(*, key, value)

Bases: object

Parameters
  • key (str) – CfnTopicRule.HttpActionHeaderProperty.Key.

  • value (str) – CfnTopicRule.HttpActionHeaderProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpactionheader.html

Attributes

key

CfnTopicRule.HttpActionHeaderProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpactionheader.html#cfn-iot-topicrule-httpactionheader-key

Return type

str

value

CfnTopicRule.HttpActionHeaderProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpactionheader.html#cfn-iot-topicrule-httpactionheader-value

Return type

str

HttpActionProperty

class CfnTopicRule.HttpActionProperty(*, url, auth=None, confirmation_url=None, headers=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html

Attributes

auth

CfnTopicRule.HttpActionProperty.Auth.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-auth

Return type

Union[IResolvable, HttpAuthorizationProperty, None]

confirmation_url

CfnTopicRule.HttpActionProperty.ConfirmationUrl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-confirmationurl

Return type

Optional[str]

headers

CfnTopicRule.HttpActionProperty.Headers.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-headers

Return type

Union[IResolvable, List[Union[IResolvable, HttpActionHeaderProperty]], None]

url

CfnTopicRule.HttpActionProperty.Url.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpaction.html#cfn-iot-topicrule-httpaction-url

Return type

str

HttpAuthorizationProperty

class CfnTopicRule.HttpAuthorizationProperty(*, sigv4=None)

Bases: object

Parameters

sigv4 (Union[IResolvable, SigV4AuthorizationProperty, None]) – CfnTopicRule.HttpAuthorizationProperty.Sigv4.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpauthorization.html

Attributes

sigv4

CfnTopicRule.HttpAuthorizationProperty.Sigv4.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-httpauthorization.html#cfn-iot-topicrule-httpauthorization-sigv4

Return type

Union[IResolvable, SigV4AuthorizationProperty, None]

IotAnalyticsActionProperty

class CfnTopicRule.IotAnalyticsActionProperty(*, channel_name, role_arn)

Bases: object

Parameters
  • channel_name (str) – CfnTopicRule.IotAnalyticsActionProperty.ChannelName.

  • role_arn (str) – CfnTopicRule.IotAnalyticsActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html

Attributes

channel_name

CfnTopicRule.IotAnalyticsActionProperty.ChannelName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-channelname

Return type

str

role_arn

CfnTopicRule.IotAnalyticsActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotanalyticsaction.html#cfn-iot-topicrule-iotanalyticsaction-rolearn

Return type

str

IotEventsActionProperty

class CfnTopicRule.IotEventsActionProperty(*, input_name, role_arn, message_id=None)

Bases: object

Parameters
  • input_name (str) – CfnTopicRule.IotEventsActionProperty.InputName.

  • role_arn (str) – CfnTopicRule.IotEventsActionProperty.RoleArn.

  • message_id (Optional[str]) – CfnTopicRule.IotEventsActionProperty.MessageId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html

Attributes

input_name

CfnTopicRule.IotEventsActionProperty.InputName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html#cfn-iot-topicrule-ioteventsaction-inputname

Return type

str

message_id

CfnTopicRule.IotEventsActionProperty.MessageId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html#cfn-iot-topicrule-ioteventsaction-messageid

Return type

Optional[str]

role_arn

CfnTopicRule.IotEventsActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.html#cfn-iot-topicrule-ioteventsaction-rolearn

Return type

str

IotSiteWiseActionProperty

class CfnTopicRule.IotSiteWiseActionProperty(*, put_asset_property_value_entries, role_arn)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html

Attributes

put_asset_property_value_entries

CfnTopicRule.IotSiteWiseActionProperty.PutAssetPropertyValueEntries.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html#cfn-iot-topicrule-iotsitewiseaction-putassetpropertyvalueentries

Return type

Union[IResolvable, List[Union[IResolvable, PutAssetPropertyValueEntryProperty]]]

role_arn

CfnTopicRule.IotSiteWiseActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-iotsitewiseaction.html#cfn-iot-topicrule-iotsitewiseaction-rolearn

Return type

str

KinesisActionProperty

class CfnTopicRule.KinesisActionProperty(*, role_arn, stream_name, partition_key=None)

Bases: object

Parameters
  • role_arn (str) – CfnTopicRule.KinesisActionProperty.RoleArn.

  • stream_name (str) – CfnTopicRule.KinesisActionProperty.StreamName.

  • partition_key (Optional[str]) – CfnTopicRule.KinesisActionProperty.PartitionKey.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html

Attributes

partition_key

CfnTopicRule.KinesisActionProperty.PartitionKey.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-partitionkey

Return type

Optional[str]

role_arn

CfnTopicRule.KinesisActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-rolearn

Return type

str

stream_name

CfnTopicRule.KinesisActionProperty.StreamName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-streamname

Return type

str

LambdaActionProperty

class CfnTopicRule.LambdaActionProperty(*, function_arn=None)

Bases: object

Parameters

function_arn (Optional[str]) – CfnTopicRule.LambdaActionProperty.FunctionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html

Attributes

function_arn

CfnTopicRule.LambdaActionProperty.FunctionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html#cfn-iot-topicrule-lambdaaction-functionarn

Return type

Optional[str]

PutAssetPropertyValueEntryProperty

class CfnTopicRule.PutAssetPropertyValueEntryProperty(*, property_values, asset_id=None, entry_id=None, property_alias=None, property_id=None)

Bases: object

Parameters
  • property_values (Union[IResolvable, Sequence[Union[IResolvable, AssetPropertyValueProperty]]]) – CfnTopicRule.PutAssetPropertyValueEntryProperty.PropertyValues.

  • asset_id (Optional[str]) – CfnTopicRule.PutAssetPropertyValueEntryProperty.AssetId.

  • entry_id (Optional[str]) – CfnTopicRule.PutAssetPropertyValueEntryProperty.EntryId.

  • property_alias (Optional[str]) – CfnTopicRule.PutAssetPropertyValueEntryProperty.PropertyAlias.

  • property_id (Optional[str]) – CfnTopicRule.PutAssetPropertyValueEntryProperty.PropertyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html

Attributes

asset_id

CfnTopicRule.PutAssetPropertyValueEntryProperty.AssetId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-assetid

Return type

Optional[str]

entry_id

CfnTopicRule.PutAssetPropertyValueEntryProperty.EntryId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-entryid

Return type

Optional[str]

property_alias

CfnTopicRule.PutAssetPropertyValueEntryProperty.PropertyAlias.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-propertyalias

Return type

Optional[str]

property_id

CfnTopicRule.PutAssetPropertyValueEntryProperty.PropertyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-propertyid

Return type

Optional[str]

property_values

CfnTopicRule.PutAssetPropertyValueEntryProperty.PropertyValues.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putassetpropertyvalueentry.html#cfn-iot-topicrule-putassetpropertyvalueentry-propertyvalues

Return type

Union[IResolvable, List[Union[IResolvable, AssetPropertyValueProperty]]]

PutItemInputProperty

class CfnTopicRule.PutItemInputProperty(*, table_name)

Bases: object

Parameters

table_name (str) – CfnTopicRule.PutItemInputProperty.TableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putiteminput.html

Attributes

table_name

CfnTopicRule.PutItemInputProperty.TableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putiteminput.html#cfn-iot-topicrule-putiteminput-tablename

Return type

str

RepublishActionProperty

class CfnTopicRule.RepublishActionProperty(*, role_arn, topic, qos=None)

Bases: object

Parameters
  • role_arn (str) – CfnTopicRule.RepublishActionProperty.RoleArn.

  • topic (str) – CfnTopicRule.RepublishActionProperty.Topic.

  • qos (Union[int, float, None]) – CfnTopicRule.RepublishActionProperty.Qos.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html

Attributes

qos

CfnTopicRule.RepublishActionProperty.Qos.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-qos

Return type

Union[int, float, None]

role_arn

CfnTopicRule.RepublishActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-rolearn

Return type

str

topic

CfnTopicRule.RepublishActionProperty.Topic.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-topic

Return type

str

S3ActionProperty

class CfnTopicRule.S3ActionProperty(*, bucket_name, key, role_arn, canned_acl=None)

Bases: object

Parameters
  • bucket_name (str) – CfnTopicRule.S3ActionProperty.BucketName.

  • key (str) – CfnTopicRule.S3ActionProperty.Key.

  • role_arn (str) – CfnTopicRule.S3ActionProperty.RoleArn.

  • canned_acl (Optional[str]) – CfnTopicRule.S3ActionProperty.CannedAcl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html

Attributes

bucket_name

CfnTopicRule.S3ActionProperty.BucketName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-bucketname

Return type

str

canned_acl

CfnTopicRule.S3ActionProperty.CannedAcl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-cannedacl

Return type

Optional[str]

key

CfnTopicRule.S3ActionProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-key

Return type

str

role_arn

CfnTopicRule.S3ActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-rolearn

Return type

str

SigV4AuthorizationProperty

class CfnTopicRule.SigV4AuthorizationProperty(*, role_arn, service_name, signing_region)

Bases: object

Parameters
  • role_arn (str) – CfnTopicRule.SigV4AuthorizationProperty.RoleArn.

  • service_name (str) – CfnTopicRule.SigV4AuthorizationProperty.ServiceName.

  • signing_region (str) – CfnTopicRule.SigV4AuthorizationProperty.SigningRegion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sigv4authorization.html

Attributes

role_arn

CfnTopicRule.SigV4AuthorizationProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sigv4authorization.html#cfn-iot-topicrule-sigv4authorization-rolearn

Return type

str

service_name

CfnTopicRule.SigV4AuthorizationProperty.ServiceName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sigv4authorization.html#cfn-iot-topicrule-sigv4authorization-servicename

Return type

str

signing_region

CfnTopicRule.SigV4AuthorizationProperty.SigningRegion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sigv4authorization.html#cfn-iot-topicrule-sigv4authorization-signingregion

Return type

str

SnsActionProperty

class CfnTopicRule.SnsActionProperty(*, role_arn, target_arn, message_format=None)

Bases: object

Parameters
  • role_arn (str) – CfnTopicRule.SnsActionProperty.RoleArn.

  • target_arn (str) – CfnTopicRule.SnsActionProperty.TargetArn.

  • message_format (Optional[str]) – CfnTopicRule.SnsActionProperty.MessageFormat.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html

Attributes

message_format

CfnTopicRule.SnsActionProperty.MessageFormat.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-messageformat

Return type

Optional[str]

role_arn

CfnTopicRule.SnsActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-rolearn

Return type

str

target_arn

CfnTopicRule.SnsActionProperty.TargetArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-targetarn

Return type

str

SqsActionProperty

class CfnTopicRule.SqsActionProperty(*, queue_url, role_arn, use_base64=None)

Bases: object

Parameters
  • queue_url (str) – CfnTopicRule.SqsActionProperty.QueueUrl.

  • role_arn (str) – CfnTopicRule.SqsActionProperty.RoleArn.

  • use_base64 (Union[bool, IResolvable, None]) – CfnTopicRule.SqsActionProperty.UseBase64.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html

Attributes

queue_url

CfnTopicRule.SqsActionProperty.QueueUrl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-queueurl

Return type

str

role_arn

CfnTopicRule.SqsActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-rolearn

Return type

str

use_base64

CfnTopicRule.SqsActionProperty.UseBase64.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-usebase64

Return type

Union[bool, IResolvable, None]

StepFunctionsActionProperty

class CfnTopicRule.StepFunctionsActionProperty(*, role_arn, state_machine_name, execution_name_prefix=None)

Bases: object

Parameters
  • role_arn (str) – CfnTopicRule.StepFunctionsActionProperty.RoleArn.

  • state_machine_name (str) – CfnTopicRule.StepFunctionsActionProperty.StateMachineName.

  • execution_name_prefix (Optional[str]) – CfnTopicRule.StepFunctionsActionProperty.ExecutionNamePrefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html

Attributes

execution_name_prefix

CfnTopicRule.StepFunctionsActionProperty.ExecutionNamePrefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-executionnameprefix

Return type

Optional[str]

role_arn

CfnTopicRule.StepFunctionsActionProperty.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-rolearn

Return type

str

state_machine_name

CfnTopicRule.StepFunctionsActionProperty.StateMachineName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-statemachinename

Return type

str

TopicRulePayloadProperty

class CfnTopicRule.TopicRulePayloadProperty(*, actions, sql, aws_iot_sql_version=None, description=None, error_action=None, rule_disabled=None)

Bases: object

Parameters
  • actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty]]]) – CfnTopicRule.TopicRulePayloadProperty.Actions.

  • sql (str) – CfnTopicRule.TopicRulePayloadProperty.Sql.

  • aws_iot_sql_version (Optional[str]) – CfnTopicRule.TopicRulePayloadProperty.AwsIotSqlVersion.

  • description (Optional[str]) – CfnTopicRule.TopicRulePayloadProperty.Description.

  • error_action (Union[IResolvable, ActionProperty, None]) – CfnTopicRule.TopicRulePayloadProperty.ErrorAction.

  • rule_disabled (Union[bool, IResolvable, None]) – CfnTopicRule.TopicRulePayloadProperty.RuleDisabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html

Attributes

actions

CfnTopicRule.TopicRulePayloadProperty.Actions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-actions

Return type

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

aws_iot_sql_version

CfnTopicRule.TopicRulePayloadProperty.AwsIotSqlVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion

Return type

Optional[str]

description

CfnTopicRule.TopicRulePayloadProperty.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-description

Return type

Optional[str]

error_action

CfnTopicRule.TopicRulePayloadProperty.ErrorAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-erroraction

Return type

Union[IResolvable, ActionProperty, None]

rule_disabled

CfnTopicRule.TopicRulePayloadProperty.RuleDisabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-ruledisabled

Return type

Union[bool, IResolvable, None]

sql

CfnTopicRule.TopicRulePayloadProperty.Sql.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql

Return type

str