@awboost/cfn-resource-types 0.1.305 → 0.1.306

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type schema for AWS::Batch::SchedulingPolicy
4
+ * Resource Type definition for AWS::Batch::SchedulingPolicy
5
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html}
6
6
  */
7
7
  export type BatchSchedulingPolicyProperties = {
@@ -63,7 +63,7 @@ export type ShareAttributes = {
63
63
  WeightFactor?: number;
64
64
  };
65
65
  /**
66
- * Resource Type schema for AWS::Batch::SchedulingPolicy
66
+ * Resource Type definition for AWS::Batch::SchedulingPolicy
67
67
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html}
68
68
  */
69
69
  export declare class BatchSchedulingPolicy extends $Resource<"AWS::Batch::SchedulingPolicy", BatchSchedulingPolicyProperties, BatchSchedulingPolicyAttributes> {
@@ -1,6 +1,6 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type schema for AWS::Batch::SchedulingPolicy
3
+ * Resource Type definition for AWS::Batch::SchedulingPolicy
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-schedulingpolicy.html}
5
5
  */
6
6
  export class BatchSchedulingPolicy extends $Resource {
@@ -169,7 +169,7 @@ export type KnowledgeBaseStatus = "CREATING" | "ACTIVE" | "DELETING" | "UPDATING
169
169
  * The storage type of a knowledge base.
170
170
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebasestoragetype.html}
171
171
  */
172
- export type KnowledgeBaseStorageType = "OPENSEARCH_SERVERLESS" | "PINECONE" | "RDS" | "MONGO_DB_ATLAS" | "NEPTUNE_ANALYTICS";
172
+ export type KnowledgeBaseStorageType = "OPENSEARCH_SERVERLESS" | "PINECONE" | "RDS" | "MONGO_DB_ATLAS" | "NEPTUNE_ANALYTICS" | "OPENSEARCH_MANAGED_CLUSTER";
173
173
  /**
174
174
  * Type definition for `AWS::Bedrock::KnowledgeBase.KnowledgeBaseType`.
175
175
  * The type of a knowledge base.
@@ -284,6 +284,61 @@ export type NeptuneAnalyticsFieldMapping = {
284
284
  */
285
285
  TextField: string;
286
286
  };
287
+ /**
288
+ * Type definition for `AWS::Bedrock::KnowledgeBase.OpenSearchManagedClusterConfiguration`.
289
+ * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
290
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterconfiguration.html}
291
+ */
292
+ export type OpenSearchManagedClusterConfiguration = {
293
+ /**
294
+ * The Amazon Resource Name (ARN) of the OpenSearch domain.
295
+ * @maxLength `2048`
296
+ * @pattern `^arn:aws(|-cn|-us-gov|-iso):es:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:domain/[a-z][a-z0-9-]{3,28}$`
297
+ */
298
+ DomainArn: string;
299
+ /**
300
+ * The endpoint URL the OpenSearch domain.
301
+ * @maxLength `2048`
302
+ * @pattern `^https://.*$`
303
+ */
304
+ DomainEndpoint: string;
305
+ /**
306
+ * A mapping of Bedrock Knowledge Base fields to OpenSearch Managed Cluster field names
307
+ */
308
+ FieldMapping: OpenSearchManagedClusterFieldMapping;
309
+ /**
310
+ * The name of the vector store.
311
+ * @minLength `1`
312
+ * @maxLength `2048`
313
+ * @pattern `^(?![\-_+.])[a-z0-9][a-z0-9\-_\.]*$`
314
+ */
315
+ VectorIndexName: string;
316
+ };
317
+ /**
318
+ * Type definition for `AWS::Bedrock::KnowledgeBase.OpenSearchManagedClusterFieldMapping`.
319
+ * A mapping of Bedrock Knowledge Base fields to OpenSearch Managed Cluster field names
320
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping.html}
321
+ */
322
+ export type OpenSearchManagedClusterFieldMapping = {
323
+ /**
324
+ * The name of the field in which Amazon Bedrock stores metadata about the vector store.
325
+ * @maxLength `2048`
326
+ * @pattern `^.*$`
327
+ */
328
+ MetadataField: string;
329
+ /**
330
+ * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
331
+ * @maxLength `2048`
332
+ * @pattern `^.*$`
333
+ */
334
+ TextField: string;
335
+ /**
336
+ * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
337
+ * @maxLength `2048`
338
+ * @pattern `^.*$`
339
+ */
340
+ VectorField: string;
341
+ };
287
342
  /**
288
343
  * Type definition for `AWS::Bedrock::KnowledgeBase.OpenSearchServerlessConfiguration`.
289
344
  * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
@@ -753,6 +808,10 @@ export type StorageConfiguration = {
753
808
  * Contains the configurations to use Neptune Analytics as Vector Store.
754
809
  */
755
810
  NeptuneAnalyticsConfiguration?: NeptuneAnalyticsConfiguration;
811
+ /**
812
+ * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
813
+ */
814
+ OpensearchManagedClusterConfiguration?: OpenSearchManagedClusterConfiguration;
756
815
  /**
757
816
  * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
758
817
  */
@@ -540,12 +540,10 @@ export type RDSDBClusterAttributes = {
540
540
  SecretArn: string;
541
541
  };
542
542
  /**
543
- * This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
544
- + ``CreateDBInstance``
545
- + ``DescribeDBInstances``
546
- + ``DeleteDBInstance``
547
-
548
- For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.
543
+ * The ``ReadEndpoint`` return value specifies the reader endpoint for the DB cluster.
544
+ The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
545
+ If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
546
+ For more information about Aurora endpoints, see [Amazon Aurora connection management](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) in the *Amazon Aurora User Guide*.
549
547
  */
550
548
  ReadEndpoint: {
551
549
  /**
@@ -105,8 +105,10 @@ export type RDSDBInstanceProperties = {
105
105
  */
106
106
  AutomaticBackupReplicationRegion?: string;
107
107
  /**
108
- * @min `1`
109
- */
108
+ * The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the ``AutomaticBackupReplicationRegion`` parameter.
109
+ If not specified, this parameter defaults to the value of the ``BackupRetentionPeriod`` parameter. The maximum allowed value is 35.
110
+ * @min `1`
111
+ */
110
112
  AutomaticBackupReplicationRetentionPeriod?: number;
111
113
  /**
112
114
  * The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
@@ -800,8 +802,9 @@ export type RDSDBInstanceProperties = {
800
802
  */
801
803
  export type RDSDBInstanceAttributes = {
802
804
  /**
803
- * The details of the DB instance's server certificate.
804
- */
805
+ * The details of the DB instances server certificate.
806
+ For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
807
+ */
805
808
  CertificateDetails: {
806
809
  /**
807
810
  * The CA identifier of the CA certificate used for the DB instance's server certificate.
@@ -816,8 +819,12 @@ export type RDSDBInstanceAttributes = {
816
819
  DatabaseInsightsMode: string;
817
820
  DbiResourceId: string;
818
821
  /**
819
- * The connection endpoint for the DB instance.
820
- The endpoint might not be shown for instances with the status of ``creating``.
822
+ * This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
823
+ + ``CreateDBInstance``
824
+ + ``DescribeDBInstances``
825
+ + ``DeleteDBInstance``
826
+
827
+ For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.
821
828
  */
822
829
  Endpoint: {
823
830
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.305",
3
+ "version": "0.1.306",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },