@awboost/cfn-resource-types 0.1.137 → 0.1.139

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

@@ -0,0 +1,241 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
+import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
+/**
+ * Resource Type definition for AWS::SageMaker::Cluster
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html}
+ */
+export type SageMakerClusterProperties = {
+    /**
+     * The name of the HyperPod Cluster.
+     * @minLength `1`
+     * @maxLength `63`
+     * @pattern `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`
+     */
+    ClusterName?: string;
+    /**
+     * The instance groups of the SageMaker HyperPod cluster.
+     * @minLength `1`
+     */
+    InstanceGroups: ClusterInstanceGroup[];
+    /**
+     * If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
+     */
+    NodeRecovery?: "Automatic" | "None";
+    /**
+     * Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.
+     */
+    Orchestrator?: Orchestrator;
+    /**
+     * Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
+     * @maxLength `50`
+     */
+    Tags?: Tag[];
+    /**
+     * 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.
+     */
+    VpcConfig?: VpcConfig;
+};
+/**
+ * Attribute type definition for `AWS::SageMaker::Cluster`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#aws-resource-sagemaker-cluster-return-values}
+ */
+export type SageMakerClusterAttributes = {
+    /**
+     * The Amazon Resource Name (ARN) of the HyperPod Cluster.
+     * @maxLength `256`
+     * @pattern `^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$`
+     */
+    ClusterArn: string;
+    /**
+     * The status of the HyperPod Cluster.
+     */
+    ClusterStatus: "Creating" | "Deleting" | "Failed" | "InService" | "RollingBack" | "SystemUpdating" | "Updating";
+    /**
+     * The time at which the HyperPod cluster was created.
+     */
+    CreationTime: string;
+    /**
+     * The failure message of the HyperPod Cluster.
+     */
+    FailureMessage: string;
+    /**
+     * The instance groups of the SageMaker HyperPod cluster.
+     * @minLength `1`
+     */
+    InstanceGroups: {
+        /**
+         * The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
+         * @min `0`
+         */
+        CurrentCount: number;
+    }[];
+};
+/**
+ * Type definition for `AWS::SageMaker::Cluster.ClusterEbsVolumeConfig`.
+ * Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html}
+ */
+export type ClusterEbsVolumeConfig = {
+    /**
+     * The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
+     * @min `1`
+     * @max `16384`
+     */
+    VolumeSizeInGB?: number;
+};
+/**
+ * Type definition for `AWS::SageMaker::Cluster.ClusterInstanceGroup`.
+ * Details of an instance group in a SageMaker HyperPod cluster.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html}
+ */
+export type ClusterInstanceGroup = {
+    /**
+     * The execution role for the instance group to assume.
+     * @minLength `20`
+     * @maxLength `2048`
+     * @pattern `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`
+     */
+    ExecutionRole: string;
+    /**
+     * The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
+     * @min `1`
+     */
+    InstanceCount: number;
+    /**
+     * The name of the instance group of a SageMaker HyperPod cluster.
+     * @minLength `1`
+     * @maxLength `63`
+     * @pattern `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`
+     */
+    InstanceGroupName: string;
+    /**
+     * The instance storage configuration for the instance group.
+     * @maxLength `1`
+     */
+    InstanceStorageConfigs?: ClusterInstanceStorageConfig[];
+    /**
+     * The instance type of the instance group of a SageMaker HyperPod cluster.
+     */
+    InstanceType: string;
+    /**
+     * The lifecycle configuration for a SageMaker HyperPod cluster.
+     */
+    LifeCycleConfig: ClusterLifeCycleConfig;
+    /**
+     * Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in.
+     */
+    OnStartDeepHealthChecks?: DeepHealthCheckType[];
+    /**
+     * 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`
+     */
+    ThreadsPerCore?: number;
+};
+/**
+ * Type definition for `AWS::SageMaker::Cluster.ClusterInstanceStorageConfig`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancestorageconfig.html}
+ */
+export type ClusterInstanceStorageConfig = {
+    /**
+     * Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
+     */
+    EbsVolumeConfig?: ClusterEbsVolumeConfig;
+};
+/**
+ * Type definition for `AWS::SageMaker::Cluster.ClusterLifeCycleConfig`.
+ * The lifecycle configuration for a SageMaker HyperPod cluster.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html}
+ */
+export type ClusterLifeCycleConfig = {
+    /**
+     * The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
+     * @minLength `1`
+     * @maxLength `128`
+     * @pattern `^[\S\s]+$`
+     */
+    OnCreate: string;
+    /**
+     * An Amazon S3 bucket path where your lifecycle scripts are stored.
+     * @maxLength `1024`
+     * @pattern `^(https|s3)://([^/]+)/?(.*)$`
+     */
+    SourceS3Uri: string;
+};
+/**
+ * Type definition for `AWS::SageMaker::Cluster.ClusterOrchestratorEksConfig`.
+ * Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterorchestratoreksconfig.html}
+ */
+export type ClusterOrchestratorEksConfig = {
+    /**
+     * The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster
+     */
+    ClusterArn: string;
+};
+/**
+ * Type definition for `AWS::SageMaker::Cluster.DeepHealthCheckType`.
+ * 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";
+/**
+ * Type definition for `AWS::SageMaker::Cluster.Orchestrator`.
+ * Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-orchestrator.html}
+ */
+export type Orchestrator = {
+    /**
+     * Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,
+     */
+    Eks: ClusterOrchestratorEksConfig;
+};
+/**
+ * Type definition for `AWS::SageMaker::Cluster.Tag`.
+ * A key-value pair to associate with a resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-tag.html}
+ */
+export type Tag = {
+    /**
+     * The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
+     * @minLength `1`
+     * @maxLength `128`
+     * @pattern `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
+     */
+    Key: string;
+    /**
+     * The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
+     * @minLength `0`
+     * @maxLength `256`
+     * @pattern `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
+     */
+    Value: string;
+};
+/**
+ * Type definition for `AWS::SageMaker::Cluster.VpcConfig`.
+ * 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-vpcconfig.html}
+ */
+export type VpcConfig = {
+    /**
+     * The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
+     * @minLength `1`
+     * @maxLength `5`
+     */
+    SecurityGroupIds: string[];
+    /**
+     * The ID of the subnets in the VPC to which you want to connect your training job or model.
+     * @minLength `1`
+     * @maxLength `16`
+     */
+    Subnets: string[];
+};
+/**
+ * Resource Type definition for AWS::SageMaker::Cluster
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html}
+ */
+export declare class SageMakerCluster extends $Resource<"AWS::SageMaker::Cluster", SageMakerClusterProperties, SageMakerClusterAttributes> {
+    static readonly Type = "AWS::SageMaker::Cluster";
+    constructor(logicalId: string, properties: SageMakerClusterProperties, options?: $ResourceOptions);
+}
+//# sourceMappingURL=AWS-SageMaker-Cluster.d.ts.map

package/lib/AWS-SageMaker-Cluster.js

@@ -0,0 +1,12 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
+/**
+ * Resource Type definition for AWS::SageMaker::Cluster
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html}
+ */
+export class SageMakerCluster extends $Resource {
+    static Type = "AWS::SageMaker::Cluster";
+    constructor(logicalId, properties, options) {
+        super(logicalId, SageMakerCluster.Type, properties, options);
+    }
+}
+//# sourceMappingURL=AWS-SageMaker-Cluster.js.map

package/package.json

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