CfnTopicRuleDestinationProps Struct
Properties for defining a CfnTopicRuleDestination.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnTopicRuleDestinationProps: iot.CfnTopicRuleDestinationProps = {
httpUrlProperties: {
confirmationUrl: 'confirmationUrl',
},
influxDbProperties: {
endpoint: 'endpoint',
influxDbVersion: 'influxDbVersion',
secretId: 'secretId',
// the properties below are optional
secretKey: 'secretKey',
secretType: 'secretType',
},
status: 'status',
vpcProperties: {
roleArn: 'roleArn',
securityGroups: ['securityGroups'],
subnetIds: ['subnetIds'],
vpcId: 'vpcId',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot
cfn_topic_rule_destination_props = iot.CfnTopicRuleDestinationProps(
http_url_properties=iot.CfnTopicRuleDestination.HttpUrlDestinationSummaryProperty(
confirmation_url="confirmationUrl"
),
influx_db_properties=iot.CfnTopicRuleDestination.InfluxDBDestinationPropertiesProperty(
endpoint="endpoint",
influx_db_version="influxDbVersion",
secret_id="secretId",
# the properties below are optional
secret_key="secretKey",
secret_type="secretType"
),
status="status",
vpc_properties=iot.CfnTopicRuleDestination.VpcDestinationPropertiesProperty(
role_arn="roleArn",
security_groups=["securityGroups"],
subnet_ids=["subnetIds"],
vpc_id="vpcId"
)
)
java
// 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.*;
CfnTopicRuleDestinationProps cfnTopicRuleDestinationProps = CfnTopicRuleDestinationProps.builder()
.httpUrlProperties(HttpUrlDestinationSummaryProperty.builder()
.confirmationUrl("confirmationUrl")
.build())
.influxDbProperties(InfluxDBDestinationPropertiesProperty.builder()
.endpoint("endpoint")
.influxDbVersion("influxDbVersion")
.secretId("secretId")
// the properties below are optional
.secretKey("secretKey")
.secretType("secretType")
.build())
.status("status")
.vpcProperties(VpcDestinationPropertiesProperty.builder()
.roleArn("roleArn")
.securityGroups(List.of("securityGroups"))
.subnetIds(List.of("subnetIds"))
.vpcId("vpcId")
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 cfnTopicRuleDestinationProps = new CfnTopicRuleDestinationProps {
HttpUrlProperties = new HttpUrlDestinationSummaryProperty {
ConfirmationUrl = "confirmationUrl"
},
InfluxDbProperties = new InfluxDBDestinationPropertiesProperty {
Endpoint = "endpoint",
InfluxDbVersion = "influxDbVersion",
SecretId = "secretId",
// the properties below are optional
SecretKey = "secretKey",
SecretType = "secretType"
},
Status = "status",
VpcProperties = new VpcDestinationPropertiesProperty {
RoleArn = "roleArn",
SecurityGroups = new [] { "securityGroups" },
SubnetIds = new [] { "subnetIds" },
VpcId = "vpcId"
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnTopicRuleDestinationProps := &CfnTopicRuleDestinationProps{
HttpUrlProperties: &HttpUrlDestinationSummaryProperty{
ConfirmationUrl: jsii.String("confirmationUrl"),
},
InfluxDbProperties: &InfluxDBDestinationPropertiesProperty{
Endpoint: jsii.String("endpoint"),
InfluxDbVersion: jsii.String("influxDbVersion"),
SecretId: jsii.String("secretId"),
// the properties below are optional
SecretKey: jsii.String("secretKey"),
SecretType: jsii.String("secretType"),
},
Status: jsii.String("status"),
VpcProperties: &VpcDestinationPropertiesProperty{
RoleArn: jsii.String("roleArn"),
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
SubnetIds: []*string{
jsii.String("subnetIds"),
},
VpcId: jsii.String("vpcId"),
},
}
Properties
httpUrlPropertiesoptionalIResolvable | CfnTopicRuleDestination.http_url_propertiesoptionaltyping.Union[IResolvable, HttpUrlDestinationSummaryProperty]httpUrlPropertiesoptionalIResolvableHttpUrlPropertiesoptionalIResolvableHttpUrlPropertiesoptionalinterface{} #Properties of the HTTP URL.
influxDbPropertiesoptionalIResolvable | CfnTopicRuleDestination.influx_db_propertiesoptionaltyping.Union[IResolvable, InfluxDBDestinationPropertiesProperty]influxDbPropertiesoptionalIResolvableInfluxDbPropertiesoptionalIResolvableInfluxDbPropertiesoptionalinterface{} #statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string #- **IN_PROGRESS** - A topic rule destination was created but has not been confirmed.
notes
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
DISABLEDby callingUpdateTopicRuleDestination. - DISABLED - Confirmation was completed, and traffic to this destination is not allowed. You can set status to
ENABLEDby callingUpdateTopicRuleDestination. - ERROR - Confirmation could not be completed; for example, if the confirmation timed out. You can call
GetTopicRuleDestinationfor details about the error. You can set status toIN_PROGRESSby callingUpdateTopicRuleDestination. CallingUpdateTopicRuleDestinationcauses a new confirmation challenge to be sent to your confirmation endpoint.
vpcPropertiesoptionalIResolvable | CfnTopicRuleDestination.vpc_propertiesoptionaltyping.Union[IResolvable, VpcDestinationPropertiesProperty]vpcPropertiesoptionalIResolvableVpcPropertiesoptionalIResolvableVpcPropertiesoptionalinterface{} #Properties of the virtual private cloud (VPC) connection.