TopicRuleDestination class
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.iot.TopicRuleDestination("example", {vpcConfiguration: {
roleArn: exampleAwsIamRole.arn,
securityGroups: [exampleAwsSecurityGroup.id],
subnetIds: exampleAwsSubnet.map(__item => __item.id),
vpcId: exampleAwsVpc.id,
}});
import pulumi
import pulumi_aws as aws
example = aws.iot.TopicRuleDestination("example", vpc_configuration={
"role_arn": example_aws_iam_role["arn"],
"security_groups": [example_aws_security_group["id"]],
"subnet_ids": [__item["id"] for __item in example_aws_subnet],
"vpc_id": example_aws_vpc["id"],
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Iot.TopicRuleDestination("example", new()
{
VpcConfiguration = new Aws.Iot.Inputs.TopicRuleDestinationVpcConfigurationArgs
{
RoleArn = exampleAwsIamRole.Arn,
SecurityGroups = new[]
{
exampleAwsSecurityGroup.Id,
},
SubnetIds = exampleAwsSubnet.Select(__item => __item.Id).ToList(),
VpcId = exampleAwsVpc.Id,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iot"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := iot.NewTopicRuleDestination(ctx, "example", &iot.TopicRuleDestinationArgs{
VpcConfiguration: &iot.TopicRuleDestinationVpcConfigurationArgs{
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
SecurityGroups: pulumi.StringArray{
exampleAwsSecurityGroup.Id,
},
SubnetIds: pulumi.StringArray(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:4,22-44)),
VpcId: pulumi.Any(exampleAwsVpc.Id),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_iot_topicruledestination" "example" {
vpc_configuration = {
role_arn = exampleAwsIamRole.arn
security_groups = [exampleAwsSecurityGroup.id]
subnet_ids = exampleAwsSubnet[*].id
vpc_id = exampleAwsVpc.id
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.TopicRuleDestination;
import com.pulumi.aws.iot.TopicRuleDestinationArgs;
import com.pulumi.aws.iot.inputs.TopicRuleDestinationVpcConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new TopicRuleDestination("example", TopicRuleDestinationArgs.builder()
.vpcConfiguration(TopicRuleDestinationVpcConfigurationArgs.builder()
.roleArn(exampleAwsIamRole.arn())
.securityGroups(exampleAwsSecurityGroup.id())
.subnetIds(exampleAwsSubnet.stream().map(element -> element.id()).collect(toList()))
.vpcId(exampleAwsVpc.id())
.build())
.build());
}
}
Import
Using pulumi import, import IoT topic rule destinations using the arn. For example:
$ pulumi import aws:iot/topicRuleDestination:TopicRuleDestination example arn:aws:iot:us-west-2:123456789012:ruledestination/vpc/2ce781c8-68a6-4c52-9c62-63fe489ecc60
Constructors
- TopicRuleDestination(String name, {TopicRuleDestinationArgs? args, CustomResourceOptions? options})
-
Creates a new TopicRuleDestination.
nameThe Pulumi resource name.argsArguments used to configure this TopicRuleDestination. The set of arguments for TopicRuleDestination.optionsResource options controlling this resource's behavior. - TopicRuleDestination.reference(String urn)
- Creates a typed reference to an existing TopicRuleDestination resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the topic rule destination
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
enabled
↔ Output<
bool?> -
Whether or not to enable the destination. Default:
true.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcConfiguration
↔ Output<
TopicRuleDestinationVpcConfiguration> -
Configuration of the VPC connection. For more info, see the AWS documentation.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {TopicRuleDestinationState? state, CustomResourceOptions? options}) → TopicRuleDestination -
Gets an existing TopicRuleDestination resource's state with the given
nameandid.