software.amazon.awscdk.services.iot

Class CfnTopicRuleDestination

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.916Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTopicRuleDestination.Builder A fluent builder for CfnTopicRuleDestination.
static interface	CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty HTTP URL destination properties.
static interface	CfnTopicRuleDestination.VpcDestinationPropertiesProperty The properties of a virtual private cloud (VPC) destination.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTopicRuleDestination(Construct scope, java.lang.String id) Create a new `AWS::IoT::TopicRuleDestination`.
	CfnTopicRuleDestination(Construct scope, java.lang.String id, CfnTopicRuleDestinationProps props) Create a new `AWS::IoT::TopicRuleDestination`.
protected	CfnTopicRuleDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTopicRuleDestination(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The topic rule destination URL.
java.lang.String	getAttrStatusReason() Additional details or reason why the topic rule destination is in the current status.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getHttpUrlProperties() Properties of the HTTP URL.
java.lang.String	getStatus() - **IN_PROGRESS** - A topic rule destination was created but has not been confirmed.
java.lang.Object	getVpcProperties() Properties of the virtual private cloud (VPC) connection.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setHttpUrlProperties(CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty value) Properties of the HTTP URL.
void	setHttpUrlProperties(IResolvable value) Properties of the HTTP URL.
void	setStatus(java.lang.String value) - **IN_PROGRESS** - A topic rule destination was created but has not been confirmed.
void	setVpcProperties(CfnTopicRuleDestination.VpcDestinationPropertiesProperty value) Properties of the virtual private cloud (VPC) connection.
void	setVpcProperties(IResolvable value) Properties of the virtual private cloud (VPC) connection.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTopicRuleDestination

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

CfnTopicRuleDestination

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

CfnTopicRuleDestination

public CfnTopicRuleDestination(Construct scope,
                               java.lang.String id,
                               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

public CfnTopicRuleDestination(Construct scope,
                               java.lang.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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The topic rule destination URL.

getAttrStatusReason

public java.lang.String getAttrStatusReason()

Additional details or reason why the topic rule destination is in the current status.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getHttpUrlProperties

public java.lang.Object getHttpUrlProperties()

Properties of the HTTP URL.

setHttpUrlProperties

public void setHttpUrlProperties(IResolvable value)

Properties of the HTTP URL.

setHttpUrlProperties

public void setHttpUrlProperties(CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty value)

Properties of the HTTP URL.

getStatus

public java.lang.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

public void setStatus(java.lang.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

public java.lang.Object getVpcProperties()

Properties of the virtual private cloud (VPC) connection.

setVpcProperties

public void setVpcProperties(IResolvable value)

Properties of the virtual private cloud (VPC) connection.

setVpcProperties

public void setVpcProperties(CfnTopicRuleDestination.VpcDestinationPropertiesProperty value)

Properties of the virtual private cloud (VPC) connection.