aws-bedrock-datasource.json

{
  "typeName" : "AWS::Bedrock::DataSource",
  "description" : "Definition of AWS::Bedrock::DataSource Resource Type",
  "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps",
  "definitions" : {
    "ChunkingConfiguration" : {
      "type" : "object",
      "description" : "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.",
      "properties" : {
        "ChunkingStrategy" : {
          "$ref" : "#/definitions/ChunkingStrategy"
        },
        "FixedSizeChunkingConfiguration" : {
          "$ref" : "#/definitions/FixedSizeChunkingConfiguration"
        }
      },
      "required" : [ "ChunkingStrategy" ],
      "additionalProperties" : false
    },
    "ChunkingStrategy" : {
      "type" : "string",
      "description" : "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.",
      "enum" : [ "FIXED_SIZE", "NONE" ]
    },
    "DataSourceConfiguration" : {
      "type" : "object",
      "description" : "Specifies a raw data source location to ingest.",
      "properties" : {
        "Type" : {
          "$ref" : "#/definitions/DataSourceType"
        },
        "S3Configuration" : {
          "$ref" : "#/definitions/S3DataSourceConfiguration"
        }
      },
      "required" : [ "Type", "S3Configuration" ],
      "additionalProperties" : false
    },
    "DataSourceStatus" : {
      "type" : "string",
      "description" : "The status of a data source.",
      "enum" : [ "AVAILABLE", "DELETING", "DELETE_UNSUCCESSFUL" ]
    },
    "DataSourceType" : {
      "type" : "string",
      "description" : "The type of the data source location.",
      "enum" : [ "S3" ]
    },
    "DataDeletionPolicy" : {
      "type" : "string",
      "description" : "The deletion policy for the data source.",
      "enum" : [ "RETAIN", "DELETE" ]
    },
    "FixedSizeChunkingConfiguration" : {
      "type" : "object",
      "description" : "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.",
      "properties" : {
        "MaxTokens" : {
          "type" : "integer",
          "minimum" : 1,
          "description" : "The maximum number of tokens to include in a chunk."
        },
        "OverlapPercentage" : {
          "type" : "integer",
          "maximum" : 99,
          "minimum" : 1,
          "description" : "The percentage of overlap between adjacent chunks of a data source."
        }
      },
      "required" : [ "MaxTokens", "OverlapPercentage" ],
      "additionalProperties" : false
    },
    "S3DataSourceConfiguration" : {
      "type" : "object",
      "description" : "Contains information about the S3 configuration of the data source.",
      "properties" : {
        "BucketArn" : {
          "type" : "string",
          "maxLength" : 2048,
          "minLength" : 1,
          "pattern" : "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
          "description" : "The ARN of the bucket that contains the data source."
        },
        "InclusionPrefixes" : {
          "type" : "array",
          "items" : {
            "type" : "string",
            "maxLength" : 300,
            "minLength" : 1,
            "description" : "Prefix for s3 object."
          },
          "maxItems" : 1,
          "minItems" : 1,
          "description" : "A list of S3 prefixes that define the object containing the data sources.",
          "insertionOrder" : false
        },
        "BucketOwnerAccountId" : {
          "type" : "string",
          "maxLength" : 12,
          "minLength" : 12,
          "pattern" : "^[0-9]{12}$",
          "description" : "The account ID for the owner of the S3 bucket."
        }
      },
      "required" : [ "BucketArn" ],
      "additionalProperties" : false
    },
    "ServerSideEncryptionConfiguration" : {
      "type" : "object",
      "description" : "Contains details about the server-side encryption for the data source.",
      "properties" : {
        "KmsKeyArn" : {
          "type" : "string",
          "maxLength" : 2048,
          "minLength" : 1,
          "pattern" : "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$",
          "description" : "The ARN of the AWS KMS key used to encrypt the resource."
        }
      },
      "additionalProperties" : false
    },
    "VectorIngestionConfiguration" : {
      "type" : "object",
      "description" : "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.",
      "properties" : {
        "ChunkingConfiguration" : {
          "$ref" : "#/definitions/ChunkingConfiguration"
        }
      },
      "additionalProperties" : false
    }
  },
  "properties" : {
    "DataSourceConfiguration" : {
      "$ref" : "#/definitions/DataSourceConfiguration"
    },
    "DataSourceId" : {
      "type" : "string",
      "pattern" : "^[0-9a-zA-Z]{10}$",
      "description" : "Identifier for a resource."
    },
    "Description" : {
      "type" : "string",
      "maxLength" : 200,
      "minLength" : 1,
      "description" : "Description of the Resource."
    },
    "KnowledgeBaseId" : {
      "type" : "string",
      "pattern" : "^[0-9a-zA-Z]{10}$",
      "description" : "The unique identifier of the knowledge base to which to add the data source."
    },
    "DataSourceStatus" : {
      "$ref" : "#/definitions/DataSourceStatus"
    },
    "Name" : {
      "type" : "string",
      "pattern" : "^([0-9a-zA-Z][_-]?){1,100}$",
      "description" : "The name of the data source."
    },
    "ServerSideEncryptionConfiguration" : {
      "$ref" : "#/definitions/ServerSideEncryptionConfiguration"
    },
    "VectorIngestionConfiguration" : {
      "$ref" : "#/definitions/VectorIngestionConfiguration"
    },
    "DataDeletionPolicy" : {
      "$ref" : "#/definitions/DataDeletionPolicy"
    },
    "CreatedAt" : {
      "type" : "string",
      "description" : "The time at which the data source was created."
    },
    "UpdatedAt" : {
      "type" : "string",
      "description" : "The time at which the knowledge base was last updated."
    },
    "FailureReasons" : {
      "type" : "array",
      "items" : {
        "type" : "string",
        "maxLength" : 2048,
        "description" : "Failure Reason for Error."
      },
      "maxItems" : 2048,
      "description" : "The details of the failure reasons related to the data source.",
      "insertionOrder" : false
    }
  },
  "required" : [ "DataSourceConfiguration", "Name", "KnowledgeBaseId" ],
  "readOnlyProperties" : [ "/properties/DataSourceId", "/properties/DataSourceStatus", "/properties/CreatedAt", "/properties/UpdatedAt", "/properties/FailureReasons" ],
  "createOnlyProperties" : [ "/properties/KnowledgeBaseId", "/properties/VectorIngestionConfiguration" ],
  "primaryIdentifier" : [ "/properties/KnowledgeBaseId", "/properties/DataSourceId" ],
  "tagging" : {
    "taggable" : false,
    "cloudFormationSystemTags" : true
  },
  "handlers" : {
    "create" : {
      "permissions" : [ "bedrock:CreateDataSource", "bedrock:GetDataSource", "bedrock:GetKnowledgeBase" ]
    },
    "read" : {
      "permissions" : [ "bedrock:GetDataSource" ]
    },
    "update" : {
      "permissions" : [ "bedrock:GetDataSource", "bedrock:UpdateDataSource" ]
    },
    "delete" : {
      "permissions" : [ "bedrock:GetDataSource", "bedrock:DeleteDataSource" ]
    },
    "list" : {
      "permissions" : [ "bedrock:ListDataSources" ],
      "handlerSchema" : {
        "properties" : {
          "KnowledgeBaseId" : {
            "$ref" : "resource-schema.json#/properties/KnowledgeBaseId"
          }
        },
        "required" : [ "KnowledgeBaseId" ]
      }
    }
  },
  "additionalProperties" : false
}