storage_profiles

Creates, updates, deletes or gets a storage_profile resource or lists storage_profiles in a region

Overview

Name	storage_profiles
Type	Resource
Description	Definition of AWS::Deadline::StorageProfile Resource Type
Id	aws.deadline.storage_profiles

Fields

Name	Datatype	Description
display_name	string
farm_id	string
file_system_locations	array
os_family	string
storage_profile_id	string
region	string	AWS region.

For more information, see AWS::Deadline::StorageProfile.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DisplayName, FarmId, OsFamily, 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 storage_profiles in a region.

SELECT
region,
display_name,
farm_id,
file_system_locations,
os_family,
storage_profile_id
FROM aws.deadline.storage_profiles
WHERE region = 'us-east-1';

Gets all properties from an individual storage_profile.

SELECT
region,
display_name,
farm_id,
file_system_locations,
os_family,
storage_profile_id
FROM aws.deadline.storage_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<FarmId>|<StorageProfileId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.deadline.storage_profiles (
 DisplayName,
 FarmId,
 OsFamily,
 region
)
SELECT 
'{{ DisplayName }}',
 '{{ FarmId }}',
 '{{ OsFamily }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.deadline.storage_profiles (
 DisplayName,
 FarmId,
 FileSystemLocations,
 OsFamily,
 region
)
SELECT 
 '{{ DisplayName }}',
 '{{ FarmId }}',
 '{{ FileSystemLocations }}',
 '{{ OsFamily }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: storage_profile
    props:
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: FarmId
        value: '{{ FarmId }}'
      - name: FileSystemLocations
        value:
          - Name: '{{ Name }}'
            Path: '{{ Path }}'
            Type: '{{ Type }}'
      - name: OsFamily
        value: '{{ OsFamily }}'

DELETE example

/*+ delete */
DELETE FROM aws.deadline.storage_profiles
WHERE data__Identifier = '<FarmId|StorageProfileId>'
AND region = 'us-east-1';

Permissions

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

Create

deadline:CreateStorageProfile,
deadline:GetStorageProfile,
identitystore:ListGroupMembershipsForMember

Read

deadline:GetStorageProfile,
identitystore:ListGroupMembershipsForMember

Update

deadline:UpdateStorageProfile,
deadline:GetStorageProfile,
identitystore:ListGroupMembershipsForMember

Delete

deadline:DeleteStorageProfile,
deadline:GetStorageProfile,
identitystore:ListGroupMembershipsForMember

List

deadline:ListStorageProfiles,
identitystore:ListGroupMembershipsForMember