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	awscc.deadline.storage_profiles

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
farm_id	string
storage_profile_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	storage_profiles	INSERT	DisplayName, FarmId, OsFamily, region
delete_resource	storage_profiles	DELETE	Identifier, region
update_resource	storage_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	storage_profiles_list_only	SELECT	region
get_resource	storage_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual storage_profile.

SELECT
  region,
  display_name,
  farm_id,
  file_system_locations,
  os_family,
  storage_profile_id
FROM awscc.deadline.storage_profiles
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ farm_id }}|{{ storage_profile_id }}';

list (identifiers only)

Lists all storage_profiles in a region.

SELECT
  region,
  farm_id,
  storage_profile_id
FROM awscc.deadline.storage_profiles_list_only
WHERE
  region = '{{ region }}';

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 awscc.deadline.storage_profiles (
  DisplayName,
  FarmId,
  OsFamily,
  region
)
SELECT
  '{{ display_name }}',
  '{{ farm_id }}',
  '{{ os_family }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.deadline.storage_profiles (
  DisplayName,
  FarmId,
  FileSystemLocations,
  OsFamily,
  region
)
SELECT
  '{{ display_name }}',
  '{{ farm_id }}',
  '{{ file_system_locations }}',
  '{{ os_family }}',
  '{{ 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: storage_profile
  props:
    - name: display_name
      value: '{{ display_name }}'
    - name: farm_id
      value: '{{ farm_id }}'
    - name: file_system_locations
      value:
        - name: '{{ name }}'
          path: '{{ path }}'
          type: '{{ type }}'
    - name: os_family
      value: '{{ os_family }}'

UPDATE example

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

/*+ update */
UPDATE awscc.deadline.storage_profiles
SET PatchDocument = string('{{ {
    "DisplayName": display_name,
    "FileSystemLocations": file_system_locations,
    "OsFamily": os_family
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ farm_id }}|{{ storage_profile_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.storage_profiles
WHERE
  Identifier = '{{ farm_id }}|{{ storage_profile_id }}' 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 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