CfnCollectionIndexPropsMixin

class aws_cdk.cfn_property_mixins.aws_opensearchserverless.CfnCollectionIndexPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource schema for AWS::OpenSearchServerless::CollectionIndex.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectionindex.html
CloudformationResource:: AWS::OpenSearchServerless::CollectionIndex
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.cfn_property_mixins import aws_opensearchserverless as opensearchserverless
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_collection_index_props_mixin = opensearchserverless.CfnCollectionIndexPropsMixin(opensearchserverless.CfnCollectionIndexMixinProps(
    id="id",
    index_name="indexName",
    index_schema="indexSchema"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::OpenSearchServerless::CollectionIndex.

Parameters:

props (Union[CfnCollectionIndexMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['id', 'indexName', 'indexSchema']

Static Methods

classmethod is_mixin(x)

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.