AWS Native v0.103.0, Apr 22 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotevents.Input

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as inputs to AWS IoT Events. For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide.

Example Usage

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myInput = new AwsNative.IoTEvents.Input("myInput", new()
    {
        InputName = "myInput",
        InputDescription = "My Input created by CloudFormation",
        InputDefinition = new AwsNative.IoTEvents.Inputs.InputDefinitionArgs
        {
            Attributes = new[]
            {
                new AwsNative.IoTEvents.Inputs.InputAttributeArgs
                {
                    JsonPath = "foo",
                },
                new AwsNative.IoTEvents.Inputs.InputAttributeArgs
                {
                    JsonPath = "bar",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iotevents"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iotevents.NewInput(ctx, "myInput", &iotevents.InputArgs{
			InputName:        pulumi.String("myInput"),
			InputDescription: pulumi.String("My Input created by CloudFormation"),
			InputDefinition: &iotevents.InputDefinitionArgs{
				Attributes: iotevents.InputAttributeArray{
					&iotevents.InputAttributeArgs{
						JsonPath: pulumi.String("foo"),
					},
					&iotevents.InputAttributeArgs{
						JsonPath: pulumi.String("bar"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

my_input = aws_native.iotevents.Input("myInput",
    input_name="myInput",
    input_description="My Input created by CloudFormation",
    input_definition=aws_native.iotevents.InputDefinitionArgs(
        attributes=[
            aws_native.iotevents.InputAttributeArgs(
                json_path="foo",
            ),
            aws_native.iotevents.InputAttributeArgs(
                json_path="bar",
            ),
        ],
    ))

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myInput = new aws_native.iotevents.Input("myInput", {
    inputName: "myInput",
    inputDescription: "My Input created by CloudFormation",
    inputDefinition: {
        attributes: [
            {
                jsonPath: "foo",
            },
            {
                jsonPath: "bar",
            },
        ],
    },
});

Coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myInput = new AwsNative.IoTEvents.Input("myInput", new()
    {
        InputName = "myInput",
        InputDescription = "My Input created by CloudFormation",
        InputDefinition = new AwsNative.IoTEvents.Inputs.InputDefinitionArgs
        {
            Attributes = new[]
            {
                new AwsNative.IoTEvents.Inputs.InputAttributeArgs
                {
                    JsonPath = "foo",
                },
                new AwsNative.IoTEvents.Inputs.InputAttributeArgs
                {
                    JsonPath = "bar",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iotevents"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iotevents.NewInput(ctx, "myInput", &iotevents.InputArgs{
			InputName:        pulumi.String("myInput"),
			InputDescription: pulumi.String("My Input created by CloudFormation"),
			InputDefinition: &iotevents.InputDefinitionArgs{
				Attributes: iotevents.InputAttributeArray{
					&iotevents.InputAttributeArgs{
						JsonPath: pulumi.String("foo"),
					},
					&iotevents.InputAttributeArgs{
						JsonPath: pulumi.String("bar"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

my_input = aws_native.iotevents.Input("myInput",
    input_name="myInput",
    input_description="My Input created by CloudFormation",
    input_definition=aws_native.iotevents.InputDefinitionArgs(
        attributes=[
            aws_native.iotevents.InputAttributeArgs(
                json_path="foo",
            ),
            aws_native.iotevents.InputAttributeArgs(
                json_path="bar",
            ),
        ],
    ))

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myInput = new aws_native.iotevents.Input("myInput", {
    inputName: "myInput",
    inputDescription: "My Input created by CloudFormation",
    inputDefinition: {
        attributes: [
            {
                jsonPath: "foo",
            },
            {
                jsonPath: "bar",
            },
        ],
    },
});

Coming soon!

Create Input Resource

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

Constructor syntax

new Input(name: string, args: InputArgs, opts?: CustomResourceOptions);

@overload
def Input(resource_name: str,
          args: InputArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Input(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          input_definition: Optional[InputDefinitionArgs] = None,
          input_description: Optional[str] = None,
          input_name: Optional[str] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)

func NewInput(ctx *Context, name string, args InputArgs, opts ...ResourceOption) (*Input, error)

public Input(string name, InputArgs args, CustomResourceOptions? opts = null)

public Input(String name, InputArgs args)
public Input(String name, InputArgs args, CustomResourceOptions options)

type: aws-native:iotevents:Input
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 InputArgs: 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 InputArgs: 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 InputArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

Example

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

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const inputResource = new aws_native.iotevents.Input("inputResource", {
    inputDefinition: {
        attributes: [{
            jsonPath: "string",
        }],
    },
    inputDescription: "string",
    inputName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

Coming soon!

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

InputDefinition Pulumi.AwsNative.IoTEvents.Inputs.InputDefinition

InputDescription string

A brief description of the input.

InputName string

The name of the input.

Tags List<Pulumi.AwsNative.Inputs.Tag>

An array of key-value pairs to apply to this resource.

For more information, see Tag.

InputDefinition InputDefinitionArgs

InputDescription string

A brief description of the input.

InputName string

The name of the input.

Tags TagArgs

An array of key-value pairs to apply to this resource.

For more information, see Tag.

inputDefinition InputDefinition

inputDescription String

A brief description of the input.

inputName String

The name of the input.

tags List<Tag>

An array of key-value pairs to apply to this resource.

For more information, see Tag.

inputDefinition InputDefinition

inputDescription string

A brief description of the input.

inputName string

The name of the input.

tags Tag[]

An array of key-value pairs to apply to this resource.

For more information, see Tag.

input_definition InputDefinitionArgs

input_description str

A brief description of the input.

input_name str

The name of the input.

tags Sequence[TagArgs]

An array of key-value pairs to apply to this resource.

For more information, see Tag.

inputDefinition Property Map

inputDescription String

A brief description of the input.

inputName String

The name of the input.

tags List<Property Map>

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Outputs

All input properties are implicitly available as output properties. Additionally, the Input 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.

Supporting Types

InputAttribute, InputAttributeArgs

JsonPath string

An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.

Syntax: <field-name>.<field-name>...

JsonPath string

Syntax: <field-name>.<field-name>...

jsonPath String

Syntax: <field-name>.<field-name>...

jsonPath string

Syntax: <field-name>.<field-name>...

json_path str

Syntax: <field-name>.<field-name>...

jsonPath String

Syntax: <field-name>.<field-name>...

InputDefinition, InputDefinitionArgs

Attributes List<Pulumi.AwsNative.IoTEvents.Inputs.InputAttribute>: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.

Attributes []InputAttribute: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.

attributes List<InputAttribute>: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.

attributes InputAttribute[]: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.

attributes Sequence[InputAttribute]: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.

attributes List<Property Map>: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.

Tag, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotevents.Input

On this page

On this page

Example Usage

Example

Example

Create Input Resource

Constructor syntax

Parameters

Example

Input Resource Properties

Inputs

Outputs

Supporting Types

InputAttribute, InputAttributeArgs

InputDefinition, InputDefinitionArgs

Tag, TagArgs

Package Details

On this page

On this page