@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.916Z") public class CfnTopicRuleDestination extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnTopicRuleDestination(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnTopicRuleDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnTopicRuleDestination(Construct scope, java.lang.String id, CfnTopicRuleDestinationProps props)
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.public CfnTopicRuleDestination(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrStatusReason()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getHttpUrlProperties()
public void setHttpUrlProperties(IResolvable value)
public void setHttpUrlProperties(CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty value)
public java.lang.String getStatus()
You can set status to IN_PROGRESS
by calling UpdateTopicRuleDestination
. Calling UpdateTopicRuleDestination
causes a new confirmation challenge to be sent to your confirmation endpoint.
DISABLED
by calling UpdateTopicRuleDestination
.ENABLED
by calling UpdateTopicRuleDestination
.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.public void setStatus(java.lang.String value)
You can set status to IN_PROGRESS
by calling UpdateTopicRuleDestination
. Calling UpdateTopicRuleDestination
causes a new confirmation challenge to be sent to your confirmation endpoint.
DISABLED
by calling UpdateTopicRuleDestination
.ENABLED
by calling UpdateTopicRuleDestination
.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.public java.lang.Object getVpcProperties()
public void setVpcProperties(IResolvable value)
public void setVpcProperties(CfnTopicRuleDestination.VpcDestinationPropertiesProperty value)