1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. TopicRuleDestination

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.iot.TopicRuleDestination

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Resource Type definition for AWS::IoT::TopicRuleDestination

    Create TopicRuleDestination Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TopicRuleDestination(name: string, args?: TopicRuleDestinationArgs, opts?: CustomResourceOptions);
    @overload
    def TopicRuleDestination(resource_name: str,
                             args: Optional[TopicRuleDestinationArgs] = None,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def TopicRuleDestination(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             http_url_properties: Optional[TopicRuleDestinationHttpUrlDestinationSummaryArgs] = None,
                             status: Optional[TopicRuleDestinationStatus] = None,
                             vpc_properties: Optional[TopicRuleDestinationVpcDestinationPropertiesArgs] = None)
    func NewTopicRuleDestination(ctx *Context, name string, args *TopicRuleDestinationArgs, opts ...ResourceOption) (*TopicRuleDestination, error)
    public TopicRuleDestination(string name, TopicRuleDestinationArgs? args = null, CustomResourceOptions? opts = null)
    public TopicRuleDestination(String name, TopicRuleDestinationArgs args)
    public TopicRuleDestination(String name, TopicRuleDestinationArgs args, CustomResourceOptions options)
    
    type: aws-native:iot:TopicRuleDestination
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TopicRuleDestination resource accepts the following input properties:

    httpUrlProperties TopicRuleDestinationHttpUrlDestinationSummary
    HTTP URL destination properties.
    status TopicRuleDestinationStatus
    The status of the TopicRuleDestination.
    vpcProperties TopicRuleDestinationVpcDestinationProperties
    VPC destination properties.
    httpUrlProperties TopicRuleDestinationHttpUrlDestinationSummary
    HTTP URL destination properties.
    status TopicRuleDestinationStatus
    The status of the TopicRuleDestination.
    vpcProperties TopicRuleDestinationVpcDestinationProperties
    VPC destination properties.
    httpUrlProperties Property Map
    HTTP URL destination properties.
    status "ENABLED" | "IN_PROGRESS" | "DISABLED"
    The status of the TopicRuleDestination.
    vpcProperties Property Map
    VPC destination properties.

    Outputs

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

    Arn string
    Amazon Resource Name (ARN).
    Id string
    The provider-assigned unique ID for this managed resource.
    StatusReason string
    The reasoning for the current status of the TopicRuleDestination.
    Arn string
    Amazon Resource Name (ARN).
    Id string
    The provider-assigned unique ID for this managed resource.
    StatusReason string
    The reasoning for the current status of the TopicRuleDestination.
    arn String
    Amazon Resource Name (ARN).
    id String
    The provider-assigned unique ID for this managed resource.
    statusReason String
    The reasoning for the current status of the TopicRuleDestination.
    arn string
    Amazon Resource Name (ARN).
    id string
    The provider-assigned unique ID for this managed resource.
    statusReason string
    The reasoning for the current status of the TopicRuleDestination.
    arn str
    Amazon Resource Name (ARN).
    id str
    The provider-assigned unique ID for this managed resource.
    status_reason str
    The reasoning for the current status of the TopicRuleDestination.
    arn String
    Amazon Resource Name (ARN).
    id String
    The provider-assigned unique ID for this managed resource.
    statusReason String
    The reasoning for the current status of the TopicRuleDestination.

    Supporting Types

    TopicRuleDestinationHttpUrlDestinationSummary, TopicRuleDestinationHttpUrlDestinationSummaryArgs

    ConfirmationUrl string
    The URL used to confirm the HTTP topic rule destination URL.
    ConfirmationUrl string
    The URL used to confirm the HTTP topic rule destination URL.
    confirmationUrl String
    The URL used to confirm the HTTP topic rule destination URL.
    confirmationUrl string
    The URL used to confirm the HTTP topic rule destination URL.
    confirmation_url str
    The URL used to confirm the HTTP topic rule destination URL.
    confirmationUrl String
    The URL used to confirm the HTTP topic rule destination URL.

    TopicRuleDestinationStatus, TopicRuleDestinationStatusArgs

    Enabled
    ENABLED
    InProgress
    IN_PROGRESS
    Disabled
    DISABLED
    TopicRuleDestinationStatusEnabled
    ENABLED
    TopicRuleDestinationStatusInProgress
    IN_PROGRESS
    TopicRuleDestinationStatusDisabled
    DISABLED
    Enabled
    ENABLED
    InProgress
    IN_PROGRESS
    Disabled
    DISABLED
    Enabled
    ENABLED
    InProgress
    IN_PROGRESS
    Disabled
    DISABLED
    ENABLED
    ENABLED
    IN_PROGRESS
    IN_PROGRESS
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "IN_PROGRESS"
    IN_PROGRESS
    "DISABLED"
    DISABLED

    TopicRuleDestinationVpcDestinationProperties, TopicRuleDestinationVpcDestinationPropertiesArgs

    RoleArn string
    The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
    SecurityGroups List<string>
    The security groups of the VPC destination.
    SubnetIds List<string>
    The subnet IDs of the VPC destination.
    VpcId string
    The ID of the VPC.
    RoleArn string
    The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
    SecurityGroups []string
    The security groups of the VPC destination.
    SubnetIds []string
    The subnet IDs of the VPC destination.
    VpcId string
    The ID of the VPC.
    roleArn String
    The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
    securityGroups List<String>
    The security groups of the VPC destination.
    subnetIds List<String>
    The subnet IDs of the VPC destination.
    vpcId String
    The ID of the VPC.
    roleArn string
    The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
    securityGroups string[]
    The security groups of the VPC destination.
    subnetIds string[]
    The subnet IDs of the VPC destination.
    vpcId string
    The ID of the VPC.
    role_arn str
    The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
    security_groups Sequence[str]
    The security groups of the VPC destination.
    subnet_ids Sequence[str]
    The subnet IDs of the VPC destination.
    vpc_id str
    The ID of the VPC.
    roleArn String
    The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).
    securityGroups List<String>
    The security groups of the VPC destination.
    subnetIds List<String>
    The subnet IDs of the VPC destination.
    vpcId String
    The ID of the VPC.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi