Package software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless

Interface CfnCollectionGroupMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCollectionGroupMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.019Z")
@Stability(Stable)
public interface CfnCollectionGroupMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnCollectionGroupPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.*;
 CfnCollectionGroupMixinProps cfnCollectionGroupMixinProps = CfnCollectionGroupMixinProps.builder()
         .capacityLimits(CapacityLimitsProperty.builder()
                 .maxIndexingCapacityInOcu(123)
                 .maxSearchCapacityInOcu(123)
                 .minIndexingCapacityInOcu(123)
                 .minSearchCapacityInOcu(123)
                 .build())
         .description("description")
         .name("name")
         .standbyReplicas("standbyReplicas")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCollectionGroupMixinProps.Builder	A builder for CfnCollectionGroupMixinProps
static final class	CfnCollectionGroupMixinProps.Jsii$Proxy	An implementation for CfnCollectionGroupMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnCollectionGroupMixinProps.Builder	builder()
default Object	getCapacityLimits()	Returns union: either IResolvable or CfnCollectionGroupPropsMixin.CapacityLimitsProperty
default String	getDescription()	The description of the collection group.
default String	getName()	The name of the collection group.
default String	getStandbyReplicas()	Indicates whether standby replicas are used for the collection group.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapacityLimits

@Stability(Stable)
@Nullable
default Object getCapacityLimits()

Returns union: either IResolvable or CfnCollectionGroupPropsMixin.CapacityLimitsProperty

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the collection group.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the collection group.

See Also:

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

getStandbyReplicas

@Stability(Stable)
@Nullable
default String getStandbyReplicas()

Indicates whether standby replicas are used for the collection group.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnCollectionGroupMixinProps.Builder builder()

Returns:

a CfnCollectionGroupMixinProps.Builder of CfnCollectionGroupMixinProps