Package software.amazon.awscdk.services.iotwireless

Class CfnDestination

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.iotwireless.CfnDestination
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.974Z") @Stability(Stable) public class CfnDestination extends CfnResource implements IInspectable
A CloudFormation AWS::IoTWireless::Destination.

Creates a new destination that maps a device message to an AWS IoT rule.

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.iotwireless.*;
 CfnDestination cfnDestination = CfnDestination.Builder.create(this, "MyCfnDestination")
         .expression("expression")
         .expressionType("expressionType")
         .name("name")
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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

    • CfnDestination

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

    • CfnDestination

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

    • CfnDestination

      @Stability(Stable) public CfnDestination(@NotNull Construct scope, @NotNull String id, @NotNull CfnDestinationProps props)
      Create a new AWS::IoTWireless::Destination.

      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.
      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 ARN of the destination created.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags are an array of key-value pairs to attach to the specified resource.

      Tags can have a minimum of 0 and a maximum of 50 items.

    • getExpression

      @Stability(Stable) @NotNull public String getExpression()
      The rule name to send messages to.

    • setExpression

      @Stability(Stable) public void setExpression(@NotNull String value)
      The rule name to send messages to.

    • getExpressionType

      @Stability(Stable) @NotNull public String getExpressionType()
      The type of value in Expression .

    • setExpressionType

      @Stability(Stable) public void setExpressionType(@NotNull String value)
      The type of value in Expression .

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the new resource.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the new resource.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The ARN of the IAM Role that authorizes the destination.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The ARN of the IAM Role that authorizes the destination.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the new resource.

      Maximum length is 2048 characters.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the new resource.

      Maximum length is 2048 characters.