Package software.amazon.awscdk.services.resourceexplorer2

Class CfnIndex

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.resourceexplorer2.CfnIndex
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.972Z") @Stability(Stable) public class CfnIndex extends CfnResource implements IInspectable
A CloudFormation AWS::ResourceExplorer2::Index.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnIndexProps props)
      Create a new AWS::ResourceExplorer2::Index.

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

  • Method Details

    • 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()
      The ARN of the new index for the AWS Region . For example:.

      arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222

    • getAttrIndexState

      @Stability(Stable) @NotNull public String getAttrIndexState()
      Indicates the current state of the index. For example:.

      CREATING

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager 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.

    • getType

      @Stability(Stable) @NotNull public 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. .

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      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. .