@propulsionworks/cloudformation 0.1.33 → 0.1.34

package/out/exports/resources.generated/aws-quicksight-datasource.d.ts

@@ -400,7 +400,7 @@ export type DataSourceParameters = {
 /**
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcetype.html}
  */
-export type DataSourceType = "ADOBE_ANALYTICS" | "AMAZON_ELASTICSEARCH" | "AMAZON_OPENSEARCH" | "ATHENA" | "AURORA" | "AURORA_POSTGRESQL" | "AWS_IOT_ANALYTICS" | "DATABRICKS" | "DENODO" | "DREMIO" | "DYNAMODB" | "SAPHANA" | "DB2_AS400" | "EXASOL" | "FILE" | "GITHUB" | "JIRA" | "MARIADB" | "MYSQL" | "ORACLE" | "POSTGRESQL" | "PRESTO" | "QBUSINESS" | "REDSHIFT" | "S3" | "S3_TABLES" | "S3_KNOWLEDGE_BASE" | "SALESFORCE" | "SERVICENOW" | "SNOWFLAKE" | "SPARK" | "SPICE" | "SQLSERVER" | "TERADATA" | "TIMESTREAM" | "TWITTER" | "BIGQUERY" | "GOOGLE_ANALYTICS" | "TRINO" | "STARBURST" | "MONGO" | "MONGO_ATLAS" | "DOCUMENTDB" | "APPFLOW" | "IMPALA" | "GLUE" | "GOOGLE_DRIVE" | "CONFLUENCE" | "SHAREPOINT" | "ONE_DRIVE" | "WEB_CRAWLER";
+export type DataSourceType = "ADOBE_ANALYTICS" | "AMAZON_ELASTICSEARCH" | "AMAZON_OPENSEARCH" | "ATHENA" | "AURORA" | "AURORA_POSTGRESQL" | "AWS_IOT_ANALYTICS" | "DATABRICKS" | "DENODO" | "DREMIO" | "DYNAMODB" | "SAPHANA" | "DB2_AS400" | "EXASOL" | "FILE" | "GITHUB" | "INTERNATIONAL_DATA_CORPORATION" | "JIRA" | "MARIADB" | "MYSQL" | "ORACLE" | "POSTGRESQL" | "PRESTO" | "QBUSINESS" | "REDSHIFT" | "S3" | "S3_TABLES" | "S3_KNOWLEDGE_BASE" | "SALESFORCE" | "SERVICENOW" | "SNOWFLAKE" | "SPARK" | "SPICE" | "SQLSERVER" | "TERADATA" | "TIMESTREAM" | "TWITTER" | "BIGQUERY" | "GOOGLE_ANALYTICS" | "TRINO" | "STARBURST" | "MONGO" | "MONGO_ATLAS" | "DOCUMENTDB" | "APPFLOW" | "IMPALA" | "GLUE" | "GOOGLE_DRIVE" | "CONFLUENCE" | "SHAREPOINT" | "ONE_DRIVE" | "WEB_CRAWLER";
 /**
  * The required parameters that are needed to connect to a Databricks data source.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.html}

package/out/exports/resources.generated/aws-quicksight-template.d.ts

@@ -10628,7 +10628,7 @@ export type SheetDefinition = {
      */
     Layouts?: Layout[] | undefined;
     /**
-     * The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
+     * The name of the sheet. This name is displayed on the sheet's tab in the Quick Suite console.
      * @minLength 1
      * @maxLength 2048
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-name}

package/out/exports/resources.generated/aws-rtbfabric-link.d.ts

@@ -1,27 +1,35 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
 /**
- * Resource Type definition for AWS::RTBFabric::Link Resource Type
+ * Creates a new link between gateways.
+ *
+ * Establishes a connection that allows gateways to communicate and exchange bid requests and responses.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html}
  */
 export type RTBFabricLink = ResourceDefinitionWithAttributes<"AWS::RTBFabric::Link", RTBFabricLinkProps, RTBFabricLinkAttribs>;
 /**
- * Resource Type definition for AWS::RTBFabric::Link Resource Type
+ * Creates a new link between gateways.
+ *
+ * Establishes a connection that allows gateways to communicate and exchange bid requests and responses.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html}
  */
 export type RTBFabricLinkProps = {
     /**
+     * The unique identifier of the gateway.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-gatewayid}
      */
     GatewayId: string;
     /**
+     * Boolean to specify if an HTTP responder is allowed.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-httpresponderallowed}
      */
     HttpResponderAllowed?: boolean | undefined;
     /**
+     * Attributes of the link.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-linkattributes}
      */
     LinkAttributes?: LinkAttributes | undefined;
     /**
+     * Settings for the application logs.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-linklogsettings}
      */
     LinkLogSettings: LinkLogSettings;
@@ -30,11 +38,12 @@ export type RTBFabricLinkProps = {
      */
     ModuleConfigurationList?: ModuleConfiguration[] | undefined;
     /**
+     * The unique identifier of the peer gateway.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-peergatewayid}
      */
     PeerGatewayId: string;
     /**
-     * Tags to assign to the Link.
+     * A map of the key-value pairs of the tag or tags to assign to the resource.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-tags}
      */
     Tags?: Tag[] | undefined;
@@ -56,6 +65,7 @@ export type RTBFabricLinkAttribs = {
      */
     LinkDirection: LinkDirection;
     /**
+     * The unique identifier of the link.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-linkid}
      */
     LinkId: string;
@@ -69,49 +79,60 @@ export type RTBFabricLinkAttribs = {
     UpdatedTimestamp: string;
 };
 /**
+ * Describes the configuration of a filter.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filter.html}
  */
 export type Filter = {
     /**
+     * Describes the criteria for a filter.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filter.html#cfn-rtbfabric-link-filter-criteria}
      */
     Criteria: FilterCriterion[];
 };
 /**
+ * Describes the criteria for a filter.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filtercriterion.html}
  */
 export type FilterCriterion = {
     /**
+     * The path to filter.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filtercriterion.html#cfn-rtbfabric-link-filtercriterion-path}
      */
     Path: string;
     /**
+     * The value to filter.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filtercriterion.html#cfn-rtbfabric-link-filtercriterion-values}
      */
     Values: string[];
 };
 /**
+ * Describes the header tag for a bid action.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-headertagaction.html}
  */
 export type HeaderTagAction = {
     /**
+     * The name of the bid action.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-headertagaction.html#cfn-rtbfabric-link-headertagaction-name}
      */
     Name: string;
     /**
+     * The value of the bid action.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-headertagaction.html#cfn-rtbfabric-link-headertagaction-value}
      */
     Value: string;
 };
 /**
+ * Describes the attributes of a link.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linkattributes.html}
  */
 export type LinkAttributes = {
     /**
+     * The customer-provided unique identifier of the link.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linkattributes.html#cfn-rtbfabric-link-linkattributes-customerprovidedid}
      */
     CustomerProvidedId?: string | undefined;
     /**
+     * Describes the masking for HTTP error codes.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linkattributes.html#cfn-rtbfabric-link-linkattributes-respondererrormasking}
      */
     ResponderErrorMasking?: ResponderErrorMaskingForHttpCode[] | undefined;
@@ -121,10 +142,12 @@ export type LinkAttributes = {
  */
 export type LinkDirection = "REQUEST" | "RESPONSE";
 /**
+ * Describes the settings for a link log.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linklogsettings.html}
  */
 export type LinkLogSettings = {
     /**
+     * Describes the configuration of a link application log.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linklogsettings.html#cfn-rtbfabric-link-linklogsettings-applicationlogs}
      */
     ApplicationLogs: {
@@ -147,29 +170,35 @@ export type LinkLogSettings = {
  */
 export type LinkStatus = "PENDING_CREATION" | "PENDING_REQUEST" | "REQUESTED" | "ACCEPTED" | "ACTIVE" | "DECLINED" | "FAILED" | "PENDING_DELETION" | "DELETED" | "PENDING_UPDATE" | "PENDING_ISOLATION" | "ISOLATED" | "PENDING_RESTORATION" | "UNKNOWN_TO_SDK_VERSION";
 /**
+ * Describes the configuration of a module.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html}
  */
 export type ModuleConfiguration = {
     /**
+     * The dependencies of the module.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html#cfn-rtbfabric-link-moduleconfiguration-dependson}
      */
     DependsOn?: string[] | undefined;
     /**
+     * Describes the parameters of a module.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html#cfn-rtbfabric-link-moduleconfiguration-moduleparameters}
      */
     ModuleParameters?: ModuleParameters | undefined;
     /**
+     * The name of the module.
      * @pattern ^[A-Za-z0-9 -]+$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html#cfn-rtbfabric-link-moduleconfiguration-name}
      */
     Name: string;
     /**
+     * The version of the module.
      * @pattern ^[a-z0-9]{1,25}$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html#cfn-rtbfabric-link-moduleconfiguration-version}
      */
     Version?: string | undefined;
 };
 /**
+ * Describes the parameters of a module.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleparameters.html}
  */
 export type ModuleParameters = {
@@ -178,26 +207,31 @@ export type ModuleParameters = {
     OpenRtbAttribute: OpenRtbAttributeModuleParameters;
 };
 /**
+ * Describes a no bid action.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidaction.html}
  */
 export type NoBidAction = {
     /**
+     * The reason code for the no bid action.
      * @min 0
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidaction.html#cfn-rtbfabric-link-nobidaction-nobidreasoncode}
      */
     NoBidReasonCode?: number | undefined;
 };
 /**
+ * Describes the parameters of a no bid module.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidmoduleparameters.html}
  */
 export type NoBidModuleParameters = {
     /**
+     * The pass through percentage.
      * @min 0
      * @max 100
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidmoduleparameters.html#cfn-rtbfabric-link-nobidmoduleparameters-passthroughpercentage}
      */
     PassThroughPercentage?: number | undefined;
     /**
+     * The reason description.
      * @minLength 1
      * @maxLength 50
      * @pattern ^[a-zA-Z0-9]*$
@@ -205,6 +239,7 @@ export type NoBidModuleParameters = {
      */
     Reason?: string | undefined;
     /**
+     * The reason code.
      * @min 0
      * @max 10
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidmoduleparameters.html#cfn-rtbfabric-link-nobidmoduleparameters-reasoncode}
@@ -212,10 +247,12 @@ export type NoBidModuleParameters = {
     ReasonCode?: number | undefined;
 };
 /**
+ * Describes the parameters of an open RTB attribute module.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html}
  */
 export type OpenRtbAttributeModuleParameters = {
     /**
+     * Describes a bid action.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html#cfn-rtbfabric-link-openrtbattributemoduleparameters-action}
      */
     Action: {
@@ -224,14 +261,17 @@ export type OpenRtbAttributeModuleParameters = {
         HeaderTag: HeaderTagAction;
     };
     /**
+     * Describes the configuration of a filter.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html#cfn-rtbfabric-link-openrtbattributemoduleparameters-filterconfiguration}
      */
     FilterConfiguration: Filter[];
     /**
+     * The filter type.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html#cfn-rtbfabric-link-openrtbattributemoduleparameters-filtertype}
      */
     FilterType: "INCLUDE" | "EXCLUDE";
     /**
+     * The hold back percentage.
      * @min 0
      * @max 100
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html#cfn-rtbfabric-link-openrtbattributemoduleparameters-holdbackpercentage}
@@ -239,14 +279,17 @@ export type OpenRtbAttributeModuleParameters = {
     HoldbackPercentage: number;
 };
 /**
+ * Describes the masking for HTTP error codes.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.html}
  */
 export type ResponderErrorMaskingForHttpCode = {
     /**
+     * The action for the error..
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.html#cfn-rtbfabric-link-respondererrormaskingforhttpcode-action}
      */
     Action: "NO_BID" | "PASSTHROUGH";
     /**
+     * The HTTP error code.
      * @minLength 3
      * @maxLength 7
      * @pattern ^DEFAULT|4XX|5XX|\d{3}$
@@ -254,10 +297,12 @@ export type ResponderErrorMaskingForHttpCode = {
      */
     HttpCode: string;
     /**
+     * The error log type.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.html#cfn-rtbfabric-link-respondererrormaskingforhttpcode-loggingtypes}
      */
     LoggingTypes: ResponderErrorMaskingLoggingType[];
     /**
+     * The percentage of response logging.
      * @min 0
      * @max 100
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.html#cfn-rtbfabric-link-respondererrormaskingforhttpcode-responseloggingpercentage}

package/out/exports/resources.generated/aws-rtbfabric-requestergateway.d.ts

@@ -1,34 +1,36 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
 /**
- * Resource Type definition for AWS::RTBFabric::RequesterGateway Resource Type.
+ * Creates a requester gateway.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-requestergateway.html}
  */
 export type RTBFabricRequesterGateway = ResourceDefinitionWithAttributes<"AWS::RTBFabric::RequesterGateway", RTBFabricRequesterGatewayProps, RTBFabricRequesterGatewayAttribs>;
 /**
- * Resource Type definition for AWS::RTBFabric::RequesterGateway Resource Type.
+ * Creates a requester gateway.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-requestergateway.html}
  */
 export type RTBFabricRequesterGatewayProps = {
     /**
+     * An optional description for the requester gateway.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-requestergateway.html#cfn-rtbfabric-requestergateway-description}
      */
     Description?: string | undefined;
     /**
-     * The ID of one or more security groups in order to create a requester gateway.
+     * The unique identifiers of the security groups.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-requestergateway.html#cfn-rtbfabric-requestergateway-securitygroupids}
      */
     SecurityGroupIds: string[];
     /**
-     * The ID of one or more subnets in order to create a requester gateway.
+     * The unique identifiers of the subnets.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-requestergateway.html#cfn-rtbfabric-requestergateway-subnetids}
      */
     SubnetIds: string[];
     /**
-     * Tags to assign to the Requester Gateway.
+     * A map of the key-value pairs of the tag or tags to assign to the resource.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-requestergateway.html#cfn-rtbfabric-requestergateway-tags}
      */
     Tags?: Tag[] | undefined;
     /**
+     * The unique identifier of the Virtual Private Cloud (VPC).
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-requestergateway.html#cfn-rtbfabric-requestergateway-vpcid}
      */
     VpcId: string;

package/out/exports/resources.generated/aws-rtbfabric-respondergateway.d.ts

@@ -1,54 +1,65 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
 /**
- * Resource Type definition for AWS::RTBFabric::ResponderGateway Resource Type
+ * Creates a responder gateway.
+ *
+ * > A domain name or managed endpoint is required.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html}
  */
 export type RTBFabricResponderGateway = ResourceDefinitionWithAttributes<"AWS::RTBFabric::ResponderGateway", RTBFabricResponderGatewayProps, RTBFabricResponderGatewayAttribs>;
 /**
- * Resource Type definition for AWS::RTBFabric::ResponderGateway Resource Type
+ * Creates a responder gateway.
+ *
+ * > A domain name or managed endpoint is required.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html}
  */
 export type RTBFabricResponderGatewayProps = {
     /**
+     * An optional description for the responder gateway.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-description}
      */
     Description?: string | undefined;
     /**
+     * The domain name for the responder gateway.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-domainname}
      */
     DomainName?: string | undefined;
     /**
+     * The configuration for the managed endpoint.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-managedendpointconfiguration}
      */
     ManagedEndpointConfiguration?: ManagedEndpointConfiguration | undefined;
     /**
+     * The networking port to use.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-port}
      */
     Port: number;
     /**
+     * The networking protocol to use.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-protocol}
      */
     Protocol: Protocol;
     /**
-     * The ID of one or more security groups in order to create a gateway.
+     * The unique identifiers of the security groups.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-securitygroupids}
      */
     SecurityGroupIds: string[];
     /**
-     * The ID of one or more subnets in order to create a gateway.
+     * The unique identifiers of the subnets.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-subnetids}
      */
     SubnetIds: string[];
     /**
-     * Tags to assign to the Responder Gateway.
+     * A map of the key-value pairs of the tag or tags to assign to the resource.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-tags}
      */
     Tags?: Tag[] | undefined;
     /**
+     * The configuration of the trust store.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-truststoreconfiguration}
      */
     TrustStoreConfiguration?: TrustStoreConfiguration | undefined;
     /**
+     * The unique identifier of the Virtual Private Cloud (VPC).
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-respondergateway.html#cfn-rtbfabric-respondergateway-vpcid}
      */
     VpcId: string;
@@ -79,29 +90,35 @@ export type RTBFabricResponderGatewayAttribs = {
     UpdatedTimestamp: string;
 };
 /**
+ * Describes the configuration of an auto scaling group.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html}
  */
 export type AutoScalingGroupsConfiguration = {
     /**
+     * The names of the auto scaling group.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html#cfn-rtbfabric-respondergateway-autoscalinggroupsconfiguration-autoscalinggroupnamelist}
      */
     AutoScalingGroupNameList: string[];
     /**
+     * The role ARN of the auto scaling group.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-autoscalinggroupsconfiguration.html#cfn-rtbfabric-respondergateway-autoscalinggroupsconfiguration-rolearn}
      */
     RoleArn: string;
 };
 /**
+ * Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html}
  */
 export type EksEndpointsConfiguration = {
     /**
+     * The CA certificate chain of the cluster API server.
      * @minLength 1
      * @maxLength 2097152
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-clusterapiservercacertificatechain}
      */
     ClusterApiServerCaCertificateChain: string;
     /**
+     * The URI of the cluster API server endpoint.
      * @minLength 0
      * @maxLength 255
      * @pattern ^(https|http)://(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)(?:\.(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?))+$
@@ -109,26 +126,31 @@ export type EksEndpointsConfiguration = {
      */
     ClusterApiServerEndpointUri: string;
     /**
+     * The name of the cluster.
      * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-clustername}
      */
     ClusterName: string;
     /**
+     * The name of the endpoint resource.
      * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-endpointsresourcename}
      */
     EndpointsResourceName: string;
     /**
+     * The namespace of the endpoint resource.
      * @pattern ^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-endpointsresourcenamespace}
      */
     EndpointsResourceNamespace: string;
     /**
+     * The role ARN for the cluster.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-eksendpointsconfiguration.html#cfn-rtbfabric-respondergateway-eksendpointsconfiguration-rolearn}
      */
     RoleArn: string;
 };
 /**
+ * Describes the configuration of a managed endpoint.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-managedendpointconfiguration.html}
  */
 export type ManagedEndpointConfiguration = {
@@ -145,10 +167,12 @@ export type Protocol = "HTTP" | "HTTPS";
  */
 export type ResponderGatewayStatus = "PENDING_CREATION" | "ACTIVE" | "PENDING_DELETION" | "DELETED" | "ERROR" | "PENDING_UPDATE" | "ISOLATED" | "PENDING_ISOLATION" | "PENDING_RESTORATION";
 /**
+ * Describes the configuration of a trust store.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-truststoreconfiguration.html}
  */
 export type TrustStoreConfiguration = {
     /**
+     * The certificate authority certificate.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-respondergateway-truststoreconfiguration.html#cfn-rtbfabric-respondergateway-truststoreconfiguration-certificateauthoritycertificates}
      */
     CertificateAuthorityCertificates: string[];

package/out/exports/resources.generated/aws-s3vectors-index.d.ts

@@ -1,31 +1,82 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
 /**
- * Resource Type definition for AWS::S3Vectors::Index
+ * The `AWS::S3Vectors::Index` resource defines a vector index within an Amazon S3 vector bucket. For more information, see [Creating a vector index in a vector bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-create-index.html) in the *Amazon Simple Storage Service User Guide* .
+ *
+ * You must specify either `VectorBucketName` or `VectorBucketArn` to identify the bucket that contains the index.
+ *
+ * To control how AWS CloudFormation handles the vector index when the stack is deleted, you can set a deletion policy for your index. You can choose to *retain* the index or to *delete* the index. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
+ *
+ * - **Permissions** - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
+ *
+ * - Create
+ *
+ * - s3vectors:CreateIndex
+ * - s3vectors:GetIndex
+ * - Read
+ *
+ * - s3vectors:GetIndex
+ * - Delete
+ *
+ * - s3vectors:DeleteIndex
+ * - s3vectors:GetIndex
+ * - List
+ *
+ * - s3vectors:ListIndexes
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html}
  */
 export type S3VectorsIndex = ResourceDefinitionWithAttributes<"AWS::S3Vectors::Index", S3VectorsIndexProps, S3VectorsIndexAttribs>;
 /**
- * Resource Type definition for AWS::S3Vectors::Index
+ * The `AWS::S3Vectors::Index` resource defines a vector index within an Amazon S3 vector bucket. For more information, see [Creating a vector index in a vector bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-create-index.html) in the *Amazon Simple Storage Service User Guide* .
+ *
+ * You must specify either `VectorBucketName` or `VectorBucketArn` to identify the bucket that contains the index.
+ *
+ * To control how AWS CloudFormation handles the vector index when the stack is deleted, you can set a deletion policy for your index. You can choose to *retain* the index or to *delete* the index. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
+ *
+ * - **Permissions** - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
+ *
+ * - Create
+ *
+ * - s3vectors:CreateIndex
+ * - s3vectors:GetIndex
+ * - Read
+ *
+ * - s3vectors:GetIndex
+ * - Delete
+ *
+ * - s3vectors:DeleteIndex
+ * - s3vectors:GetIndex
+ * - List
+ *
+ * - s3vectors:ListIndexes
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html}
  */
 export type S3VectorsIndexProps = {
     /**
-     * The data type of the vectors to be inserted into the vector index.
+     * The data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-datatype}
      */
     DataType: DataType;
     /**
-     * The dimensions of the vectors to be inserted into the vector index.
+     * The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.
+     *
+     * The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-dimension}
      */
     Dimension: number;
     /**
-     * The distance metric to be used for similarity search.
+     * The distance metric to be used for similarity search. Valid values are:
+     *
+     * - `cosine` - Measures the cosine of the angle between two vectors.
+     * - `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-distancemetric}
      */
     DistanceMetric: DistanceMetric;
     /**
-     * The name of the vector index to create.
+     * The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.
+     *
+     * If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.
+     *
+     * > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-indexname}
      */
     IndexName?: string | undefined;
@@ -35,7 +86,7 @@ export type S3VectorsIndexProps = {
      */
     MetadataConfiguration?: MetadataConfiguration | undefined;
     /**
-     * The Amazon Resource Name (ARN) of the vector bucket.
+     * The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-vectorbucketarn}
      */
     VectorBucketArn?: string | undefined;
@@ -50,12 +101,16 @@ export type S3VectorsIndexProps = {
  */
 export type S3VectorsIndexAttribs = {
     /**
-     * Date and time when the vector index was created.
+     * Returns the date and time when the vector index was created.
+     *
+     * Example: `2024-12-21T10:30:00Z`
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-creationtime}
      */
     CreationTime: string;
     /**
-     * The Amazon Resource Name (ARN) of the index
+     * Returns the Amazon Resource Name (ARN) of the specified index.
+     *
+     * Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index`
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html#cfn-s3vectors-index-indexarn}
      */
     IndexArn: string;
@@ -71,12 +126,14 @@ export type DataType = "float32";
  */
 export type DistanceMetric = "cosine" | "euclidean";
 /**
- * The metadata configuration for the vector index.
+ * The metadata configuration for the vector index. This configuration allows you to specify which metadata keys should be treated as non-filterable.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-metadataconfiguration.html}
  */
 export type MetadataConfiguration = {
     /**
-     * Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
+     * Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys can't be used as query filters. Non-filterable metadata keys can be retrieved but can't be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
+     *
+     * You can specify 1 to 10 non-filterable metadata keys. Each key must be 1 to 63 characters long.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-metadataconfiguration.html#cfn-s3vectors-index-metadataconfiguration-nonfilterablemetadatakeys}
      */
     NonFilterableMetadataKeys?: string[] | undefined;