CfnIndexPropsMixin

class aws_cdk.mixins_preview.aws_resourceexplorer2.mixins.CfnIndexPropsMixin(props, *, strategy=None)

Bases: 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:

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

CloudformationResource:

AWS::ResourceExplorer2::Index

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_resourceexplorer2 import mixins as resourceexplorer2_mixins

cfn_index_props_mixin = resourceexplorer2_mixins.CfnIndexPropsMixin(resourceexplorer2_mixins.CfnIndexMixinProps(
    tags={
        "tags_key": "tags"
    },
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

• props (Union[CfnIndexMixinProps, Dict[str, Any]]) – L1 properties to apply.

• strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['tags', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental