Package software.amazon.awscdk.services.deadline

Class CfnStorageProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.deadline.CfnStorageProfile
All Implemented Interfaces:
IInspectable, IStorageProfileRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:10.999Z") @Stability(Stable) public class CfnStorageProfile extends CfnResource implements IInspectable, IStorageProfileRef
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.deadline.*;
 CfnStorageProfile cfnStorageProfile = CfnStorageProfile.Builder.create(this, "MyCfnStorageProfile")
         .displayName("displayName")
         .farmId("farmId")
         .osFamily("osFamily")
         // the properties below are optional
         .fileSystemLocations(List.of(FileSystemLocationProperty.builder()
                 .name("name")
                 .path("path")
                 .type("type")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStorageProfile

      protected CfnStorageProfile(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStorageProfile

      protected CfnStorageProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStorageProfile

      @Stability(Stable) public CfnStorageProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStorageProfileProps props)
      Create a new AWS::Deadline::StorageProfile.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnStorageProfile

      @Stability(Stable) @NotNull public static Boolean isCfnStorageProfile(@NotNull Object x)
      Checks whether the given object is a CfnStorageProfile.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrStorageProfileId

      @Stability(Stable) @NotNull public String getAttrStorageProfileId()
      The storage profile ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStorageProfileRef

      @Stability(Stable) @NotNull public StorageProfileReference getStorageProfileRef()
      A reference to a StorageProfile resource.
      Specified by:
      getStorageProfileRef in interface IStorageProfileRef

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The display name of the storage profile summary to update.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The display name of the storage profile summary to update.

    • getFarmId

      @Stability(Stable) @NotNull public String getFarmId()
      The unique identifier of the farm that contains the storage profile.

    • setFarmId

      @Stability(Stable) public void setFarmId(@NotNull String value)
      The unique identifier of the farm that contains the storage profile.

    • getOsFamily

      @Stability(Stable) @NotNull public String getOsFamily()
      The operating system (OS) family.

    • setOsFamily

      @Stability(Stable) public void setOsFamily(@NotNull String value)
      The operating system (OS) family.

    • getFileSystemLocations

      @Stability(Stable) @Nullable public Object getFileSystemLocations()
      Operating system specific file system path to the storage location.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStorageProfile.FileSystemLocationProperty>

    • setFileSystemLocations

      @Stability(Stable) public void setFileSystemLocations(@Nullable IResolvable value)
      Operating system specific file system path to the storage location.

    • setFileSystemLocations

      @Stability(Stable) public void setFileSystemLocations(@Nullable List<Object> value)
      Operating system specific file system path to the storage location.