Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollectionGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.opensearchserverless.CfnCollectionGroup
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ICollectionGroupRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:48.233Z") @Stability(Stable) public class CfnCollectionGroup extends CfnResource implements IInspectable, ICollectionGroupRef, ITaggableV2
Resource Type definition for AWS::OpenSearchServerless::CollectionGroup.

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.*;
 CfnCollectionGroup cfnCollectionGroup = CfnCollectionGroup.Builder.create(this, "MyCfnCollectionGroup")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCollectionGroup

      protected CfnCollectionGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCollectionGroup

      protected CfnCollectionGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCollectionGroup

      @Stability(Stable) public CfnCollectionGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCollectionGroupProps props)
      Create a new AWS::OpenSearchServerless::CollectionGroup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForCollectionGroup

      @Stability(Stable) @NotNull public static String arnForCollectionGroup(@NotNull ICollectionGroupRef resource)
      Parameters:
      resource - This parameter is required.

    • fromCollectionGroupArn

      @Stability(Stable) @NotNull public static ICollectionGroupRef fromCollectionGroupArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICollectionGroupRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromCollectionGroupId

      @Stability(Stable) @NotNull public static ICollectionGroupRef fromCollectionGroupId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String collectionGroupId)
      Creates a new ICollectionGroupRef from a collectionGroupId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      collectionGroupId - This parameter is required.

    • isCfnCollectionGroup

      @Stability(Stable) @NotNull public static Boolean isCfnCollectionGroup(@NotNull Object x)
      Checks whether the given object is a CfnCollectionGroup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the collection group.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier of the collection group.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCollectionGroupRef

      @Stability(Stable) @NotNull public CollectionGroupReference getCollectionGroupRef()
      A reference to a CollectionGroup resource.
      Specified by:
      getCollectionGroupRef in interface ICollectionGroupRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the collection group.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the collection group.

    • getStandbyReplicas

      @Stability(Stable) @NotNull public String getStandbyReplicas()
      Indicates whether standby replicas are used for the collection group.

    • setStandbyReplicas

      @Stability(Stable) public void setStandbyReplicas(@NotNull String value)
      Indicates whether standby replicas are used for the collection group.

    • getCapacityLimits

      @Stability(Stable) @Nullable public Object getCapacityLimits()
      Returns union: either IResolvable or CfnCollectionGroup.CapacityLimitsProperty

    • setCapacityLimits

      @Stability(Stable) public void setCapacityLimits(@Nullable IResolvable value)

    • setCapacityLimits

      @Stability(Stable) public void setCapacityLimits(@Nullable CfnCollectionGroup.CapacityLimitsProperty value)

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the collection group.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the collection group.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.