Package software.amazon.awscdk.services.opensearchserverless

Class CfnCollection.Builder

java.lang.Object
software.amazon.awscdk.services.opensearchserverless.CfnCollection.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCollection>
Enclosing class:
CfnCollection
@Stability(Stable) public static final class CfnCollection.Builder extends Object implements software.amazon.jsii.Builder<CfnCollection>
A fluent builder for CfnCollection.

  • Method Details

    • create

      @Stability(Stable) public static CfnCollection.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnCollection.Builder.

    • name

      @Stability(Stable) public CfnCollection.Builder name(String name)
      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 (-)

      Parameters:
      name - The name of the collection. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnCollection.Builder description(String description)
      A description of the collection.

      Parameters:
      description - A description of the collection. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnCollection.Builder tags(List<? extends CfnTag> tags)
      An arbitrary set of tags (key–value pairs) to associate with the collection.

      For more information, see Tag .

      Parameters:
      tags - An arbitrary set of tags (key–value pairs) to associate with the collection. This parameter is required.
      Returns:
      this

    • type

      @Stability(Stable) public CfnCollection.Builder type(String type)
      The type of collection.

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

      Parameters:
      type - The type of collection. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnCollection build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnCollection>
      Returns:
      a newly built instance of CfnCollection.