Package software.amazon.awscdk.services.iot

Class CfnTopicRuleDestination

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnTopicRuleDestination
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.710Z") @Stability(Stable) public class CfnTopicRuleDestination extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::TopicRuleDestination.

A topic rule destination.

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.*;
 CfnTopicRuleDestination cfnTopicRuleDestination = CfnTopicRuleDestination.Builder.create(this, "MyCfnTopicRuleDestination")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTopicRuleDestination

      protected CfnTopicRuleDestination(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTopicRuleDestination

      protected CfnTopicRuleDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTopicRuleDestination

      @Stability(Stable) public CfnTopicRuleDestination(@NotNull Construct scope, @NotNull String id, @Nullable CfnTopicRuleDestinationProps props)
      Create a new AWS::IoT::TopicRuleDestination.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnTopicRuleDestination

      @Stability(Stable) public CfnTopicRuleDestination(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::IoT::TopicRuleDestination.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The topic rule destination URL.

    • getAttrStatusReason

      @Stability(Stable) @NotNull public String getAttrStatusReason()
      Additional details or reason why the topic rule destination is in the current status.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getHttpUrlProperties

      @Stability(Stable) @Nullable public Object getHttpUrlProperties()
      Properties of the HTTP URL.

    • setHttpUrlProperties

      @Stability(Stable) public void setHttpUrlProperties(@Nullable IResolvable value)
      Properties of the HTTP URL.

    • setHttpUrlProperties

      @Stability(Stable) public void setHttpUrlProperties(@Nullable CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty value)
      Properties of the HTTP URL.

    • getStatus

      @Stability(Stable) @Nullable public 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.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      • 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.

    • getVpcProperties

      @Stability(Stable) @Nullable public Object getVpcProperties()
      Properties of the virtual private cloud (VPC) connection.

    • setVpcProperties

      @Stability(Stable) public void setVpcProperties(@Nullable IResolvable value)
      Properties of the virtual private cloud (VPC) connection.

    • setVpcProperties

      @Stability(Stable) public void setVpcProperties(@Nullable CfnTopicRuleDestination.VpcDestinationPropertiesProperty value)
      Properties of the virtual private cloud (VPC) connection.