CfnCollectionGroupMixinProps

class aws_cdk.mixins_preview.aws_opensearchserverless.mixins.CfnCollectionGroupMixinProps(*, capacity_limits=None, description=None, name=None, standby_replicas=None, tags=None)

Bases: object

Properties for CfnCollectionGroupPropsMixin.

Parameters:
  • capacity_limits (Union[IResolvable, CapacityLimitsProperty, Dict[str, Any], None])

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

  • name (Optional[str]) – The name of the collection group.

  • standby_replicas (Optional[str]) – Indicates whether standby replicas are used for the collection group.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.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.mixins_preview.aws_opensearchserverless import mixins as opensearchserverless_mixins

cfn_collection_group_mixin_props = opensearchserverless_mixins.CfnCollectionGroupMixinProps(
    capacity_limits=opensearchserverless_mixins.CfnCollectionGroupPropsMixin.CapacityLimitsProperty(
        max_indexing_capacity_in_ocu=123,
        max_search_capacity_in_ocu=123,
        min_indexing_capacity_in_ocu=123,
        min_search_capacity_in_ocu=123
    ),
    description="description",
    name="name",
    standby_replicas="standbyReplicas",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

capacity_limits

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

Type:

see

description

The description of the collection group.

See:

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

name

The name of the collection group.

See:

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

standby_replicas

Indicates whether standby replicas are used for the collection group.

See:

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

tags

An array of key-value pairs to apply to this resource.

See:

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