@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:39.531Z")
public class CfnIndex
extends CfnResource
implements IInspectable
Turns on Resource Explorer in the AWS Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.
You can create either a local index that returns search results from only the AWS Region in which the index exists, or you can create an aggregator index that returns search results from all AWS Regions in the AWS account .
For more details about what happens when you turn on Resource Explorer in an AWS Region , see Turning on Resource Explorer to index your resources in an AWS Region in the AWS Resource Explorer User Guide.
If this is the first AWS Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your AWS account that allows Resource Explorer to search for your resources and populate the 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.resourceexplorer2.*;
CfnIndex cfnIndex = CfnIndex.Builder.create(this, "MyCfnIndex")
.type("type")
// the properties below are optional
.tags(Map.of(
"tagsKey", "tags"))
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnIndex.Builder
A fluent builder for
CfnIndex. |
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnIndex(Construct scope,
java.lang.String id,
CfnIndexProps props)
Create a new `AWS::ResourceExplorer2::Index`.
|
protected |
CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnIndex(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAttrArn()
The ARN of the new index for the AWS Region .
|
java.lang.String |
getAttrIndexState()
Indicates the current state of the index.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
TagManager |
getTags()
The specified tags are attached to only the index created in this AWS Region .
|
java.lang.String |
getType()
Specifies the type of the index in this Region.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setType(java.lang.String value)
Specifies the type of the index in this Region.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnIndex(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnIndex(Construct scope, java.lang.String id, CfnIndexProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.public java.lang.String getAttrArn()
arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222
public java.lang.String getAttrIndexState()
CREATING
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic TagManager getTags()
The tags don't attach to any of the resources listed in the index.
public java.lang.String getType()
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. .
public void setType(java.lang.String value)
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. .