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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:00.023Z")
@Stability(Stable)
public class CfnStorageProfile
extends CfnResource
implements IInspectable

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")
         .osFamily("osFamily")
         // the properties below are optional
         .farmId("farmId")
         .fileSystemLocations(List.of(FileSystemLocationProperty.builder()
                 .name("name")
                 .path("path")
                 .type("type")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnStorageProfile.Builder	A fluent builder for CfnStorageProfile.
static interface	CfnStorageProfile.FileSystemLocationProperty	The details of the file system location for the resource.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnStorageProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStorageProfile(software.amazon.jsii.JsiiObjectRef objRef)
	CfnStorageProfile(software.constructs.Construct scope, String id, CfnStorageProfileProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrStorageProfileId()	The storage profile ID.
protected Map<String,Object>	getCfnProperties()
String	getDisplayName()	The display name of the storage profile summary to update.
String	getFarmId()	The unique identifier of the farm that contains the storage profile.
Object	getFileSystemLocations()	Operating system specific file system path to the storage location.
String	getOsFamily()	The operating system (OS) family.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDisplayName(String value)	The display name of the storage profile summary to update.
void	setFarmId(String value)	The unique identifier of the farm that contains the storage profile.
void	setFileSystemLocations(List<Object> value)	Operating system specific file system path to the storage location.
void	setFileSystemLocations(IResolvable value)	Operating system specific file system path to the storage location.
void	setOsFamily(String value)	The operating system (OS) family.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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)

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

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

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.

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.

getFarmId

@Stability(Stable)
@Nullable
public String getFarmId()

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

setFarmId

@Stability(Stable)
public void setFarmId(@Nullable
 String value)

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

getFileSystemLocations

@Stability(Stable)
@Nullable
public Object getFileSystemLocations()

Operating system specific file system path to the storage location.

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.