@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-sagemaker-inferencecomponent.d.ts

@@ -1,74 +1,98 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html}
+ */
 export type SageMakerInferenceComponent = ResourceDefinitionWithAttributes<"AWS::SageMaker::InferenceComponent", SageMakerInferenceComponentProps, SageMakerInferenceComponentAttribs>;
 /**
  * Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html}
  */
 export type SageMakerInferenceComponentProps = {
     /**
      * The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-deploymentconfig}
      */
     DeploymentConfig?: InferenceComponentDeploymentConfig | undefined;
     /**
      * The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointarn}
      */
     EndpointArn?: string | undefined;
     /**
      * The name of the endpoint that hosts the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointname}
      */
     EndpointName: string;
     /**
      * The name of the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-inferencecomponentname}
      */
     InferenceComponentName?: string | undefined;
     /**
      * The runtime config for the inference component
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig}
      */
     RuntimeConfig?: InferenceComponentRuntimeConfig | undefined;
     /**
      * The specification for the inference component
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification}
      */
     Specification: InferenceComponentSpecification;
     /**
      * An array of tags to apply to the resource
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The name of the production variant that hosts the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-variantname}
      */
     VariantName?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#aws-resource-sagemaker-inferencecomponent-return-values}
+ */
 export type SageMakerInferenceComponentAttribs = {
     /**
      * The time when the inference component was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-creationtime}
      */
     CreationTime: string;
     /**
      * The failure reason if the inference component is in a failed state
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-failurereason}
      */
     FailureReason: string;
     /**
      * The Amazon Resource Name (ARN) of the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-inferencecomponentarn}
      */
     InferenceComponentArn: string;
     /**
      * The status of the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-inferencecomponentstatus}
      */
     InferenceComponentStatus: InferenceComponentStatus;
     /**
      * The time when the inference component was last updated.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-lastmodifiedtime}
      */
     LastModifiedTime: string;
     /**
      * The number of runtime copies of the model container that are currently deployed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-currentcopycount}
      */
     "RuntimeConfig.CurrentCopyCount": number;
     /**
      * The number of runtime copies of the model container that you requested to deploy with the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-desiredcopycount}
      */
     "RuntimeConfig.DesiredCopyCount": number;
 };
 /**
  * An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-alarm.html}
  */
 export type Alarm = {
     /**
@@ -76,10 +100,17 @@ export type Alarm = {
      * @minLength 1
      * @maxLength 255
      * @pattern ^(?!\s*$).+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-alarm.html#cfn-sagemaker-inferencecomponent-alarm-alarmname}
      */
     AlarmName: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-autorollbackconfiguration.html}
+ */
 export type AutoRollbackConfiguration = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-autorollbackconfiguration.html#cfn-sagemaker-inferencecomponent-autorollbackconfiguration-alarms}
+     */
     Alarms: Alarm[];
 };
 /**
@@ -89,6 +120,7 @@ export type AutoRollbackConfiguration = {
  * - The overall percentage or your fleet
  *
  * For a rollback strategy, if you don't specify the fields in this object, or if you set the `Value` parameter to 100%, then SageMaker AI uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysize.html}
  */
 export type InferenceComponentCapacitySize = {
     /**
@@ -96,94 +128,121 @@ export type InferenceComponentCapacitySize = {
      *
      * - **COPY_COUNT** - The endpoint activates based on the number of inference component copies.
      * - **CAPACITY_PERCENT** - The endpoint activates based on the specified percentage of capacity.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysize.html#cfn-sagemaker-inferencecomponent-inferencecomponentcapacitysize-type}
      */
     Type: InferenceComponentCapacitySizeType;
     /**
      * Defines the capacity size, either as a number of inference component copies or a capacity percentage.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysize.html#cfn-sagemaker-inferencecomponent-inferencecomponentcapacitysize-value}
      */
     Value: number;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcapacitysizetype.html}
+ */
 export type InferenceComponentCapacitySizeType = "COPY_COUNT" | "CAPACITY_PERCENT";
 /**
  * Defines the compute resources to allocate to run a model, plus any adapter models, that you assign to an inference component. These resources include CPU cores, accelerators, and memory.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html}
  */
 export type InferenceComponentComputeResourceRequirements = {
     /**
      * The maximum MB of memory to allocate to run a model that you assign to an inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-maxmemoryrequiredinmb}
      */
     MaxMemoryRequiredInMb?: number | undefined;
     /**
      * The minimum MB of memory to allocate to run a model that you assign to an inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-minmemoryrequiredinmb}
      */
     MinMemoryRequiredInMb?: number | undefined;
     /**
      * The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and AWS Inferentia.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofacceleratordevicesrequired}
      */
     NumberOfAcceleratorDevicesRequired?: number | undefined;
     /**
      * The number of CPU cores to allocate to run a model that you assign to an inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofcpucoresrequired}
      */
     NumberOfCpuCoresRequired?: number | undefined;
 };
 /**
  * Defines a container that provides the runtime environment for a model that you deploy with an inference component.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html}
  */
 export type InferenceComponentContainerSpecification = {
     /**
      * The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-artifacturl}
      */
     ArtifactUrl?: string | undefined;
     /**
      * The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-environment}
      */
     Environment?: Record<string, string> | undefined;
     /**
      * The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-image}
      */
     Image?: string | undefined;
 };
 /**
  * The deployment configuration for an endpoint that hosts inference components. The configuration includes the desired deployment strategy and rollback settings.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig.html}
  */
 export type InferenceComponentDeploymentConfig = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig-autorollbackconfiguration}
+     */
     AutoRollbackConfiguration?: AutoRollbackConfiguration | undefined;
     /**
      * Specifies a rolling deployment strategy for updating a SageMaker AI endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentdeploymentconfig-rollingupdatepolicy}
      */
     RollingUpdatePolicy?: InferenceComponentRollingUpdatePolicy | undefined;
 };
 /**
  * Specifies a rolling deployment strategy for updating a SageMaker AI inference component.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html}
  */
 export type InferenceComponentRollingUpdatePolicy = {
     /**
      * The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet, and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of the copy count of the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html#cfn-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy-maximumbatchsize}
      */
     MaximumBatchSize?: InferenceComponentCapacitySize | undefined;
     /**
      * The time limit for the total deployment. Exceeding this limit causes a timeout.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html#cfn-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy-maximumexecutiontimeoutinseconds}
      */
     MaximumExecutionTimeoutInSeconds?: number | undefined;
     /**
      * The batch size for a rollback to the old endpoint fleet. If this field is absent, the value is set to the default, which is 100% of the total capacity. When the default is used, SageMaker AI provisions the entire capacity of the old fleet at once during rollback.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html#cfn-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy-rollbackmaximumbatchsize}
      */
     RollbackMaximumBatchSize?: InferenceComponentCapacitySize | undefined;
     /**
      * The length of the baking period, during which SageMaker AI monitors alarms for each batch on the new fleet.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy.html#cfn-sagemaker-inferencecomponent-inferencecomponentrollingupdatepolicy-waitintervalinseconds}
      */
     WaitIntervalInSeconds?: number | undefined;
 };
 /**
  * Runtime settings for a model that is deployed with an inference component.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html}
  */
 export type InferenceComponentRuntimeConfig = {
     /**
      * The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-copycount}
      */
     CopyCount?: number | undefined;
 };
 /**
  * Details about the resources to deploy with this inference component, including the model, container, and compute resources.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html}
  */
 export type InferenceComponentSpecification = {
     /**
@@ -194,39 +253,50 @@ export type InferenceComponentSpecification = {
      * When you create an adapter inference component, use the `Container` parameter to specify the location of the adapter artifacts. In the parameter value, use the `ArtifactUrl` parameter of the `InferenceComponentContainerSpecification` data type.
      *
      * Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-baseinferencecomponentname}
      */
     BaseInferenceComponentName?: string | undefined;
     /**
      * The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.
      *
      * Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-computeresourcerequirements}
      */
     ComputeResourceRequirements?: InferenceComponentComputeResourceRequirements | undefined;
     /**
      * Defines a container that provides the runtime environment for a model that you deploy with an inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-container}
      */
     Container?: InferenceComponentContainerSpecification | undefined;
     /**
      * The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-modelname}
      */
     ModelName?: string | undefined;
     /**
      * Settings that take effect while the model container starts up.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-startupparameters}
      */
     StartupParameters?: InferenceComponentStartupParameters | undefined;
 };
 /**
  * Settings that take effect while the model container starts up.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html}
  */
 export type InferenceComponentStartupParameters = {
     /**
      * The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see [How Your Container Should Respond to Health Check (Ping) Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-containerstartuphealthchecktimeoutinseconds}
      */
     ContainerStartupHealthCheckTimeoutInSeconds?: number | undefined;
     /**
      * The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-modeldatadownloadtimeoutinseconds}
      */
     ModelDataDownloadTimeoutInSeconds?: number | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstatus.html}
+ */
 export type InferenceComponentStatus = "InService" | "Creating" | "Updating" | "Failed" | "Deleting";
 //# sourceMappingURL=aws-sagemaker-inferencecomponent.d.ts.map

package/out/exports/resources.generated/aws-sagemaker-inferenceexperiment.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates an inference experiment using the configurations specified in the request.
+ *
+ * Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see [Shadow tests](https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html) .
+ *
+ * Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.
+ *
+ * While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see [View, monitor, and edit shadow tests](https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests-view-monitor-edit.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html}
+ */
 export type SageMakerInferenceExperiment = ResourceDefinitionWithAttributes<"AWS::SageMaker::InferenceExperiment", SageMakerInferenceExperimentProps, SageMakerInferenceExperimentAttribs>;
 /**
  * Creates an inference experiment using the configurations specified in the request.
@@ -8,10 +18,12 @@ export type SageMakerInferenceExperiment = ResourceDefinitionWithAttributes<"AWS
  * Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.
  *
  * While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see [View, monitor, and edit shadow tests](https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests-view-monitor-edit.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html}
  */
 export type SageMakerInferenceExperimentProps = {
     /**
      * The Amazon S3 location and configuration for storing inference request and response data.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-datastorageconfig}
      */
     DataStorageConfig?: DataStorageConfig | undefined;
     /**
@@ -19,6 +31,7 @@ export type SageMakerInferenceExperimentProps = {
      * @minLength 1
      * @maxLength 1024
      * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-description}
      */
     Description?: string | undefined;
     /**
@@ -26,26 +39,31 @@ export type SageMakerInferenceExperimentProps = {
      *
      * - `Completed` : The experiment completed successfully
      * - `Cancelled` : The experiment was canceled
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-desiredstate}
      */
     DesiredState?: "Running" | "Completed" | "Cancelled" | undefined;
     /**
      * The name of the endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-endpointname}
      */
     EndpointName: string;
     /**
      * The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.
      * @maxLength 2048
      * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-kmskey}
      */
     KmsKey?: string | undefined;
     /**
      * An array of `ModelVariantConfigSummary` objects. There is one for each variant in the inference experiment. Each `ModelVariantConfigSummary` object in the array describes the infrastructure configuration for deploying the corresponding variant.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-modelvariants}
      */
     ModelVariants: ModelVariantConfig[];
     /**
      * The name of the inference experiment.
      * @minLength 1
      * @maxLength 120
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-name}
      */
     Name: string;
     /**
@@ -53,16 +71,19 @@ export type SageMakerInferenceExperimentProps = {
      * @minLength 20
      * @maxLength 2048
      * @pattern ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-rolearn}
      */
     RoleArn: string;
     /**
      * The duration for which the inference experiment ran or will run.
      *
      * The maximum duration that you can set for an inference experiment is 30 days.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-schedule}
      */
     Schedule?: InferenceExperimentSchedule | undefined;
     /**
      * The configuration of `ShadowMode` inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig}
      */
     ShadowModeConfig?: ShadowModeConfig | undefined;
     /**
@@ -70,33 +91,42 @@ export type SageMakerInferenceExperimentProps = {
      * @minLength 1
      * @maxLength 1024
      * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-statusreason}
      */
     StatusReason?: string | undefined;
     /**
      * An array of key-value pairs to apply to this resource.
      *
      * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The type of the inference experiment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-type}
      */
     Type: "ShadowMode";
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#aws-resource-sagemaker-inferenceexperiment-return-values}
+ */
 export type SageMakerInferenceExperimentAttribs = {
     /**
      * The ARN for your inference experiment.
      * @minLength 20
      * @maxLength 256
      * @pattern ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-experiment/[a-zA-Z_0-9+=,.@\-_/]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-arn}
      */
     Arn: string;
     /**
      * The timestamp at which the inference experiment was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-creationtime}
      */
     CreationTime: string;
     /**
      * The timestamp at which you last modified the inference experiment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-lastmodifiedtime}
      */
     LastModifiedTime: string;
     /**
@@ -110,19 +140,23 @@ export type SageMakerInferenceExperimentAttribs = {
      * - `Stopping` - Amazon SageMaker is stopping your experiment.
      * - `Completed` - Your experiment has completed.
      * - `Cancelled` - When you conclude your experiment early using the [StopInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) API, or if any operation fails with an unexpected error, it shows as cancelled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-status}
      */
     Status: "Creating" | "Created" | "Updating" | "Starting" | "Stopping" | "Running" | "Completed" | "Cancelled";
 };
 /**
  * Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker AI will by default base64 encode when capturing the data.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html}
  */
 export type CaptureContentTypeHeader = {
     /**
      * The list of all content type headers that Amazon SageMaker AI will treat as CSV and capture accordingly.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html#cfn-sagemaker-inferenceexperiment-capturecontenttypeheader-csvcontenttypes}
      */
     CsvContentTypes?: string[] | undefined;
     /**
      * The list of all content type headers that SageMaker AI will treat as JSON and capture accordingly.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html#cfn-sagemaker-inferenceexperiment-capturecontenttypeheader-jsoncontenttypes}
      */
     JsonContentTypes?: string[] | undefined;
 };
@@ -130,22 +164,26 @@ export type CaptureContentTypeHeader = {
  * The Amazon S3 location and configuration for storing inference request and response data.
  *
  * This is an optional parameter that you can use for data capture. For more information, see [Capture data](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html}
  */
 export type DataStorageConfig = {
     /**
      * Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-contenttype}
      */
     ContentType?: CaptureContentTypeHeader | undefined;
     /**
      * The Amazon S3 bucket where the inference request and response data is stored.
      * @maxLength 512
      * @pattern ^(https|s3)://([^/])/?(.*)$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-destination}
      */
     Destination: string;
     /**
      * The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.
      * @maxLength 2048
      * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-kmskey}
      */
     KmsKey?: string | undefined;
 };
@@ -153,94 +191,113 @@ export type DataStorageConfig = {
  * The start and end times of an inference experiment.
  *
  * The maximum duration that you can set for an inference experiment is 30 days.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html}
  */
 export type InferenceExperimentSchedule = {
     /**
      * The timestamp at which the inference experiment ended or will end.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html#cfn-sagemaker-inferenceexperiment-inferenceexperimentschedule-endtime}
      */
     EndTime?: string | undefined;
     /**
      * The timestamp at which the inference experiment started or will start.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html#cfn-sagemaker-inferenceexperiment-inferenceexperimentschedule-starttime}
      */
     StartTime?: string | undefined;
 };
 /**
  * The configuration for the infrastructure that the model will be deployed to.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html}
  */
 export type ModelInfrastructureConfig = {
     /**
      * The inference option to which to deploy your model. Possible values are the following:
      *
      * - `RealTime` : Deploy to real-time inference.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html#cfn-sagemaker-inferenceexperiment-modelinfrastructureconfig-infrastructuretype}
      */
     InfrastructureType: "RealTimeInference";
     /**
      * The infrastructure configuration for deploying the model to real-time inference.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html#cfn-sagemaker-inferenceexperiment-modelinfrastructureconfig-realtimeinferenceconfig}
      */
     RealTimeInferenceConfig: RealTimeInferenceConfig;
 };
 /**
  * Contains information about the deployment options of a model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html}
  */
 export type ModelVariantConfig = {
     /**
      * The configuration for the infrastructure that the model will be deployed to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-infrastructureconfig}
      */
     InfrastructureConfig: ModelInfrastructureConfig;
     /**
      * The name of the Amazon SageMaker Model entity.
      * @maxLength 63
      * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-modelname}
      */
     ModelName: string;
     /**
      * The name of the variant.
      * @maxLength 63
      * @pattern ^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-variantname}
      */
     VariantName: string;
 };
 /**
  * The infrastructure configuration for deploying the model to a real-time inference endpoint.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html}
  */
 export type RealTimeInferenceConfig = {
     /**
      * The number of instances of the type specified by `InstanceType` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html#cfn-sagemaker-inferenceexperiment-realtimeinferenceconfig-instancecount}
      */
     InstanceCount: number;
     /**
      * The instance type the model is deployed to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html#cfn-sagemaker-inferenceexperiment-realtimeinferenceconfig-instancetype}
      */
     InstanceType: string;
 };
 /**
  * The configuration of `ShadowMode` inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html}
  */
 export type ShadowModeConfig = {
     /**
      * List of shadow variant configurations.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig-shadowmodelvariants}
      */
     ShadowModelVariants: ShadowModelVariantConfig[];
     /**
      * The name of the production variant, which takes all the inference requests.
      * @maxLength 63
      * @pattern ^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig-sourcemodelvariantname}
      */
     SourceModelVariantName: string;
 };
 /**
  * The name and sampling percentage of a shadow variant.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html}
  */
 export type ShadowModelVariantConfig = {
     /**
      * The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.
      * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodelvariantconfig-samplingpercentage}
      */
     SamplingPercentage: number;
     /**
      * The name of the shadow variant.
      * @maxLength 63
      * @pattern ^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodelvariantconfig-shadowmodelvariantname}
      */
     ShadowModelVariantName: string;
 };