studio_lifecycle_configs

Creates, updates, deletes or gets a studio_lifecycle_config resource or lists studio_lifecycle_configs in a region

Overview

Name	studio_lifecycle_configs
Type	Resource
Description	Resource Type definition for AWS::SageMaker::StudioLifecycleConfig
Id	awscc.sagemaker.studio_lifecycle_configs

Fields

get (all properties)

Name	Datatype	Description
studio_lifecycle_config_arn	string	The Amazon Resource Name (ARN) of the Lifecycle Configuration.
studio_lifecycle_config_app_type	string	The App type that the Lifecycle Configuration is attached to.
studio_lifecycle_config_content	string	The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.
studio_lifecycle_config_name	string	The name of the Amazon SageMaker Studio Lifecycle Configuration.
▶tags	array	Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
studio_lifecycle_config_name	string	The name of the Amazon SageMaker Studio Lifecycle Configuration.
region	string	AWS region.

For more information, see AWS::SageMaker::StudioLifecycleConfig.

Methods

Name	Resource	Accessible by	Required Params
create_resource	studio_lifecycle_configs	INSERT	StudioLifecycleConfigAppType, StudioLifecycleConfigContent, StudioLifecycleConfigName, region
delete_resource	studio_lifecycle_configs	DELETE	Identifier, region
list_resources	studio_lifecycle_configs_list_only	SELECT	region
get_resource	studio_lifecycle_configs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual studio_lifecycle_config.

SELECT
  region,
  studio_lifecycle_config_arn,
  studio_lifecycle_config_app_type,
  studio_lifecycle_config_content,
  studio_lifecycle_config_name,
  tags
FROM awscc.sagemaker.studio_lifecycle_configs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ studio_lifecycle_config_name }}';

list (identifiers only)

Lists all studio_lifecycle_configs in a region.

SELECT
  region,
  studio_lifecycle_config_name
FROM awscc.sagemaker.studio_lifecycle_configs_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new studio_lifecycle_config resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.sagemaker.studio_lifecycle_configs (
  StudioLifecycleConfigAppType,
  StudioLifecycleConfigContent,
  StudioLifecycleConfigName,
  region
)
SELECT
  '{{ studio_lifecycle_config_app_type }}',
  '{{ studio_lifecycle_config_content }}',
  '{{ studio_lifecycle_config_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.studio_lifecycle_configs (
  StudioLifecycleConfigAppType,
  StudioLifecycleConfigContent,
  StudioLifecycleConfigName,
  Tags,
  region
)
SELECT
  '{{ studio_lifecycle_config_app_type }}',
  '{{ studio_lifecycle_config_content }}',
  '{{ studio_lifecycle_config_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: studio_lifecycle_config
  props:
    - name: studio_lifecycle_config_app_type
      value: '{{ studio_lifecycle_config_app_type }}'
    - name: studio_lifecycle_config_content
      value: '{{ studio_lifecycle_config_content }}'
    - name: studio_lifecycle_config_name
      value: '{{ studio_lifecycle_config_name }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.studio_lifecycle_configs
WHERE
  Identifier = '{{ studio_lifecycle_config_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the studio_lifecycle_configs resource, the following permissions are required:

Create

sagemaker:CreateStudioLifecycleConfig,
sagemaker:DescribeStudioLifecycleConfig,
sagemaker:AddTags,
sagemaker:ListTags

Read

sagemaker:DescribeStudioLifecycleConfig,
sagemaker:ListTags

Delete

sagemaker:DeleteStudioLifecycleConfig,
sagemaker:DescribeStudioLifecycleConfig,
sagemaker:DeleteTags,
sagemaker:ListTags

List

sagemaker:ListStudioLifecycleConfigs,
sagemaker:ListTags