← All packages

AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Source code

TopicRuleDestination

Import

IoT topic rule destinations can be imported using the arn, e.g.,

 $ pulumi import aws:iot/topicRuleDestination:TopicRuleDestination example arn:aws:iot:us-west-2:123456789012:ruledestination/vpc/2ce781c8-68a6-4c52-9c62-63fe489ecc60

Create a TopicRuleDestination Resource

new TopicRuleDestination(name: string, args: TopicRuleDestinationArgs, opts?: CustomResourceOptions);

@overload
def TopicRuleDestination(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         enabled: Optional[bool] = None,
                         vpc_configuration: Optional[TopicRuleDestinationVpcConfigurationArgs] = None)
@overload
def TopicRuleDestination(resource_name: str,
                         args: TopicRuleDestinationArgs,
                         opts: Optional[ResourceOptions] = None)

func NewTopicRuleDestination(ctx *Context, name string, args TopicRuleDestinationArgs, opts ...ResourceOption) (*TopicRuleDestination, error)

public TopicRuleDestination(string name, TopicRuleDestinationArgs args, CustomResourceOptions? opts = null)

public TopicRuleDestination(String name, TopicRuleDestinationArgs args)
public TopicRuleDestination(String name, TopicRuleDestinationArgs args, CustomResourceOptions options)

type: aws:iot:TopicRuleDestination
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TopicRuleDestinationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TopicRuleDestinationArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TopicRuleDestinationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TopicRuleDestinationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TopicRuleDestinationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

TopicRuleDestination Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The TopicRuleDestination resource accepts the following input properties:

VpcConfiguration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.
Enabled bool: Whether or not to enable the destination. Default: true.

VpcConfiguration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.
Enabled bool: Whether or not to enable the destination. Default: true.

vpcConfiguration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.
enabled Boolean: Whether or not to enable the destination. Default: true.

vpcConfiguration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.
enabled boolean: Whether or not to enable the destination. Default: true.

vpc_configuration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.
enabled bool: Whether or not to enable the destination. Default: true.

vpcConfiguration Property Map: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.
enabled Boolean: Whether or not to enable the destination. Default: true.

Outputs

All input properties are implicitly available as output properties. Additionally, the TopicRuleDestination resource produces the following output properties:

Arn string: The ARN of the topic rule destination
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The ARN of the topic rule destination
Id string: The provider-assigned unique ID for this managed resource.

arn String: The ARN of the topic rule destination
id String: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the topic rule destination
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the topic rule destination
id str: The provider-assigned unique ID for this managed resource.

arn String: The ARN of the topic rule destination
id String: The provider-assigned unique ID for this managed resource.

Look up an Existing TopicRuleDestination Resource

Get an existing TopicRuleDestination resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TopicRuleDestinationState, opts?: CustomResourceOptions): TopicRuleDestination

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        enabled: Optional[bool] = None,
        vpc_configuration: Optional[TopicRuleDestinationVpcConfigurationArgs] = None) -> TopicRuleDestination

func GetTopicRuleDestination(ctx *Context, name string, id IDInput, state *TopicRuleDestinationState, opts ...ResourceOption) (*TopicRuleDestination, error)

public static TopicRuleDestination Get(string name, Input<string> id, TopicRuleDestinationState? state, CustomResourceOptions? opts = null)

public static TopicRuleDestination get(String name, Output<String> id, TopicRuleDestinationState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The ARN of the topic rule destination
Enabled bool: Whether or not to enable the destination. Default: true.
VpcConfiguration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.

Arn string: The ARN of the topic rule destination
Enabled bool: Whether or not to enable the destination. Default: true.
VpcConfiguration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.

arn String: The ARN of the topic rule destination
enabled Boolean: Whether or not to enable the destination. Default: true.
vpcConfiguration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.

arn string: The ARN of the topic rule destination
enabled boolean: Whether or not to enable the destination. Default: true.
vpcConfiguration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.

arn str: The ARN of the topic rule destination
enabled bool: Whether or not to enable the destination. Default: true.
vpc_configuration TopicRuleDestinationVpcConfigurationArgs: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.

arn String: The ARN of the topic rule destination
enabled Boolean: Whether or not to enable the destination. Default: true.
vpcConfiguration Property Map: Configuration of the virtual private cloud (VPC) connection. For more info, see the AWS documentation.

Supporting Types

TopicRuleDestinationVpcConfiguration

RoleArn string: The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
SubnetIds List<string>: The subnet IDs of the VPC destination.
VpcId string: The ID of the VPC.
SecurityGroups List<string>: The security groups of the VPC destination.

RoleArn string: The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
SubnetIds []string: The subnet IDs of the VPC destination.
VpcId string: The ID of the VPC.
SecurityGroups []string: The security groups of the VPC destination.

roleArn String: The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
subnetIds List<String>: The subnet IDs of the VPC destination.
vpcId String: The ID of the VPC.
securityGroups List<String>: The security groups of the VPC destination.

roleArn string: The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
subnetIds string[]: The subnet IDs of the VPC destination.
vpcId string: The ID of the VPC.
securityGroups string[]: The security groups of the VPC destination.

role_arn str: The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
subnet_ids Sequence[str]: The subnet IDs of the VPC destination.
vpc_id str: The ID of the VPC.
security_groups Sequence[str]: The security groups of the VPC destination.

roleArn String: The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
subnetIds List<String>: The subnet IDs of the VPC destination.
vpcId String: The ID of the VPC.
securityGroups List<String>: The security groups of the VPC destination.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.