class CfnIndexPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ResourceExplorer2.Mixins.CfnIndexPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsresourceexplorer2/mixins#CfnIndexPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.resourceexplorer2.mixins.CfnIndexPropsMixin
Python	aws_cdk.mixins_preview.aws_resourceexplorer2.mixins.CfnIndexPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_resourceexplorer2 » mixins » CfnIndexPropsMixin

Implements IMixin

Extends Mixin

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resourceexplorer2-index.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as resourceexplorer2_mixins } from '@aws-cdk/mixins-preview/aws-resourceexplorer2';
const cfnIndexPropsMixin = new resourceexplorer2_mixins.CfnIndexPropsMixin({
  tags: {
    tagsKey: 'tags',
  },
  type: 'type',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnIndexPropsMixin(props: CfnIndexMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnIndexMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ResourceExplorer2::Index.

Properties

Name	Type	Description
props	CfnIndexMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnIndexMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.