Package software.amazon.awscdk.cfnpropertymixins.services.resourceexplorer2

Class CfnIndexPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.resourceexplorer2.CfnIndexPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:04.504Z") @Stability(Stable) public class CfnIndexPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.resourceexplorer2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnIndexPropsMixin cfnIndexPropsMixin = CfnIndexPropsMixin.Builder.create(CfnIndexMixinProps.builder()
         .tags(Map.of(
                 "tagsKey", "tags"))
         .type("type")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnIndexPropsMixin.Builder
    A fluent builder for CfnIndexPropsMixin.

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

    software.amazon.jsii.JsiiObject.InitializationMode

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

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnIndexPropsMixin(CfnIndexMixinProps props)
    Create a mixin to apply properties to AWS::ResourceExplorer2::Index.
     
    CfnIndexPropsMixin(CfnIndexMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::ResourceExplorer2::Index.
    protected
    CfnIndexPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnIndexPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnIndexMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnIndexPropsMixin

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

    • CfnIndexPropsMixin

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

    • CfnIndexPropsMixin

      @Stability(Stable) public CfnIndexPropsMixin(@NotNull CfnIndexMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::ResourceExplorer2::Index.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnIndexPropsMixin

      @Stability(Stable) public CfnIndexPropsMixin(@NotNull CfnIndexMixinProps props)
      Create a mixin to apply properties to AWS::ResourceExplorer2::Index.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnIndexMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()