AWS::Deadline::StorageProfile - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Deadline::StorageProfile

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Deadline::StorageProfile",
  "Properties" : {
      "DisplayName" : String,
      "FarmId" : String,
      "FileSystemLocations" : [ FileSystemLocation, ... ],
      "OsFamily" : String
    }
}

YAML

Type: AWS::Deadline::StorageProfile
Properties:
  DisplayName: String
  FarmId: String
  FileSystemLocations: 
    - FileSystemLocation
  OsFamily: String

Properties

DisplayName

The display name of the storage profile summary to update.

Important

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.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

FarmId

The unique identifier of the farm that contains the storage profile.

Required: Yes

Type: String

Pattern: ^farm-[0-9a-f]{32}$

Update requires: Replacement

FileSystemLocations

Operating system specific file system path to the storage location.

Required: No

Type: Array of FileSystemLocation

Minimum: 0

Maximum: 20

Update requires: No interruption

OsFamily

The operating system (OS) family.

Required: Yes

Type: String

Allowed values: WINDOWS | LINUX | MACOS

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the storage profile.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

StorageProfileId

The storage profile ID.