We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::SageMaker::Extension. An extension is a versioned software package that Amazon SageMaker HyperPod installs and manages on the nodes of a HyperPod cluster. For example, the sagemaker-observability extension collects metrics from your cluster.
Create Extension Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Extension(name: string, args: ExtensionArgs, opts?: CustomResourceOptions);@overload
def Extension(resource_name: str,
args: ExtensionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Extension(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_arn: Optional[str] = None,
configuration_values: Optional[str] = None,
extension_name: Optional[str] = None,
extension_version: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewExtension(ctx *Context, name string, args ExtensionArgs, opts ...ResourceOption) (*Extension, error)public Extension(string name, ExtensionArgs args, CustomResourceOptions? opts = null)
public Extension(String name, ExtensionArgs args)
public Extension(String name, ExtensionArgs args, CustomResourceOptions options)
type: aws-native:sagemaker:Extension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_sagemaker_extension" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ExtensionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ExtensionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ExtensionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExtensionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExtensionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Extension Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Extension resource accepts the following input properties:
- Cluster
Arn string - The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
- Configuration
Values string - The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
- Extension
Name string - The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
- Extension
Version string - The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The tags to add to the extension. You can add up to 50 tags.
- Cluster
Arn string - The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
- Configuration
Values string - The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
- Extension
Name string - The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
- Extension
Version string - The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
-
Tag
Args - The tags to add to the extension. You can add up to 50 tags.
- cluster_
arn string - The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
- configuration_
values string - The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
- extension_
name string - The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
- extension_
version string - The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
- list(object)
- The tags to add to the extension. You can add up to 50 tags.
- cluster
Arn String - The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
- configuration
Values String - The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
- extension
Name String - The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
- extension
Version String - The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
- List<Tag>
- The tags to add to the extension. You can add up to 50 tags.
- cluster
Arn string - The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
- configuration
Values string - The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
- extension
Name string - The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
- extension
Version string - The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
- Tag[]
- The tags to add to the extension. You can add up to 50 tags.
- cluster_
arn str - The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
- configuration_
values str - The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
- extension_
name str - The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
- extension_
version str - The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
-
Sequence[Tag
Args] - The tags to add to the extension. You can add up to 50 tags.
- cluster
Arn String - The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
- configuration
Values String - The configuration settings for the extension, as a JSON string. The settings must match the configuration schema for the extension version. For each setting that you don't specify, SageMaker HyperPod uses its default value. When you update the stack, SageMaker HyperPod applies the settings in the string to the current configuration. Settings that you leave out keep their current values. To restore the default value of a setting, set it to null. To write the settings as YAML or JSON in your template, use the Fn::ToJsonString intrinsic function with the AWS::LanguageExtensions transform. The JSON string can be up to 10,240 characters long.
- extension
Name String - The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
- extension
Version String - The version of the extension to install, such as 1.0.0. When you create the extension without a version, SageMaker HyperPod installs the latest generally available version. If the extension doesn't have a generally available version, you must specify one. If you remove this property from your template during a stack update, the installed version doesn't change. You can't downgrade an extension. To install an earlier version, delete the extension and create it again.
- List<Property Map>
- The tags to add to the extension. You can add up to 50 tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Extension resource produces the following output properties:
- Creation
Time string - The date and time that you created the extension.
- Extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The date and time of the most recent change to the extension.
- Node
Summary Pulumi.Aws Native. Sage Maker. Outputs. Extension Node Summary - Status
Pulumi.
Aws Native. Sage Maker. Extension Status - The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
- Creation
Time string - The date and time that you created the extension.
- Extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The date and time of the most recent change to the extension.
- Node
Summary ExtensionNode Summary - Status
Extension
Status - The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
- creation_
time string - The date and time that you created the extension.
- extension_
arn string - The Amazon Resource Name (ARN) of the extension.
- id string
- The provider-assigned unique ID for this managed resource.
- last_
modified_ stringtime - The date and time of the most recent change to the extension.
- node_
summary object - status
"Creating" | "Active" | "Create
Failed" | "Updating" | "Deleting" | "Delete Failed" | "Degraded" | "Update Failed" - The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
- creation
Time String - The date and time that you created the extension.
- extension
Arn String - The Amazon Resource Name (ARN) of the extension.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The date and time of the most recent change to the extension.
- node
Summary ExtensionNode Summary - status
Extension
Status - The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
- creation
Time string - The date and time that you created the extension.
- extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringTime - The date and time of the most recent change to the extension.
- node
Summary ExtensionNode Summary - status
Extension
Status - The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
- creation_
time str - The date and time that you created the extension.
- extension_
arn str - The Amazon Resource Name (ARN) of the extension.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strtime - The date and time of the most recent change to the extension.
- node_
summary ExtensionNode Summary - status
Extension
Status - The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
- creation
Time String - The date and time that you created the extension.
- extension
Arn String - The Amazon Resource Name (ARN) of the extension.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The date and time of the most recent change to the extension.
- node
Summary Property Map - status
"Creating" | "Active" | "Create
Failed" | "Updating" | "Deleting" | "Delete Failed" | "Degraded" | "Update Failed" - The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
Look up Existing Extension Resource
Get an existing Extension resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Extension@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Extensionfunc GetExtension(ctx *Context, name string, id IDInput, state *ExtensionState, opts ...ResourceOption) (*Extension, error)public static Extension Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Extension get(String name, Output<String> id, CustomResourceOptions options)resources: existingExtension: type: aws-native:sagemaker:Extension get: id: ${id}import {
to = aws-native_sagemaker_extension.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ExtensionState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
ExtensionNodeSummary
The number of cluster nodes that the extension applies to, and how many of them run the requested extension version.
- Active
Count int - The number of cluster nodes that run the requested extension version.
- Total
Count int - The number of cluster nodes that the extension applies to.
- Active
Count int - The number of cluster nodes that run the requested extension version.
- Total
Count int - The number of cluster nodes that the extension applies to.
- active_
count number - The number of cluster nodes that run the requested extension version.
- total_
count number - The number of cluster nodes that the extension applies to.
- active
Count Integer - The number of cluster nodes that run the requested extension version.
- total
Count Integer - The number of cluster nodes that the extension applies to.
- active
Count number - The number of cluster nodes that run the requested extension version.
- total
Count number - The number of cluster nodes that the extension applies to.
- active_
count int - The number of cluster nodes that run the requested extension version.
- total_
count int - The number of cluster nodes that the extension applies to.
- active
Count Number - The number of cluster nodes that run the requested extension version.
- total
Count Number - The number of cluster nodes that the extension applies to.
ExtensionStatus
The current status of the extension. CloudFormation doesn't wait for the extension to finish installing or updating on the cluster nodes. To check progress, use Status and NodeSummary.
| Name | Value |
|---|---|
| Creating | Creating |
| Active | Active |
| Create | CreateFailed |
| Updating | Updating |
| Deleting | Deleting |
| Delete | DeleteFailed |
| Degraded | Degraded |
| Update | UpdateFailed |
| Name | Value |
|---|---|
| Extension | Creating |
| Extension | Active |
| Extension | CreateFailed |
| Extension | Updating |
| Extension | Deleting |
| Extension | DeleteFailed |
| Extension | Degraded |
| Extension | UpdateFailed |
| Value |
|---|
Creating |
Active |
CreateFailed |
Updating |
Deleting |
DeleteFailed |
Degraded |
UpdateFailed |
| Name | Value |
|---|---|
| Creating | Creating |
| Active | Active |
| Create | CreateFailed |
| Updating | Updating |
| Deleting | Deleting |
| Delete | DeleteFailed |
| Degraded | Degraded |
| Update | UpdateFailed |
| Name | Value |
|---|---|
| Creating | Creating |
| Active | Active |
| Create | CreateFailed |
| Updating | Updating |
| Deleting | Deleting |
| Delete | DeleteFailed |
| Degraded | Degraded |
| Update | UpdateFailed |
| Name | Value |
|---|---|
| CREATING | Creating |
| ACTIVE | Active |
| CREATE_FAILED | CreateFailed |
| UPDATING | Updating |
| DELETING | Deleting |
| DELETE_FAILED | DeleteFailed |
| DEGRADED | Degraded |
| UPDATE_FAILED | UpdateFailed |
| Value |
|---|
Creating |
Active |
CreateFailed |
Updating |
Deleting |
DeleteFailed |
Degraded |
UpdateFailed |
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi