Package software.amazon.awscdk.services.iot

Interface CfnTopicRuleDestinationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRuleDestinationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:00.271Z")
@Stability(Stable)
public interface CfnTopicRuleDestinationProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iot.*;
 CfnTopicRuleDestinationProps cfnTopicRuleDestinationProps = CfnTopicRuleDestinationProps.builder()
         .httpUrlProperties(HttpUrlDestinationSummaryProperty.builder()
                 .confirmationUrl("confirmationUrl")
                 .build())
         .status("status")
         .vpcProperties(VpcDestinationPropertiesProperty.builder()
                 .roleArn("roleArn")
                 .securityGroups(List.of("securityGroups"))
                 .subnetIds(List.of("subnetIds"))
                 .vpcId("vpcId")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTopicRuleDestinationProps.Builder	A builder for CfnTopicRuleDestinationProps
static final class	CfnTopicRuleDestinationProps.Jsii$Proxy	An implementation for CfnTopicRuleDestinationProps

Method Summary

Modifier and Type	Method	Description
static CfnTopicRuleDestinationProps.Builder	builder()
default Object	getHttpUrlProperties()	Properties of the HTTP URL.
default String	getStatus()	IN_PROGRESS - A topic rule destination was created but has not been confirmed.
default Object	getVpcProperties()	Properties of the virtual private cloud (VPC) connection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpUrlProperties

@Stability(Stable)
@Nullable
default Object getHttpUrlProperties()

Properties of the HTTP URL.

See Also:

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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

See Also:

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

getVpcProperties

@Stability(Stable)
@Nullable
default Object getVpcProperties()

Properties of the virtual private cloud (VPC) connection.

See Also:

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

builder

@Stability(Stable)
static CfnTopicRuleDestinationProps.Builder builder()

Returns:

a CfnTopicRuleDestinationProps.Builder of CfnTopicRuleDestinationProps