1. Packages
  2. AWS
  3. API Docs
  4. iot
  5. EventConfigurations
AWS v6.59.1 published on Tuesday, Nov 12, 2024 by Pulumi

aws.iot.EventConfigurations

Explore with Pulumi AI

aws logo
AWS v6.59.1 published on Tuesday, Nov 12, 2024 by Pulumi

    Manages IoT event configurations.

    NOTE: Deleting this resource does not disable the event configurations, the resource in simply removed from state instead.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.iot.EventConfigurations("example", {eventConfigurations: {
        THING: true,
        THING_GROUP: false,
        THING_TYPE: false,
        THING_GROUP_MEMBERSHIP: false,
        THING_GROUP_HIERARCHY: false,
        THING_TYPE_ASSOCIATION: false,
        JOB: false,
        JOB_EXECUTION: false,
        POLICY: false,
        CERTIFICATE: true,
        CA_CERTIFICATE: false,
    }});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.iot.EventConfigurations("example", event_configurations={
        "THING": True,
        "THING_GROUP": False,
        "THING_TYPE": False,
        "THING_GROUP_MEMBERSHIP": False,
        "THING_GROUP_HIERARCHY": False,
        "THING_TYPE_ASSOCIATION": False,
        "JOB": False,
        "JOB_EXECUTION": False,
        "POLICY": False,
        "CERTIFICATE": True,
        "CA_CERTIFICATE": False,
    })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iot"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iot.NewEventConfigurations(ctx, "example", &iot.EventConfigurationsArgs{
    			EventConfigurations: pulumi.BoolMap{
    				"THING":                  pulumi.Bool(true),
    				"THING_GROUP":            pulumi.Bool(false),
    				"THING_TYPE":             pulumi.Bool(false),
    				"THING_GROUP_MEMBERSHIP": pulumi.Bool(false),
    				"THING_GROUP_HIERARCHY":  pulumi.Bool(false),
    				"THING_TYPE_ASSOCIATION": pulumi.Bool(false),
    				"JOB":                    pulumi.Bool(false),
    				"JOB_EXECUTION":          pulumi.Bool(false),
    				"POLICY":                 pulumi.Bool(false),
    				"CERTIFICATE":            pulumi.Bool(true),
    				"CA_CERTIFICATE":         pulumi.Bool(false),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Iot.EventConfigurations("example", new()
        {
            Configurations = 
            {
                { "THING", true },
                { "THING_GROUP", false },
                { "THING_TYPE", false },
                { "THING_GROUP_MEMBERSHIP", false },
                { "THING_GROUP_HIERARCHY", false },
                { "THING_TYPE_ASSOCIATION", false },
                { "JOB", false },
                { "JOB_EXECUTION", false },
                { "POLICY", false },
                { "CERTIFICATE", true },
                { "CA_CERTIFICATE", false },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iot.EventConfigurations;
    import com.pulumi.aws.iot.EventConfigurationsArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 EventConfigurations("example", EventConfigurationsArgs.builder()
                .eventConfigurations(Map.ofEntries(
                    Map.entry("THING", true),
                    Map.entry("THING_GROUP", false),
                    Map.entry("THING_TYPE", false),
                    Map.entry("THING_GROUP_MEMBERSHIP", false),
                    Map.entry("THING_GROUP_HIERARCHY", false),
                    Map.entry("THING_TYPE_ASSOCIATION", false),
                    Map.entry("JOB", false),
                    Map.entry("JOB_EXECUTION", false),
                    Map.entry("POLICY", false),
                    Map.entry("CERTIFICATE", true),
                    Map.entry("CA_CERTIFICATE", false)
                ))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:iot:EventConfigurations
        properties:
          eventConfigurations:
            THING: true
            THING_GROUP: false
            THING_TYPE: false
            THING_GROUP_MEMBERSHIP: false
            THING_GROUP_HIERARCHY: false
            THING_TYPE_ASSOCIATION: false
            JOB: false
            JOB_EXECUTION: false
            POLICY: false
            CERTIFICATE: true
            CA_CERTIFICATE: false
    

    Create EventConfigurations Resource

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

    Constructor syntax

    new EventConfigurations(name: string, args: EventConfigurationsArgs, opts?: CustomResourceOptions);
    @overload
    def EventConfigurations(resource_name: str,
                            args: EventConfigurationsArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def EventConfigurations(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            event_configurations: Optional[Mapping[str, bool]] = None)
    func NewEventConfigurations(ctx *Context, name string, args EventConfigurationsArgs, opts ...ResourceOption) (*EventConfigurations, error)
    public EventConfigurations(string name, EventConfigurationsArgs args, CustomResourceOptions? opts = null)
    public EventConfigurations(String name, EventConfigurationsArgs args)
    public EventConfigurations(String name, EventConfigurationsArgs args, CustomResourceOptions options)
    
    type: aws:iot:EventConfigurations
    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 EventConfigurationsArgs
    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 EventConfigurationsArgs
    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 EventConfigurationsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventConfigurationsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventConfigurationsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var eventConfigurationsResource = new Aws.Iot.EventConfigurations("eventConfigurationsResource", new()
    {
        Configurations = 
        {
            { "string", false },
        },
    });
    
    example, err := iot.NewEventConfigurations(ctx, "eventConfigurationsResource", &iot.EventConfigurationsArgs{
    	EventConfigurations: pulumi.BoolMap{
    		"string": pulumi.Bool(false),
    	},
    })
    
    var eventConfigurationsResource = new EventConfigurations("eventConfigurationsResource", EventConfigurationsArgs.builder()
        .eventConfigurations(Map.of("string", false))
        .build());
    
    event_configurations_resource = aws.iot.EventConfigurations("eventConfigurationsResource", event_configurations={
        "string": False,
    })
    
    const eventConfigurationsResource = new aws.iot.EventConfigurations("eventConfigurationsResource", {eventConfigurations: {
        string: false,
    }});
    
    type: aws:iot:EventConfigurations
    properties:
        eventConfigurations:
            string: false
    

    EventConfigurations 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 EventConfigurations resource accepts the following input properties:

    Configurations Dictionary<string, bool>
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    EventConfigurations map[string]bool
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    eventConfigurations Map<String,Boolean>
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    eventConfigurations {[key: string]: boolean}
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    event_configurations Mapping[str, bool]
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    eventConfigurations Map<Boolean>
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EventConfigurations Resource

    Get an existing EventConfigurations 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?: EventConfigurationsState, opts?: CustomResourceOptions): EventConfigurations
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            event_configurations: Optional[Mapping[str, bool]] = None) -> EventConfigurations
    func GetEventConfigurations(ctx *Context, name string, id IDInput, state *EventConfigurationsState, opts ...ResourceOption) (*EventConfigurations, error)
    public static EventConfigurations Get(string name, Input<string> id, EventConfigurationsState? state, CustomResourceOptions? opts = null)
    public static EventConfigurations get(String name, Output<String> id, EventConfigurationsState 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:
    Configurations Dictionary<string, bool>
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    EventConfigurations map[string]bool
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    eventConfigurations Map<String,Boolean>
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    eventConfigurations {[key: string]: boolean}
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    event_configurations Mapping[str, bool]
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.
    eventConfigurations Map<Boolean>
    Map. The new event configuration values. You can use only these strings as keys: THING_GROUP_HIERARCHY, THING_GROUP_MEMBERSHIP, THING_TYPE, THING_TYPE_ASSOCIATION, THING_GROUP, THING, POLICY, CA_CERTIFICATE, JOB_EXECUTION, CERTIFICATE, JOB. Use boolean for values of mapping.

    Import

    Using pulumi import, import IoT Event Configurations using the AWS Region. For example:

    $ pulumi import aws:iot/eventConfigurations:EventConfigurations example us-west-2
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.59.1 published on Tuesday, Nov 12, 2024 by Pulumi