Package software.amazon.awscdk.services.iotevents

Interface CfnInputProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInputProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:08.537Z")
@Stability(Stable)
public interface CfnInputProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnInput.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotevents.*;
 CfnInputProps cfnInputProps = CfnInputProps.builder()
         .inputDefinition(InputDefinitionProperty.builder()
                 .attributes(List.of(AttributeProperty.builder()
                         .jsonPath("jsonPath")
                         .build()))
                 .build())
         // the properties below are optional
         .inputDescription("inputDescription")
         .inputName("inputName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInputProps.Builder	A builder for CfnInputProps
static final class	CfnInputProps.Jsii$Proxy	An implementation for CfnInputProps

Method Summary

Modifier and Type	Method	Description
static CfnInputProps.Builder	builder()
Object	getInputDefinition()	The definition of the input.
default String	getInputDescription()	A brief description of the input.
default String	getInputName()	The name of the input.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInputDefinition

@Stability(Stable)
@NotNull
Object getInputDefinition()

The definition of the input.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputdefinition

getInputDescription

@Stability(Stable)
@Nullable
default String getInputDescription()

A brief description of the input.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputdescription

getInputName

@Stability(Stable)
@Nullable
default String getInputName()

The name of the input.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-tags

builder

@Stability(Stable)
static CfnInputProps.Builder builder()

Returns:

a CfnInputProps.Builder of CfnInputProps