CfnTopicRuleDestinationProps

class aws_cdk.aws_iot.CfnTopicRuleDestinationProps(*, http_url_properties=None, status=None, vpc_properties=None)

Bases: object

Properties for defining a CfnTopicRuleDestination.

Parameters
  • http_url_properties (Union[IResolvable, HttpUrlDestinationSummaryProperty, Dict[str, Any], None]) – Properties of the HTTP URL.

  • status (Optional[str]) –

    • IN_PROGRESS - A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. - ENABLED - Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination . - DISABLED - Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination . - ERROR - Confirmation could not be completed; for example, if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

  • vpc_properties (Union[IResolvable, VpcDestinationPropertiesProperty, Dict[str, Any], None]) – Properties of the virtual private cloud (VPC) connection.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_topic_rule_destination_props = iot.CfnTopicRuleDestinationProps(
    http_url_properties=iot.CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty(
        confirmation_url="confirmationUrl"
    ),
    status="status",
    vpc_properties=iot.CfnTopicRuleDestination.VpcDestinationPropertiesProperty(
        role_arn="roleArn",
        security_groups=["securityGroups"],
        subnet_ids=["subnetIds"],
        vpc_id="vpcId"
    )
)

Attributes

http_url_properties

Properties of the HTTP URL.

Link

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

Return type

Union[IResolvable, HttpUrlDestinationSummaryProperty, None]

status
  • IN_PROGRESS - A topic rule destination was created but has not been confirmed.

You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

  • ENABLED - Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination .

  • DISABLED - Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination .

  • ERROR - Confirmation could not be completed; for example, if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Link

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

Return type

Optional[str]

vpc_properties

Properties of the virtual private cloud (VPC) connection.

Link

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

Return type

Union[IResolvable, VpcDestinationPropertiesProperty, None]