Package software.amazon.awscdk.services.resourceexplorer2

Interface CfnIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:34.973Z")
@Stability(Stable)
public interface CfnIndexProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIndex.

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.resourceexplorer2.*;
 CfnIndexProps cfnIndexProps = CfnIndexProps.builder()
         .type("type")
         // the properties below are optional
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIndexProps.Builder	builder()
default Map<String,String>	getTags()	The specified tags are attached to only the index created in this AWS Region .
String	getType()	Specifies the type of the index in this Region.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

Specifies the type of the index in this Region.

For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index in the AWS Resource Explorer User Guide. .

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The specified tags are attached to only the index created in this AWS Region .

The tags don't attach to any of the resources listed in the index.

builder

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

Returns:

a CfnIndexProps.Builder of CfnIndexProps