aws-cdk-lib.aws_iot.CfnTopicRuleDestinationProps

CfnTopicRuleDestinationProps Struct

Properties for defining a CfnTopicRuleDestination.

Source

Generated code

Type last changed

v2.269.0 · 10 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnTopicRuleDestinationProps: iot.CfnTopicRuleDestinationProps = {
  httpUrlProperties: {
    confirmationUrl: 'confirmationUrl',
  },
  influxDbProperties: {
    endpoint: 'endpoint',
    influxDbVersion: 'influxDbVersion',
    secretId: 'secretId',

    // the properties below are optional
    secretKey: 'secretKey',
    secretType: 'secretType',
  },
  status: 'status',
  vpcProperties: {
    roleArn: 'roleArn',
    securityGroups: ['securityGroups'],
    subnetIds: ['subnetIds'],
    vpcId: 'vpcId',
  },
};

Properties

httpUrlPropertiesIResolvable | CfnTopicRuleDestination.HttpUrlDestinationSummaryPropertyhttp_url_propertiestyping.Union[IResolvable, HttpUrlDestinationSummaryProperty]httpUrlPropertiesIResolvableHttpUrlPropertiesIResolvableHttpUrlPropertiesinterface{}#

Properties of the HTTP URL.

influxDbPropertiesIResolvable | CfnTopicRuleDestination.InfluxDBDestinationPropertiesPropertyinflux_db_propertiestyping.Union[IResolvable, InfluxDBDestinationPropertiesProperty]influxDbPropertiesIResolvableInfluxDbPropertiesIResolvableInfluxDbPropertiesinterface{}#

statusstringstatusstrstatusStringStatusstringStatus*string#

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

notes

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.

vpcPropertiesIResolvable | CfnTopicRuleDestination.VpcDestinationPropertiesPropertyvpc_propertiestyping.Union[IResolvable, VpcDestinationPropertiesProperty]vpcPropertiesIResolvableVpcPropertiesIResolvableVpcPropertiesinterface{}#

Properties of the virtual private cloud (VPC) connection.

Used as props by

• CfnTopicRuleDestination