AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::SageMaker::NotebookInstanceLifecycleConfig

AWS::SageMaker::NotebookInstanceLifecycleConfig リソースは、ノートブックインスタンスを作成または起動時に実行されるシェルスクリプトを指定します。詳細については、Amazon SageMaker 開発者ガイドの「ノートブックインスタンスをカスタマイズする」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{ "Type" : "AWS::SageMaker::NotebookInstanceLifecycleConfig", "Properties" : { "OnStart" : [ NotebookInstanceLifecycleHook, ... ], "NotebookInstanceLifecycleConfigName" : String, "OnCreate" : [ NotebookInstanceLifecycleHook, ... ] } }

YAML

Type: "AWS::SageMaker::NotebookInstanceLifecycleConfig" Properties: OnStart: - NotebookInstanceLifecycleHook NotebookInstanceLifecycleConfigName: String OnCreate: - NotebookInstanceLifecycleHook

プロパティ

OnStart

ノートブックインスタンスを作成した後、ノートブックインスタンスを起動するたびに実行されるシェルスクリプト。

必須: いいえ

: Amazon SageMaker NotebookInstanceLifecycleConfig NotebookInstanceLifecycleHook のリスト

更新に伴う要件: 中断はありません。

NotebookInstanceLifecycleConfigName

ライフサイクル設定の名前。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

OnCreate

ノートブックインスタンスを作成するときに 1 回だけ実行されるシェルスクリプト。

必須: いいえ

: Amazon SageMaker NotebookInstanceLifecycleConfig NotebookInstanceLifecycleHook のリスト

更新に伴う要件: 中断はありません。

戻り値

参照番号

AWS::SageMaker::NotebookInstanceLifecycleConfig リソースの論理 ID を組み込み Ref 関数に渡すと、関数はライフサイクル構成の Amazon リソースネーム (ARN) (arn:aws:sagemaker:us-west-2:012345678901:notebook-instance-lifecycle-config/mylifecycleconfig など) を返します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

Fn::GetAtt は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

NotebookInstanceLifecycleConfigName

ライフサイクル設定の名前 (MyLifecycleConfig など)。

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

ノートブックインスタンスのライフサイクル設定例

次の例では、関連するライフサイクル設定を持つノートブックインスタンスを作成します。

JSON

{ "Description": "Basic NotebookInstance test", "Resources": { "BasicNotebookInstance": { "Type": "AWS::SageMaker::NotebookInstance", "Properties": { "InstanceType": "ml.t2.medium", "RoleArn": { "Fn::GetAtt" : [ "ExecutionRole", "Arn" ] }, "LifecycleConfigName": { "Fn::GetAtt" : [ "BasicNotebookInstanceLifecycleConfig", "NotebookInstanceLifecycleConfigName" ] } }, "BasicNotebookInstanceLifecycleConfig": { "Type": "AWS::SageMaker::NotebookInstanceLifecycleConfig", "Properties": { "OnStart": [ { "Content": { "Fn::Base64": "echo 'hello'" } } ] } }, "ExecutionRole": { "Type": "AWS::IAM::Role", "Properties": { "AssumeRolePolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": [ "sagemaker.amazonaws.com" ] }, "Action": [ "sts:AssumeRole" ] } ] }, "Path": "/", "Policies": [ { "PolicyName": "root", "PolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "*", "Resource": "*" } ] } } ] } } }, "Outputs": { "BasicNotebookInstanceId": { "Value": { "Ref" : "BasicNotebookInstance" } }, "BasicNotebookInstanceLifecycleConfigId": { "Value": { "Ref" : "BasicNotebookInstanceLifecycleConfig" } } }, }

YAML

Description: "Basic NotebookInstance test" Resources: BasicNotebookInstance: Type: "AWS::SageMaker::NotebookInstance" Properties: InstanceType: "ml.t2.medium" RoleArn: !GetAtt ExecutionRole.Arn LifecycleConfigName: !GetAtt BasicNotebookInstanceLifecycleConfig.NotebookInstanceLifecycleConfigName BasicNotebookInstanceLifecycleConfig: Type: "AWS::SageMaker::NotebookInstanceLifecycleConfig" Properties: OnStart: - Content: Fn::Base64: "echo 'hello'" ExecutionRole: Type: "AWS::IAM::Role" Properties: AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: "Allow" Principal: Service: - "sagemaker.amazonaws.com" Action: - "sts:AssumeRole" Path: "/" Policies: - PolicyName: "root" PolicyDocument: Version: "2012-10-17" Statement: - Effect: "Allow" Action: "*" Resource: "*" Outputs: BasicNotebookInstanceId: Value: !Ref BasicNotebookInstance BasicNotebookInstanceLifecycleConfigId: Value: !Ref BasicNotebookInstanceLifecycleConfig

このページの内容: