1.204.0

interface CfnTopicRuleDestinationProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRuleDestinationProps
Javasoftware.amazon.awscdk.services.iot.CfnTopicRuleDestinationProps
Pythonaws_cdk.aws_iot.CfnTopicRuleDestinationProps
TypeScript @aws-cdk/aws-iot » CfnTopicRuleDestinationProps

Properties for defining a CfnTopicRuleDestination.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iot from '@aws-cdk/aws-iot';
const cfnTopicRuleDestinationProps: iot.CfnTopicRuleDestinationProps = {
  httpUrlProperties: {
    confirmationUrl: 'confirmationUrl',
  },
  status: 'status',
  vpcProperties: {
    roleArn: 'roleArn',
    securityGroups: ['securityGroups'],
    subnetIds: ['subnetIds'],
    vpcId: 'vpcId',
  },
};

Properties

NameTypeDescription
httpUrlProperties?IResolvable | HttpUrlDestinationSummaryPropertyProperties of the HTTP URL.
status?string- IN_PROGRESS - A topic rule destination was created but has not been confirmed.
vpcProperties?IResolvable | VpcDestinationPropertiesPropertyProperties of the virtual private cloud (VPC) connection.

httpUrlProperties?

Type: IResolvable | HttpUrlDestinationSummaryProperty (optional)

Properties of the HTTP URL.

status?

Type: string (optional)

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

vpcProperties?

Type: IResolvable | VpcDestinationPropertiesProperty (optional)

Properties of the virtual private cloud (VPC) connection.

← PreviousNext →