software.amazon.awscdk.services.iot

Class CfnTopicRuleDestination

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.iot.CfnTopicRuleDestination

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:39.914Z")
 @Stability(value=Stable)
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 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
	CfnTopicRuleDestination(software.constructs.Construct scope, String id) Create a new `AWS::IoT::TopicRuleDestination`.
	CfnTopicRuleDestination(software.constructs.Construct scope, 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
String	getAttrArn() The topic rule destination URL.
String	getAttrStatusReason() Additional details or reason why the topic rule destination is in the current status.
protected Map<String,Object>	getCfnProperties()
Object	getHttpUrlProperties() Properties of the HTTP URL.
String	getStatus() - **IN_PROGRESS** - A topic rule destination was created but has not been confirmed.
Object	getVpcProperties() Properties of the virtual private cloud (VPC) connection.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setHttpUrlProperties(CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty value) Properties of the HTTP URL.
void	setHttpUrlProperties(IResolvable value) Properties of the HTTP URL.
void	setStatus(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.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

CfnTopicRuleDestination

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

CfnTopicRuleDestination

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

CfnTopicRuleDestination

@Stability(value=Stable)
public CfnTopicRuleDestination(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @Nullable
                                                        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

@Stability(value=Stable)
public CfnTopicRuleDestination(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        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

@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 topic rule destination URL.

getAttrStatusReason

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getHttpUrlProperties

@Stability(value=Stable)
 @Nullable
public Object getHttpUrlProperties()

Properties of the HTTP URL.

setHttpUrlProperties

@Stability(value=Stable)
public void setHttpUrlProperties(@Nullable
                                                          CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty value)

Properties of the HTTP URL.

setHttpUrlProperties

@Stability(value=Stable)
public void setHttpUrlProperties(@Nullable
                                                          IResolvable value)

Properties of the HTTP URL.

getStatus

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

@Stability(value=Stable)
public void setStatus(@Nullable
                                               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

@Stability(value=Stable)
 @Nullable
public Object getVpcProperties()

Properties of the virtual private cloud (VPC) connection.

setVpcProperties

@Stability(value=Stable)
public void setVpcProperties(@Nullable
                                                      CfnTopicRuleDestination.VpcDestinationPropertiesProperty value)

Properties of the virtual private cloud (VPC) connection.

setVpcProperties

@Stability(value=Stable)
public void setVpcProperties(@Nullable
                                                      IResolvable value)

Properties of the virtual private cloud (VPC) connection.