studios

Creates, updates, deletes or gets a studio resource or lists studios in a region

Overview

Name	studios
Type	Resource
Description	Represents a studio that contains other Nimble Studio resources
Id	aws.nimblestudio.studios

Fields

Name	Datatype	Description
admin_role_arn	string	The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
display_name	string	A friendly name for the studio.
home_region	string	The Amazon Web Services Region where the studio resource is located.
sso_client_id	string	The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.
studio_encryption_configuration	object	Configuration of the encryption method that is used for the studio.
studio_id	string
studio_name	string	The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
studio_url	string	The address of the web page for the studio.
tags	object
user_role_arn	string	The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DisplayName, UserRoleArn, AdminRoleArn, StudioName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all studios in a region.

SELECT
region,
admin_role_arn,
display_name,
home_region,
sso_client_id,
studio_encryption_configuration,
studio_id,
studio_name,
studio_url,
tags,
user_role_arn
FROM aws.nimblestudio.studios
WHERE region = 'us-east-1';

Gets all properties from an individual studio.

SELECT
region,
admin_role_arn,
display_name,
home_region,
sso_client_id,
studio_encryption_configuration,
studio_id,
studio_name,
studio_url,
tags,
user_role_arn
FROM aws.nimblestudio.studios
WHERE region = 'us-east-1' AND data__Identifier = '<StudioId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.nimblestudio.studios (
 AdminRoleArn,
 DisplayName,
 StudioName,
 UserRoleArn,
 region
)
SELECT 
'{{ AdminRoleArn }}',
 '{{ DisplayName }}',
 '{{ StudioName }}',
 '{{ UserRoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.nimblestudio.studios (
 AdminRoleArn,
 DisplayName,
 StudioEncryptionConfiguration,
 StudioName,
 Tags,
 UserRoleArn,
 region
)
SELECT 
 '{{ AdminRoleArn }}',
 '{{ DisplayName }}',
 '{{ StudioEncryptionConfiguration }}',
 '{{ StudioName }}',
 '{{ Tags }}',
 '{{ UserRoleArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: studio
    props:
      - name: AdminRoleArn
        value: '{{ AdminRoleArn }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: StudioEncryptionConfiguration
        value:
          KeyType: '{{ KeyType }}'
          KeyArn: '{{ KeyArn }}'
      - name: StudioName
        value: '{{ StudioName }}'
      - name: Tags
        value: {}
      - name: UserRoleArn
        value: '{{ UserRoleArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.nimblestudio.studios
WHERE data__Identifier = '<StudioId>'
AND region = 'us-east-1';

Permissions

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

Create

iam:PassRole,
nimble:CreateStudio,
nimble:GetStudio,
nimble:TagResource,
sso:CreateManagedApplicationInstance,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:ListGrants,
kms:GenerateDataKey

Read

nimble:GetStudio,
kms:Encrypt,
kms:Decrypt,
kms:ListGrants,
kms:GenerateDataKey

Update

iam:PassRole,
nimble:UpdateStudio,
nimble:GetStudio,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:ListGrants,
kms:GenerateDataKey

Delete

nimble:DeleteStudio,
nimble:GetStudio,
nimble:UntagResource,
kms:Encrypt,
kms:Decrypt,
kms:ListGrants,
kms:RetireGrant,
kms:GenerateDataKey,
sso:DeleteManagedApplicationInstance,
sso:GetManagedApplicationInstance

List

nimble:ListStudios