Class CfnDestination

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDestination

Implements

IInspectable

IDestinationRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTWireless

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDestination : CfnResource, IInspectable, IDestinationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnDestination Inherits CfnResource Implements IInspectable, IDestinationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTWireless;

             var cfnDestination = new CfnDestination(this, "MyCfnDestination", new CfnDestinationProps {
                 Expression = "expression",
                 ExpressionType = "expressionType",
                 Name = "name",

                 // the properties below are optional
                 Description = "description",
                 RoleArn = "roleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDestination(Construct, string, ICfnDestinationProps)

Create a new AWS::IoTWireless::Destination.

Properties

AttrArn	The ARN of the destination created.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a new destination that maps a device message to an AWS IoT rule.
Description	The description of the new resource.
DestinationRef	A reference to a Destination resource.
Expression	The rule name to send messages to.
ExpressionType	The type of value in Expression .
Name	The name of the new resource.
RoleArn	The ARN of the IAM Role that authorizes the destination.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The tags are an array of key-value pairs to attach to the specified resource.

Methods

ArnForDestination(IDestinationRef)	Creates a new destination that maps a device message to an AWS IoT rule.
FromDestinationArn(Construct, string, string)	Creates a new IDestinationRef from an ARN.
FromDestinationName(Construct, string, string)	Creates a new IDestinationRef from a destinationName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDestination(object)	Checks whether the given object is a CfnDestination.
RenderProperties(IDictionary<string, object>)	Creates a new destination that maps a device message to an AWS IoT rule.

Constructors

CfnDestination(Construct, string, ICfnDestinationProps)

Create a new AWS::IoTWireless::Destination.

public CfnDestination(Construct scope, string id, ICfnDestinationProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDestinationProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the destination created.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Description

The description of the new resource.

public virtual string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

DestinationRef

A reference to a Destination resource.

public virtual IDestinationReference DestinationRef { get; }

Property Value

IDestinationReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Expression

The rule name to send messages to.

public virtual string Expression { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

ExpressionType

The type of value in Expression .

public virtual string ExpressionType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Name

The name of the new resource.

public virtual string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

RoleArn

The ARN of the IAM Role that authorizes the destination.

public virtual string? RoleArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

TagsRaw

The tags are an array of key-value pairs to attach to the specified resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Methods

ArnForDestination(IDestinationRef)

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

public static string ArnForDestination(IDestinationRef resource)

Parameters

resource IDestinationRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTWireless;

             var cfnDestination = new CfnDestination(this, "MyCfnDestination", new CfnDestinationProps {
                 Expression = "expression",
                 ExpressionType = "expressionType",
                 Name = "name",

                 // the properties below are optional
                 Description = "description",
                 RoleArn = "roleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromDestinationArn(Construct, string, string)

Creates a new IDestinationRef from an ARN.

public static IDestinationRef FromDestinationArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IDestinationRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

FromDestinationName(Construct, string, string)

Creates a new IDestinationRef from a destinationName.

public static IDestinationRef FromDestinationName(Construct scope, string id, string destinationName)

Parameters

scope Construct

id string

destinationName string

Returns

IDestinationRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

IsCfnDestination(object)

Checks whether the given object is a CfnDestination.

public static bool IsCfnDestination(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-destination.html

CloudformationResource: AWS::IoTWireless::Destination

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDestinationRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable