Class CfnTopicRuleDestination
A CloudFormation AWS::IoT::TopicRuleDestination
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnTopicRuleDestination : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnTopicRuleDestination
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
A topic rule destination.
CloudformationResource: AWS::IoT::TopicRuleDestination
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.IoT;
var cfnTopicRuleDestination = new CfnTopicRuleDestination(this, "MyCfnTopicRuleDestination", new CfnTopicRuleDestinationProps {
HttpUrlProperties = new HttpUrlDestinationSummaryProperty {
ConfirmationUrl = "confirmationUrl"
},
Status = "status",
VpcProperties = new VpcDestinationPropertiesProperty {
RoleArn = "roleArn",
SecurityGroups = new [] { "securityGroups" },
SubnetIds = new [] { "subnetIds" },
VpcId = "vpcId"
}
});
Synopsis
Constructors
CfnTopicRuleDestination(Construct, String, ICfnTopicRuleDestinationProps) | Create a new |
CfnTopicRuleDestination(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTopicRuleDestination(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The topic rule destination URL. |
AttrStatusReason | Additional details or reason why the topic rule destination is in the current status. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
HttpUrlProperties | Properties of the HTTP URL. |
Status | |
VpcProperties | Properties of the virtual private cloud (VPC) connection. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTopicRuleDestination(Construct, String, ICfnTopicRuleDestinationProps)
Create a new AWS::IoT::TopicRuleDestination
.
public CfnTopicRuleDestination(Construct scope, string id, ICfnTopicRuleDestinationProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnTopicRuleDestinationProps
- resource properties.
CfnTopicRuleDestination(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTopicRuleDestination(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTopicRuleDestination(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTopicRuleDestination(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The topic rule destination URL.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrStatusReason
Additional details or reason why the topic rule destination is in the current status.
public virtual string AttrStatusReason { get; }
Property Value
System.String
Remarks
CloudformationAttribute: StatusReason
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
HttpUrlProperties
Properties of the HTTP URL.
public virtual object HttpUrlProperties { get; set; }
Property Value
System.Object
Remarks
Status
- IN_PROGRESS - A topic rule destination was created but has not been confirmed.
public virtual string Status { get; set; }
Property Value
System.String
Remarks
You can set status to IN_PROGRESS
by calling UpdateTopicRuleDestination
. Calling UpdateTopicRuleDestination
causes a new confirmation challenge to be sent to your confirmation endpoint.
VpcProperties
Properties of the virtual private cloud (VPC) connection.
public virtual object VpcProperties { get; set; }
Property Value
System.Object
Remarks
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>