AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getInput

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.

Using getInput

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInput(args: GetInputArgs, opts?: InvokeOptions): Promise<GetInputResult>
function getInputOutput(args: GetInputOutputArgs, opts?: InvokeOptions): Output<GetInputResult>
def get_input(input_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetInputResult
def get_input_output(input_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetInputResult]
func LookupInput(ctx *Context, args *LookupInputArgs, opts ...InvokeOption) (*LookupInputResult, error)
func LookupInputOutput(ctx *Context, args *LookupInputOutputArgs, opts ...InvokeOption) LookupInputResultOutput

> Note: This function is named LookupInput in the Go SDK.

public static class GetInput 
{
    public static Task<GetInputResult> InvokeAsync(GetInputArgs args, InvokeOptions? opts = null)
    public static Output<GetInputResult> Invoke(GetInputInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInputResult> getInput(GetInputArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:iotevents:getInput
  Arguments:
    # Arguments dictionary

The following arguments are supported:

InputName string

The name of the input.

InputName string

The name of the input.

inputName String

The name of the input.

inputName string

The name of the input.

input_name str

The name of the input.

inputName String

The name of the input.

getInput Result

The following output properties are available:

InputDefinition Pulumi.AwsNative.IoTEvents.Outputs.InputDefinition
InputDescription string

A brief description of the input.

Tags List<Pulumi.AwsNative.IoTEvents.Outputs.InputTag>

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.

Tags []InputTag

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.

tags List<InputTag>

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.

tags InputTag[]

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

For more information, see Tag.

input_definition InputDefinition
input_description str

A brief description of the input.

tags Sequence[InputTag]

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.

tags List<Property Map>

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

For more information, see Tag.

Supporting Types

InputAttribute

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

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

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

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>...

json_path str

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

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>...

InputDefinition

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.

InputTag

Key string

Key of the Tag.

Value string

Value of the Tag.

Key string

Key of the Tag.

Value string

Value of the Tag.

key String

Key of the Tag.

value String

Value of the Tag.

key string

Key of the Tag.

value string

Value of the Tag.

key str

Key of the Tag.

value str

Value of the Tag.

key String

Key of the Tag.

value String

Value of the Tag.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0