Package software.amazon.awscdk.services.iot

Class CfnIndex

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnIndex

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IIndexRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-22T17:37:27.926Z")
@Stability(Stable)
public class CfnIndex
extends CfnResource
implements IInspectable, IIndexRef

Resource Type definition for AWS::IoT::Index.

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.iot.*;
 CfnIndex cfnIndex = CfnIndex.Builder.create(this, "MyCfnIndex")
         .indexName("indexName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-index.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnIndex.Builder	A fluent builder for CfnIndex.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.iot.IIndexRef

IIndexRef.Jsii$Default, IIndexRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIndex(software.amazon.jsii.JsiiObjectRef objRef)
	CfnIndex(software.constructs.Construct scope, String id)	Create a new AWS::IoT::Index.
	CfnIndex(software.constructs.Construct scope, String id, CfnIndexProps props)	Create a new AWS::IoT::Index.

Method Summary

Modifier and Type	Method	Description
static String	arnForIndex(IIndexRef resource)
String	getAttrArn()
String	getAttrId()
String	getAttrIndexStatus()
String	getAttrSchema()
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
String	getIndexName()
IndexReference	getIndexRef()	A reference to a Index resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnIndex(Object x)	Checks whether the given object is a CfnIndex.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setIndexName(String value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnIndex

protected CfnIndex(software.amazon.jsii.JsiiObjectRef objRef)

CfnIndex

protected CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnIndex

@Stability(Stable)
public CfnIndex(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnIndexProps props)

Create a new AWS::IoT::Index.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnIndex

@Stability(Stable)
public CfnIndex(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::IoT::Index.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

arnForIndex

@Stability(Stable)
@NotNull
public static String arnForIndex(@NotNull
 IIndexRef resource)

Parameters:

resource - This parameter is required.

isCfnIndex

@Stability(Stable)
@NotNull
public static Boolean isCfnIndex(@NotNull
 Object x)

Checks whether the given object is a CfnIndex.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getAttrIndexStatus

@Stability(Stable)
@NotNull
public String getAttrIndexStatus()

getAttrSchema

@Stability(Stable)
@NotNull
public String getAttrSchema()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getIndexRef

@Stability(Stable)
@NotNull
public IndexReference getIndexRef()

A reference to a Index resource.

Specified by:

getIndexRef in interface IIndexRef

getIndexName

@Stability(Stable)
@Nullable
public String getIndexName()

setIndexName

@Stability(Stable)
public void setIndexName(@Nullable
 String value)