@awboost/cfn-resource-types 0.1.173 → 0.1.174

package/lib/AWS-SageMaker-Endpoint.d.ts

@@ -5,12 +5,29 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html}
  */
 export type SageMakerEndpointProperties = {
+    /**
+     * Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
+     */
     DeploymentConfig?: DeploymentConfig;
+    /**
+     * The name of the endpoint configuration for the SageMaker endpoint. This is a required property.
+     */
     EndpointConfigName: string;
-    EndpointName?: string;
+    /**
+     * Specifies a list of variant properties that you want to exclude when updating an endpoint.
+     */
     ExcludeRetainedVariantProperties?: VariantProperty[];
+    /**
+     * When set to true, retains all variant properties for an endpoint when it is updated.
+     */
     RetainAllVariantProperties?: boolean;
+    /**
+     * When set to true, retains the deployment configuration during endpoint updates.
+     */
     RetainDeploymentConfig?: boolean;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     */
     Tags?: Tag[];
 };
 /**
@@ -18,13 +35,23 @@ export type SageMakerEndpointProperties = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#aws-resource-sagemaker-endpoint-return-values}
  */
 export type SageMakerEndpointAttributes = {
-    Id: string;
+    /**
+     * The Amazon Resource Name (ARN) of the endpoint.
+     */
+    EndpointArn: string;
+    /**
+     * The name of the SageMaker endpoint. This name must be unique within an AWS Region.
+     */
+    EndpointName: string;
 };
 /**
  * Type definition for `AWS::SageMaker::Endpoint.Alarm`.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-alarm.html}
  */
 export type Alarm = {
+    /**
+     * The name of the CloudWatch alarm.
+     */
     AlarmName: string;
 };
 /**
@@ -32,6 +59,9 @@ export type Alarm = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-autorollbackconfig.html}
  */
 export type AutoRollbackConfig = {
+    /**
+     * List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back.
+     */
     Alarms: Alarm[];
 };
 /**
@@ -39,8 +69,17 @@ export type AutoRollbackConfig = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html}
  */
 export type BlueGreenUpdatePolicy = {
+    /**
+     * The maximum time allowed for the blue/green update, in seconds.
+     */
     MaximumExecutionTimeoutInSeconds?: number;
+    /**
+     * The wait time before terminating the old endpoint during a blue/green deployment.
+     */
     TerminationWaitInSeconds?: number;
+    /**
+     * The traffic routing configuration for the blue/green deployment.
+     */
     TrafficRoutingConfiguration: TrafficRoutingConfig;
 };
 /**
@@ -48,7 +87,13 @@ export type BlueGreenUpdatePolicy = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-capacitysize.html}
  */
 export type CapacitySize = {
+    /**
+     * Specifies whether the `Value` is an instance count or a capacity unit.
+     */
     Type: string;
+    /**
+     * The value representing either the number of instances or the number of capacity units.
+     */
     Value: number;
 };
 /**
@@ -56,8 +101,17 @@ export type CapacitySize = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html}
  */
 export type DeploymentConfig = {
+    /**
+     * Configuration for automatic rollback if an error occurs during deployment.
+     */
     AutoRollbackConfiguration?: AutoRollbackConfig;
+    /**
+     * Configuration for blue-green update deployment policies.
+     */
     BlueGreenUpdatePolicy?: BlueGreenUpdatePolicy;
+    /**
+     * Configuration for rolling update deployment policies.
+     */
     RollingUpdatePolicy?: RollingUpdatePolicy;
 };
 /**
@@ -65,9 +119,21 @@ export type DeploymentConfig = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html}
  */
 export type RollingUpdatePolicy = {
+    /**
+     * Specifies the maximum batch size for each rolling update.
+     */
     MaximumBatchSize: CapacitySize;
+    /**
+     * The maximum time allowed for the rolling update, in seconds.
+     */
     MaximumExecutionTimeoutInSeconds?: number;
+    /**
+     * The maximum batch size for rollback during an update failure.
+     */
     RollbackMaximumBatchSize?: CapacitySize;
+    /**
+     * The time to wait between steps during the rolling update, in seconds.
+     */
     WaitIntervalInSeconds: number;
 };
 /**
@@ -75,7 +141,13 @@ export type RollingUpdatePolicy = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-tag.html}
  */
 export type Tag = {
+    /**
+     * The key of the tag.
+     */
     Key: string;
+    /**
+     * The value of the tag.
+     */
     Value: string;
 };
 /**
@@ -83,9 +155,21 @@ export type Tag = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html}
  */
 export type TrafficRoutingConfig = {
+    /**
+     * Specifies the size of the canary traffic in a canary deployment.
+     */
     CanarySize?: CapacitySize;
+    /**
+     * Specifies the step size for linear traffic routing.
+     */
     LinearStepSize?: CapacitySize;
+    /**
+     * Specifies the type of traffic routing (e.g., 'AllAtOnce', 'Canary', 'Linear').
+     */
     Type: string;
+    /**
+     * Specifies the wait interval between traffic shifts, in seconds.
+     */
     WaitIntervalInSeconds?: number;
 };
 /**
@@ -93,6 +177,9 @@ export type TrafficRoutingConfig = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html}
  */
 export type VariantProperty = {
+    /**
+     * The type of variant property (e.g., 'DesiredInstanceCount', 'DesiredWeight', 'DataCaptureConfig').
+     */
     VariantPropertyType?: string;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awboost/cfn-resource-types",
-  "version": "0.1.173",
+  "version": "0.1.174",
   "publishConfig": {
     "access": "public"
   },