CfnExtensionProps Struct
Properties for defining a CfnExtension.
| Source |
|---|
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnExtensionProps: sagemaker.CfnExtensionProps = {
clusterArn: 'clusterArn',
extensionName: 'extensionName',
// the properties below are optional
configurationValues: 'configurationValues',
extensionVersion: 'extensionVersion',
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker
cfn_extension_props = sagemaker.CfnExtensionProps(
cluster_arn="clusterArn",
extension_name="extensionName",
# the properties below are optional
configuration_values="configurationValues",
extension_version="extensionVersion",
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;
CfnExtensionProps cfnExtensionProps = CfnExtensionProps.builder()
.clusterArn("clusterArn")
.extensionName("extensionName")
// the properties below are optional
.configurationValues("configurationValues")
.extensionVersion("extensionVersion")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var cfnExtensionProps = new CfnExtensionProps {
ClusterArn = "clusterArn",
ExtensionName = "extensionName",
// the properties below are optional
ConfigurationValues = "configurationValues",
ExtensionVersion = "extensionVersion",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnExtensionProps := &CfnExtensionProps{
ClusterArn: jsii.String("clusterArn"),
ExtensionName: jsii.String("extensionName"),
// the properties below are optional
ConfigurationValues: jsii.String("configurationValues"),
ExtensionVersion: jsii.String("extensionVersion"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
The Amazon Resource Name (ARN) of the Amazon SageMaker HyperPod cluster to install the extension on.
configurationValuesoptionalstringconfiguration_valuesoptionalstrconfigurationValuesoptionalStringConfigurationValuesoptionalstringConfigurationValuesoptional*string #The configuration settings for the extension, as a JSON string.
notes
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.
extensionNamestringextension_namestrextensionNameStringExtensionNamestringExtensionName*string required #The name of the extension to install, such as sagemaker-observability.
You can't install the same extension twice on a cluster.
extensionVersionoptionalstringextension_versionoptionalstrextensionVersionoptionalStringExtensionVersionoptionalstringExtensionVersionoptional*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.