CfnCollectionProps

class aws_cdk.aws_opensearchserverless.CfnCollectionProps(*, name, collection_group_name=None, description=None, encryption_config=None, standby_replicas=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 (-)

  • collection_group_name (Optional[str]) – The name of the collection group to associate with the collection.

  • description (Optional[str]) – A description of the collection.

  • encryption_config (Union[IResolvable, EncryptionConfigProperty, Dict[str, Any], None]) – Encryption settings for the collection.

  • standby_replicas (Optional[str]) – Indicates whether to use standby replicas for the collection. You can’t update this property after the collection is already created. If you attempt to modify this property, the collection continues to use the original value.

  • 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 , TIMESERIES , and VECTORSEARCH . For more information, see Choosing a collection type .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

    # the properties below are optional
    collection_group_name="collectionGroupName",
    description="description",
    encryption_config=opensearchserverless.CfnCollection.EncryptionConfigProperty(
        aws_owned_key=False,
        kms_key_arn="kmsKeyArn"
    ),
    standby_replicas="standbyReplicas",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
)

Attributes

collection_group_name

The name of the collection group to associate with the collection.

See:

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

description

A description of the collection.

See:

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

encryption_config

Encryption settings for the collection.

See:

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

name

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 (-)

See:

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

standby_replicas

Indicates whether to use standby replicas for the collection.

You can’t update this property after the collection is already created. If you attempt to modify this property, the collection continues to use the original value.

See:

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

tags

An arbitrary set of tags (key–value pairs) to associate with the collection.

For more information, see Tag .

See:

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

type

The type of collection.

Possible values are SEARCH , TIMESERIES , and VECTORSEARCH . For more information, see Choosing a collection type .

See:

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