@propulsionworks/cloudformation 0.1.19 → 0.1.21

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

@@ -21,7 +21,12 @@ export type SageMakerClusterProps = {
      * The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-instancegroups}
      */
-    InstanceGroups: ClusterInstanceGroup[];
+    InstanceGroups?: ClusterInstanceGroup[] | undefined;
+    /**
+     * Determines the scaling strategy for the SageMaker HyperPod cluster. When set to 'Continuous', enables continuous scaling which dynamically manages node provisioning. If the parameter is omitted, uses the standard scaling approach in previous release.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-nodeprovisioningmode}
+     */
+    NodeProvisioningMode?: "Continuous" | undefined;
     /**
      * Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod. Available values are `Automatic` for enabling and `None` for disabling.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-noderecovery}
@@ -32,6 +37,11 @@ export type SageMakerClusterProps = {
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-orchestrator}
      */
     Orchestrator?: Orchestrator | undefined;
+    /**
+     * The restricted instance groups of the SageMaker HyperPod cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-restrictedinstancegroups}
+     */
+    RestrictedInstanceGroups?: ClusterRestrictedInstanceGroup[] | undefined;
     /**
      * A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.
      *
@@ -97,6 +107,10 @@ export type ClusterInstanceGroup = {
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-executionrole}
      */
     ExecutionRole: string;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-imageid}
+     */
+    ImageId?: string | undefined;
     /**
      * The number of instances in an instance group of the SageMaker HyperPod cluster.
      * @min 0
@@ -140,6 +154,14 @@ export type ClusterInstanceGroup = {
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-threadspercore}
      */
     ThreadsPerCore?: number | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the training plan to use for this cluster instance group. For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan.
+     * @minLength 50
+     * @maxLength 2048
+     * @pattern ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-trainingplanarn}
+     */
+    TrainingPlanArn?: string | undefined;
 };
 /**
  * Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see [SageMaker HyperPod release notes: June 20, 2024](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620) .
@@ -182,11 +204,104 @@ export type ClusterOrchestratorEksConfig = {
      */
     ClusterArn: string;
 };
+/**
+ * Details of a restricted instance group in a SageMaker HyperPod cluster.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html}
+ */
+export type ClusterRestrictedInstanceGroup = {
+    /**
+     * The configuration for the restricted instance groups (RIG) environment.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-environmentconfig}
+     */
+    EnvironmentConfig: EnvironmentConfig;
+    /**
+     * The execution role for the instance group to assume.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-executionrole}
+     */
+    ExecutionRole: string;
+    /**
+     * The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.
+     * @min 0
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancecount}
+     */
+    InstanceCount: number;
+    /**
+     * The name of the instance group of a SageMaker HyperPod cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancegroupname}
+     */
+    InstanceGroupName: string;
+    /**
+     * The instance storage configuration for the instance group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancestorageconfigs}
+     */
+    InstanceStorageConfigs?: ClusterInstanceStorageConfig[] | undefined;
+    /**
+     * The instance type of the instance group of a SageMaker HyperPod cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancetype}
+     */
+    InstanceType: string;
+    /**
+     * Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-onstartdeephealthchecks}
+     */
+    OnStartDeepHealthChecks?: DeepHealthCheckType[] | undefined;
+    /**
+     * Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-overridevpcconfig}
+     */
+    OverrideVpcConfig?: VpcConfig | undefined;
+    /**
+     * The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.
+     * @min 1
+     * @max 2
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-threadspercore}
+     */
+    ThreadsPerCore?: number | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the training plan to use for this cluster restricted instance group. For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan.
+     * @minLength 50
+     * @maxLength 2048
+     * @pattern ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.html#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-trainingplanarn}
+     */
+    TrainingPlanArn?: string | undefined;
+};
 /**
  * The type of deep health check(s) to be performed on the instances in the SageMaker HyperPod cluster instance group.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-deephealthchecktype.html}
  */
 export type DeepHealthCheckType = "InstanceStress" | "InstanceConnectivity";
+/**
+ * The configuration for the restricted instance groups (RIG) environment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-environmentconfig.html}
+ */
+export type EnvironmentConfig = {
+    /**
+     * Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-environmentconfig.html#cfn-sagemaker-cluster-environmentconfig-fsxlustreconfig}
+     */
+    FSxLustreConfig?: FSxLustreConfig | undefined;
+};
+/**
+ * Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-fsxlustreconfig.html}
+ */
+export type FSxLustreConfig = {
+    /**
+     * The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.
+     * @min 125
+     * @max 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-fsxlustreconfig.html#cfn-sagemaker-cluster-fsxlustreconfig-perunitstoragethroughput}
+     */
+    PerUnitStorageThroughput: number;
+    /**
+     * The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).
+     * @min 1200
+     * @max 100800
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-fsxlustreconfig.html#cfn-sagemaker-cluster-fsxlustreconfig-sizeingib}
+     */
+    SizeInGiB: number;
+};
 /**
  * The orchestrator for a SageMaker HyperPod cluster.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-orchestrator.html}

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

@@ -277,6 +277,7 @@ export type CustomFileSystemConfig = {
      */
     FSxLustreFileSystemConfig?: FSxLustreFileSystemConfig | undefined;
     /**
+     * Configuration settings for a custom Amazon S3 file system.
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html#cfn-sagemaker-domain-customfilesystemconfig-s3filesystemconfig}
      */
     S3FileSystemConfig?: S3FileSystemConfig | undefined;
@@ -736,16 +737,19 @@ export type ResourceSpec = {
     SageMakerImageVersionArn?: string | undefined;
 };
 /**
+ * Configuration for the custom Amazon S3 file system.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-s3filesystemconfig.html}
  */
 export type S3FileSystemConfig = {
     /**
+     * The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.
      * @minLength 0
      * @maxLength 1024
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-s3filesystemconfig.html#cfn-sagemaker-domain-s3filesystemconfig-mountpath}
      */
     MountPath?: string | undefined;
     /**
+     * The Amazon S3 URI of the S3 file system configuration.
      * @minLength 0
      * @maxLength 1024
      * @pattern (s3)://([^/]+)/?(.*)
@@ -854,7 +858,7 @@ export type UnifiedStudioSettings = {
      */
     ProjectS3Path?: string | undefined;
     /**
-     * The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the AWS IAM Identity Center.
+     * The ARN of the Amazon DataZone application managed by Amazon SageMaker Unified Studio in the AWS IAM Identity Center.
      * @pattern ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application/[a-zA-Z0-9-_.]+/apl-[a-zA-Z0-9]+$
      * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-singlesignonapplicationarn}
      */