1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. sagemaker
  6. Extension

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
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:

    ClusterArn string
    The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
    ConfigurationValues 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.
    ExtensionName string
    The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
    ExtensionVersion 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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to add to the extension. You can add up to 50 tags.
    ClusterArn string
    The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
    ConfigurationValues 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.
    ExtensionName string
    The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
    ExtensionVersion 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.
    Tags TagArgs
    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.
    tags list(object)
    The tags to add to the extension. You can add up to 50 tags.
    clusterArn String
    The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
    configurationValues 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.
    extensionName String
    The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
    extensionVersion 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.
    tags List<Tag>
    The tags to add to the extension. You can add up to 50 tags.
    clusterArn string
    The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
    configurationValues 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.
    extensionName string
    The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
    extensionVersion 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.
    tags 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.
    tags Sequence[TagArgs]
    The tags to add to the extension. You can add up to 50 tags.
    clusterArn String
    The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
    configurationValues 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.
    extensionName String
    The name of the extension to install, such as sagemaker-observability. You can't install the same extension twice on a cluster.
    extensionVersion 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.
    tags 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:

    CreationTime string
    The date and time that you created the extension.
    ExtensionArn string
    The Amazon Resource Name (ARN) of the extension.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The date and time of the most recent change to the extension.
    NodeSummary Pulumi.AwsNative.SageMaker.Outputs.ExtensionNodeSummary
    Status Pulumi.AwsNative.SageMaker.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.
    CreationTime string
    The date and time that you created the extension.
    ExtensionArn string
    The Amazon Resource Name (ARN) of the extension.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The date and time of the most recent change to the extension.
    NodeSummary ExtensionNodeSummary
    Status 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.
    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_time string
    The date and time of the most recent change to the extension.
    node_summary object
    status "Creating" | "Active" | "CreateFailed" | "Updating" | "Deleting" | "DeleteFailed" | "Degraded" | "UpdateFailed"
    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.
    creationTime String
    The date and time that you created the extension.
    extensionArn String
    The Amazon Resource Name (ARN) of the extension.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The date and time of the most recent change to the extension.
    nodeSummary ExtensionNodeSummary
    status 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.
    creationTime string
    The date and time that you created the extension.
    extensionArn string
    The Amazon Resource Name (ARN) of the extension.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    The date and time of the most recent change to the extension.
    nodeSummary ExtensionNodeSummary
    status 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.
    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_time str
    The date and time of the most recent change to the extension.
    node_summary ExtensionNodeSummary
    status 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.
    creationTime String
    The date and time that you created the extension.
    extensionArn String
    The Amazon Resource Name (ARN) of the extension.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The date and time of the most recent change to the extension.
    nodeSummary Property Map
    status "Creating" | "Active" | "CreateFailed" | "Updating" | "Deleting" | "DeleteFailed" | "Degraded" | "UpdateFailed"
    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) -> Extension
    func 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.

    ActiveCount int
    The number of cluster nodes that run the requested extension version.
    TotalCount int
    The number of cluster nodes that the extension applies to.
    ActiveCount int
    The number of cluster nodes that run the requested extension version.
    TotalCount 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.
    activeCount Integer
    The number of cluster nodes that run the requested extension version.
    totalCount Integer
    The number of cluster nodes that the extension applies to.
    activeCount number
    The number of cluster nodes that run the requested extension version.
    totalCount 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.
    activeCount Number
    The number of cluster nodes that run the requested extension version.
    totalCount 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.

    NameValue
    CreatingCreating
    ActiveActive
    CreateFailedCreateFailed
    UpdatingUpdating
    DeletingDeleting
    DeleteFailedDeleteFailed
    DegradedDegraded
    UpdateFailedUpdateFailed
    NameValue
    ExtensionStatusCreatingCreating
    ExtensionStatusActiveActive
    ExtensionStatusCreateFailedCreateFailed
    ExtensionStatusUpdatingUpdating
    ExtensionStatusDeletingDeleting
    ExtensionStatusDeleteFailedDeleteFailed
    ExtensionStatusDegradedDegraded
    ExtensionStatusUpdateFailedUpdateFailed
    Value
    Creating
    Active
    CreateFailed
    Updating
    Deleting
    DeleteFailed
    Degraded
    UpdateFailed
    NameValue
    CreatingCreating
    ActiveActive
    CreateFailedCreateFailed
    UpdatingUpdating
    DeletingDeleting
    DeleteFailedDeleteFailed
    DegradedDegraded
    UpdateFailedUpdateFailed
    NameValue
    CreatingCreating
    ActiveActive
    CreateFailedCreateFailed
    UpdatingUpdating
    DeletingDeleting
    DeleteFailedDeleteFailed
    DegradedDegraded
    UpdateFailedUpdateFailed
    NameValue
    CREATINGCreating
    ACTIVEActive
    CREATE_FAILEDCreateFailed
    UPDATINGUpdating
    DELETINGDeleting
    DELETE_FAILEDDeleteFailed
    DEGRADEDDegraded
    UPDATE_FAILEDUpdateFailed
    Value
    Creating
    Active
    CreateFailed
    Updating
    Deleting
    DeleteFailed
    Degraded
    UpdateFailed

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial