Package software.amazon.awscdk.services.opensearchserverless

Interface CfnCollectionGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCollectionGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-02T12:05:13.030Z")
@Stability(Stable)
public interface CfnCollectionGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCollectionGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchserverless.*;
 CfnCollectionGroupProps cfnCollectionGroupProps = CfnCollectionGroupProps.builder()
         .name("name")
         .standbyReplicas("standbyReplicas")
         // the properties below are optional
         .capacityLimits(CapacityLimitsProperty.builder()
                 .maxIndexingCapacityInOcu(123)
                 .maxSearchCapacityInOcu(123)
                 .minIndexingCapacityInOcu(123)
                 .minSearchCapacityInOcu(123)
                 .build())
         .description("description")
         .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	CfnCollectionGroupProps.Builder	A builder for CfnCollectionGroupProps
static final class	CfnCollectionGroupProps.Jsii$Proxy	An implementation for CfnCollectionGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnCollectionGroupProps.Builder	builder()
default Object	getCapacityLimits()	Returns union: either IResolvable or CfnCollectionGroup.CapacityLimitsProperty
default String	getDescription()	The description of the collection group.
String	getName()	The name of the collection group.
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

getName

@Stability(Stable)
@NotNull
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)
@NotNull
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

getCapacityLimits

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

Returns union: either IResolvable or CfnCollectionGroup.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

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 CfnCollectionGroupProps.Builder builder()

Returns:

a CfnCollectionGroupProps.Builder of CfnCollectionGroupProps