CfnCollectionProps

class aws_cdk.aws_opensearchserverless.CfnCollectionProps(*, name, description=None, tags=None, type=None)

Bases: object

Properties for defining a CfnCollection.

Parameters:

name (str) – The name of the collection. Collection names must meet the following criteria: - Starts with a lowercase letter - Unique to your account and AWS Region - Contains between 3 and 28 characters - Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)
description (Optional[str]) – A description of the collection.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An arbitrary set of tags (key–value pairs) to associate with the collection. For more information, see Tag .
type (Optional[str]) – The type of collection. Possible values are SEARCH and TIMESERIES . For more information, see Choosing a collection type .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_opensearchserverless as opensearchserverless

cfn_collection_props = opensearchserverless.CfnCollectionProps(
    name="name",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
)