storage_profiles

Creates, updates, deletes, gets or lists a storage_profiles resource.

Overview

Name	storage_profiles
Type	Resource
Id	aws.deadline.storage_profiles

Fields

The following fields are returned by SELECT queries:

get_storage_profile

Name	Datatype	Description
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
display_name	string	The display name of the storage profile. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
file_system_locations	array	The location of the files for the storage profile.
os_family	string	The operating system (OS) for the storage profile. (WINDOWS, LINUX, MACOS)
storage_profile_id	string	The storage profile ID. (pattern: <code>sp-[0-9a-f]{32}</code>)
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

list_storage_profiles

Name	Datatype	Description
display_name	string	The display name of the storage profile summary to update. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
os_family	string	The operating system (OS) family. (WINDOWS, LINUX, MACOS)
storage_profile_id	string	The storage profile ID. (pattern: <code>sp-[0-9a-f]{32}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_storage_profile	select	farm_id, storage_profile_id, region		Gets a storage profile.
list_storage_profiles	select	farm_id, region	nextToken, maxResults	Lists storage profiles.
create_storage_profile	insert	farm_id, region, displayName, osFamily	X-Amz-Client-Token	Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
update_storage_profile	update	farm_id, storage_profile_id, region	X-Amz-Client-Token	Updates a storage profile.
delete_storage_profile	delete	farm_id, storage_profile_id, region		Deletes a storage profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
farm_id	string	The farm ID of the farm from which to remove the storage profile.
region	string	AWS region (default: us-east-1)
storage_profile_id	string	The storage profile ID of the storage profile to delete.
X-Amz-Client-Token	string	The unique token which the server uses to recognize retries of the same request.
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

get_storage_profile

Gets a storage profile.

SELECT
created_at,
created_by,
display_name,
file_system_locations,
os_family,
storage_profile_id,
updated_at,
updated_by
FROM aws.deadline.storage_profiles
WHERE farm_id = '{{ farm_id }}' -- required
AND storage_profile_id = '{{ storage_profile_id }}' -- required
AND region = '{{ region }}' -- required
;

list_storage_profiles

Lists storage profiles.

SELECT
display_name,
os_family,
storage_profile_id
FROM aws.deadline.storage_profiles
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_storage_profile

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

INSERT INTO aws.deadline.storage_profiles (
displayName,
osFamily,
fileSystemLocations,
farm_id,
region,
`X-Amz-Client-Token`
)
SELECT 
'{{ displayName }}' /* required */,
'{{ osFamily }}' /* required */,
'{{ fileSystemLocations }}',
'{{ farm_id }}',
'{{ region }}',
'{{ X-Amz-Client-Token }}'
RETURNING
storage_profile_id
;

Manifest

# Description fields are for documentation purposes
- name: storage_profiles
props:
  - name: farm_id
    value: "{{ farm_id }}"
    description: Required parameter for the storage_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the storage_profiles resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: osFamily
    value: "{{ osFamily }}"
    valid_values: ['WINDOWS', 'LINUX', 'MACOS']
  - name: fileSystemLocations
    value:
      - name: "{{ name }}"
        path: "{{ path }}"
        type_: "{{ type_ }}"
  - name: X-Amz-Client-Token
    value: "{{ X-Amz-Client-Token }}"
    description: The unique token which the server uses to recognize retries of the same request.
    description: The unique token which the server uses to recognize retries of the same request.

UPDATE examples

update_storage_profile

Updates a storage profile.

UPDATE aws.deadline.storage_profiles
SET 
displayName = '{{ displayName }}',
osFamily = '{{ osFamily }}',
fileSystemLocationsToAdd = '{{ fileSystemLocationsToAdd }}',
fileSystemLocationsToRemove = '{{ fileSystemLocationsToRemove }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND storage_profile_id = '{{ storage_profile_id }}' --required
AND region = '{{ region }}' --required
AND `X-Amz-Client-Token` = '{{ X-Amz-Client-Token}}';

DELETE examples

delete_storage_profile

Deletes a storage profile.

DELETE FROM aws.deadline.storage_profiles
WHERE farm_id = '{{ farm_id }}' --required
AND storage_profile_id = '{{ storage_profile_id }}' --required
AND region = '{{ region }}' --required
;