{
  "typeName" : "AWS::OpenSearchServerless::Collection",
  "description" : "Amazon OpenSearchServerless collection resource",
  "tagging" : {
    "taggable" : true,
    "tagOnCreate" : true,
    "tagUpdatable" : false,
    "cloudFormationSystemTags" : true,
    "tagProperty" : "/properties/Tags"
  },
  "definitions" : {
    "Tag" : {
      "type" : "object",
      "description" : "A key-value pair metadata associated with resource",
      "properties" : {
        "Key" : {
          "type" : "string",
          "maxLength" : 128,
          "minLength" : 1,
          "description" : "The key in the key-value pair"
        },
        "Value" : {
          "type" : "string",
          "maxLength" : 256,
          "minLength" : 0,
          "description" : "The value in the key-value pair"
        }
      },
      "required" : [ "Key", "Value" ],
      "additionalProperties" : false
    },
    "CollectionType" : {
      "type" : "string",
      "description" : "The possible types for the collection",
      "enum" : [ "SEARCH", "TIMESERIES", "VECTORSEARCH" ]
    },
    "StandbyReplicas" : {
      "type" : "string",
      "description" : "The possible standby replicas for the collection",
      "enum" : [ "ENABLED", "DISABLED" ]
    },
    "DeletionProtection" : {
      "type" : "string",
      "description" : "The deletion protection state of the collection",
      "enum" : [ "ENABLED", "DISABLED" ]
    },
    "ServerlessVectorAcceleration" : {
      "type" : "string",
      "description" : "Indicates whether GPU acceleration is enabled for vector indexing",
      "enum" : [ "ENABLED", "DISABLED", "ALLOWED" ]
    },
    "VectorOptions" : {
      "type" : "object",
      "description" : "Vector search configuration options for the collection",
      "properties" : {
        "ServerlessVectorAcceleration" : {
          "$ref" : "#/definitions/ServerlessVectorAcceleration"
        }
      },
      "additionalProperties" : false
    },
    "EncryptionConfig" : {
      "type" : "object",
      "description" : "Encryption settings for the collection",
      "properties" : {
        "AWSOwnedKey" : {
          "type" : "boolean",
          "description" : "Indicates whether to use an AWS owned key for encryption."
        },
        "KmsKeyArn" : {
          "type" : "string",
          "description" : "Key Management Service key used to encrypt the collection."
        }
      },
      "additionalProperties" : false
    },
    "FipsEndpoints" : {
      "type" : "object",
      "properties" : {
        "CollectionEndpoint" : {
          "type" : "string"
        },
        "DashboardEndpoint" : {
          "type" : "string"
        }
      },
      "additionalProperties" : false
    }
  },
  "properties" : {
    "Description" : {
      "type" : "string",
      "maxLength" : 1000,
      "description" : "The description of the collection"
    },
    "Id" : {
      "type" : "string",
      "maxLength" : 40,
      "minLength" : 3,
      "description" : "The identifier of the collection"
    },
    "Name" : {
      "type" : "string",
      "maxLength" : 64,
      "minLength" : 3,
      "pattern" : "^[a-z][a-z0-9-]{2,63}$",
      "description" : "The name of the collection.\n\nThe name must meet the following criteria:\nUnique to your account and AWS Region\nStarts with a lowercase letter\nContains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)\nContains between 3 and 64 characters\n"
    },
    "Tags" : {
      "type" : "array",
      "items" : {
        "$ref" : "#/definitions/Tag"
      },
      "maxItems" : 50,
      "minItems" : 0,
      "insertionOrder" : false,
      "description" : "List of tags to be added to the resource"
    },
    "Arn" : {
      "description" : "The Amazon Resource Name (ARN) of the collection.",
      "type" : "string"
    },
    "CollectionEndpoint" : {
      "description" : "The endpoint for the collection.",
      "type" : "string"
    },
    "DashboardEndpoint" : {
      "description" : "The OpenSearch Dashboards endpoint for the collection.",
      "type" : "string"
    },
    "Type" : {
      "$ref" : "#/definitions/CollectionType"
    },
    "StandbyReplicas" : {
      "$ref" : "#/definitions/StandbyReplicas"
    },
    "DeletionProtection" : {
      "$ref" : "#/definitions/DeletionProtection"
    },
    "CollectionGroupName" : {
      "type" : "string",
      "description" : "The name of the collection group to associate with the collection."
    },
    "EncryptionConfig" : {
      "$ref" : "#/definitions/EncryptionConfig"
    },
    "VectorOptions" : {
      "$ref" : "#/definitions/VectorOptions"
    },
    "KmsKeyArn" : {
      "type" : "string",
      "description" : "Key Management Service key used to encrypt the collection."
    },
    "FipsEndpoints" : {
      "$ref" : "#/definitions/FipsEndpoints"
    }
  },
  "required" : [ "Name" ],
  "readOnlyProperties" : [ "/properties/Id", "/properties/Arn", "/properties/CollectionEndpoint", "/properties/DashboardEndpoint", "/properties/FipsEndpoints", "/properties/KmsKeyArn" ],
  "writeOnlyProperties" : [ "/properties/Tags", "/properties/EncryptionConfig" ],
  "createOnlyProperties" : [ "/properties/Name", "/properties/Tags", "/properties/Type", "/properties/StandbyReplicas", "/properties/CollectionGroupName", "/properties/EncryptionConfig" ],
  "primaryIdentifier" : [ "/properties/Id" ],
  "additionalIdentifiers" : [ [ "/properties/Name" ], [ "/properties/Arn" ] ],
  "handlers" : {
    "create" : {
      "permissions" : [ "aoss:CreateCollection", "aoss:BatchGetCollection", "aoss:AddCollectionToCollectionGroup", "iam:CreateServiceLinkedRole", "kms:CreateGrant", "kms:DescribeKey" ]
    },
    "delete" : {
      "permissions" : [ "aoss:DeleteCollection", "aoss:BatchGetCollection" ]
    },
    "list" : {
      "permissions" : [ "aoss:ListCollections" ]
    },
    "read" : {
      "permissions" : [ "aoss:BatchGetCollection" ]
    },
    "update" : {
      "permissions" : [ "aoss:UpdateCollection", "aoss:BatchGetCollection" ]
    }
  },
  "additionalProperties" : false
}