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.
Using getExtension
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getExtension(args: GetExtensionArgs, opts?: InvokeOptions): Promise<GetExtensionResult>
function getExtensionOutput(args: GetExtensionOutputArgs, opts?: InvokeOutputOptions): Output<GetExtensionResult>def get_extension(extension_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetExtensionResult
def get_extension_output(extension_arn: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetExtensionResult]func LookupExtension(ctx *Context, args *LookupExtensionArgs, opts ...InvokeOption) (*LookupExtensionResult, error)
func LookupExtensionOutput(ctx *Context, args *LookupExtensionOutputArgs, opts ...InvokeOption) LookupExtensionResultOutput> Note: This function is named LookupExtension in the Go SDK.
public static class GetExtension
{
public static Task<GetExtensionResult> InvokeAsync(GetExtensionArgs args, InvokeOptions? opts = null)
public static Output<GetExtensionResult> Invoke(GetExtensionInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetExtensionResult> Invoke(GetExtensionInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetExtensionResult> getExtension(GetExtensionArgs args, InvokeOptions options)
public static Output<GetExtensionResult> getExtension(GetExtensionArgs args, InvokeOptions options)
public static Output<GetExtensionResult> getExtension(GetExtensionArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:sagemaker:getExtension
arguments:
# arguments dictionarydata "aws-native_sagemaker_get_extension" "name" {
# arguments
}The following arguments are supported:
- Extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- Extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- extension_
arn string - The Amazon Resource Name (ARN) of the extension.
- extension
Arn String - The Amazon Resource Name (ARN) of the extension.
- extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- extension_
arn str - The Amazon Resource Name (ARN) of the extension.
- extension
Arn String - The Amazon Resource Name (ARN) of the extension.
getExtension Result
The following output properties are available:
- 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.
- Creation
Time string - The date and time that you created the extension.
- Extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- 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.
- 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.
-
List<Pulumi.
Aws Native. Outputs. Tag> - The tags to add to the extension. You can add up to 50 tags.
- 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.
- Creation
Time string - The date and time that you created the extension.
- Extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- 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.
- 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.
- Tag
- The tags to add to the extension. You can add up to 50 tags.
- 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.
- creation_
time string - The date and time that you created the extension.
- extension_
arn string - The Amazon Resource Name (ARN) of the extension.
- 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.
- 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.
- list(object)
- The tags to add to the extension. You can add up to 50 tags.
- 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.
- creation
Time String - The date and time that you created the extension.
- extension
Arn String - The Amazon Resource Name (ARN) of the extension.
- 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.
- 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.
- List<Tag>
- The tags to add to the extension. You can add up to 50 tags.
- 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.
- creation
Time string - The date and time that you created the extension.
- extension
Arn string - The Amazon Resource Name (ARN) of the extension.
- 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.
- 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.
- Tag[]
- The tags to add to the extension. You can add up to 50 tags.
- 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.
- creation_
time str - The date and time that you created the extension.
- extension_
arn str - The Amazon Resource Name (ARN) of the extension.
- 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.
- 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.
- Sequence[root_Tag]
- The tags to add to the extension. You can add up to 50 tags.
- 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.
- creation
Time String - The date and time that you created the extension.
- extension
Arn String - The Amazon Resource Name (ARN) of the extension.
- 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.
- 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.
- List<Property Map>
- The tags to add to the extension. You can add up to 50 tags.
Supporting Types
ExtensionNodeSummary
- 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
| 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
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