CfnCollectionGroupPropsMixin

class aws_cdk.mixins_preview.aws_opensearchserverless.mixins.CfnCollectionGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::OpenSearchServerless::CollectionGroup.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.html
CloudformationResource:: AWS::OpenSearchServerless::CollectionGroup
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_opensearchserverless import mixins as opensearchserverless_mixins

cfn_collection_group_props_mixin = opensearchserverless_mixins.CfnCollectionGroupPropsMixin(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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnCollectionGroupMixinProps, 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:: None

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['capacityLimits', 'description', 'name', 'standbyReplicas', 'tags']

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.

CapacityLimitsProperty

class CfnCollectionGroupPropsMixin.CapacityLimitsProperty(*, max_indexing_capacity_in_ocu=None, max_search_capacity_in_ocu=None, min_indexing_capacity_in_ocu=None, min_search_capacity_in_ocu=None)

Bases: object

Parameters:

max_indexing_capacity_in_ocu (Union[int, float, None]) – The maximum indexing capacity for collections in the group.
max_search_capacity_in_ocu (Union[int, float, None]) – The maximum search capacity for collections in the group.
min_indexing_capacity_in_ocu (Union[int, float, None]) – The minimum indexing capacity for collections in the group.
min_search_capacity_in_ocu (Union[int, float, None]) – The minimum search capacity for collections in the group.

See:

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

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.aws_opensearchserverless import mixins as opensearchserverless_mixins

capacity_limits_property = 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
)

Attributes

max_indexing_capacity_in_ocu

The maximum indexing capacity for collections in the group.

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

max_search_capacity_in_ocu

The maximum search capacity for collections in the group.

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

min_indexing_capacity_in_ocu

The minimum indexing capacity for collections in the group.

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

min_search_capacity_in_ocu

The minimum search capacity for collections in the group.

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