Interface CfnCollectionProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCollectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.554Z") @Stability(Stable) public interface CfnCollectionProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnCollection.

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.*;
 CfnCollectionProps cfnCollectionProps = CfnCollectionProps.builder()
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 
  • Method Details

    • getName

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

      Collection names must meet the following criteria:

      • Starts with a lowercase letter
      • Unique to your account and AWS Region
      • Contains between 3 and 28 characters
      • Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)
    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description of the collection.
    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An arbitrary set of tags (key–value pairs) to associate with the collection.

      For more information, see Tag .

    • getType

      @Stability(Stable) @Nullable default String getType()
      The type of collection.

      Possible values are SEARCH and TIMESERIES . For more information, see Choosing a collection type .

    • builder

      @Stability(Stable) static CfnCollectionProps.Builder builder()
      Returns:
      a CfnCollectionProps.Builder of CfnCollectionProps