software.amazon.awscdk.services.iotwireless

Class CfnDestination

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotwireless.CfnDestination

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.075Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDestination.Builder A fluent builder for CfnDestination.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDestination(software.constructs.Construct scope, String id, CfnDestinationProps props) Create a new `AWS::IoTWireless::Destination`.
protected	CfnDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDestination(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the destination created.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the new resource.
String	getExpression() The rule name to send messages to.
String	getExpressionType() The type of value in `Expression` .
String	getName() The name of the new resource.
String	getRoleArn() The ARN of the IAM Role that authorizes the destination.
TagManager	getTags() The tags are an array of key-value pairs to attach to the specified resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the new resource.
void	setExpression(String value) The rule name to send messages to.
void	setExpressionType(String value) The type of value in `Expression` .
void	setName(String value) The name of the new resource.
void	setRoleArn(String value) The ARN of the IAM Role that authorizes the destination.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDestination

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

CfnDestination

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

CfnDestination

@Stability(value=Stable)
public CfnDestination(@NotNull
                                               software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the destination created.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=Stable)
 @NotNull
public String getExpression()

The rule name to send messages to.

setExpression

@Stability(value=Stable)
public void setExpression(@NotNull
                                                   String value)

The rule name to send messages to.

getExpressionType

@Stability(value=Stable)
 @NotNull
public String getExpressionType()

The type of value in `Expression` .

setExpressionType

@Stability(value=Stable)
public void setExpressionType(@NotNull
                                                       String value)

The type of value in `Expression` .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the new resource.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the new resource.

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

The ARN of the IAM Role that authorizes the destination.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

The ARN of the IAM Role that authorizes the destination.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the new resource.

Maximum length is 2048 characters.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the new resource.

Maximum length is 2048 characters.