software.amazon.awscdk.services.nimblestudio

Class CfnStudioComponent

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.nimblestudio.CfnStudioComponent

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.073Z")
 @Stability(value=Stable)
public class CfnStudioComponent
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NimbleStudio::StudioComponent`.

The AWS::NimbleStudio::StudioComponent resource represents a network resource that is used by a studio's users and workflows. A typical studio contains studio components for the following: a render farm, an Active Directory, a licensing service, and a shared file system.

Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.

A studio component also has a set of initialization scripts, which are returned by GetLaunchProfileInitialization . These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how studio resources are configured on a streaming session.

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.nimblestudio.*;
 CfnStudioComponent cfnStudioComponent = CfnStudioComponent.Builder.create(this, "MyCfnStudioComponent")
         .name("name")
         .studioId("studioId")
         .type("type")
         // the properties below are optional
         .configuration(StudioComponentConfigurationProperty.builder()
                 .activeDirectoryConfiguration(ActiveDirectoryConfigurationProperty.builder()
                         .computerAttributes(List.of(ActiveDirectoryComputerAttributeProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .directoryId("directoryId")
                         .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                         .build())
                 .computeFarmConfiguration(ComputeFarmConfigurationProperty.builder()
                         .activeDirectoryUser("activeDirectoryUser")
                         .endpoint("endpoint")
                         .build())
                 .licenseServiceConfiguration(LicenseServiceConfigurationProperty.builder()
                         .endpoint("endpoint")
                         .build())
                 .sharedFileSystemConfiguration(SharedFileSystemConfigurationProperty.builder()
                         .endpoint("endpoint")
                         .fileSystemId("fileSystemId")
                         .linuxMountPoint("linuxMountPoint")
                         .shareName("shareName")
                         .windowsMountDrive("windowsMountDrive")
                         .build())
                 .build())
         .description("description")
         .ec2SecurityGroupIds(List.of("ec2SecurityGroupIds"))
         .initializationScripts(List.of(StudioComponentInitializationScriptProperty.builder()
                 .launchProfileProtocolVersion("launchProfileProtocolVersion")
                 .platform("platform")
                 .runContext("runContext")
                 .script("script")
                 .build()))
         .scriptParameters(List.of(ScriptParameterKeyValueProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .subtype("subtype")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnStudioComponent.ActiveDirectoryComputerAttributeProperty An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
static interface	CfnStudioComponent.ActiveDirectoryConfigurationProperty The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
static class	CfnStudioComponent.Builder A fluent builder for CfnStudioComponent.
static interface	CfnStudioComponent.ComputeFarmConfigurationProperty The configuration for a render farm that is associated with a studio resource.
static interface	CfnStudioComponent.LicenseServiceConfigurationProperty The configuration for a license service that is associated with a studio resource.
static interface	CfnStudioComponent.ScriptParameterKeyValueProperty A parameter for a studio component script, in the form of a key:value pair.
static interface	CfnStudioComponent.SharedFileSystemConfigurationProperty The configuration for a shared file storage system that is associated with a studio resource.
static interface	CfnStudioComponent.StudioComponentConfigurationProperty The configuration of the studio component, based on component type.
static interface	CfnStudioComponent.StudioComponentInitializationScriptProperty Initialization scripts for studio components.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStudioComponent(software.constructs.Construct scope, String id, CfnStudioComponentProps props) Create a new `AWS::NimbleStudio::StudioComponent`.
protected	CfnStudioComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStudioComponent(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrStudioComponentId() The unique identifier for the studio component resource.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration() The configuration of the studio component, based on component type.
String	getDescription() A human-readable description for the studio component resource.
List<String>	getEc2SecurityGroupIds() The EC2 security groups that control access to the studio component.
Object	getInitializationScripts() Initialization scripts for studio components.
String	getName() A friendly name for the studio component resource.
Object	getScriptParameters() Parameters for the studio component scripts.
String	getStudioId() The unique identifier for a studio resource.
String	getSubtype() The specific subtype of a studio component.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getType() The type of the studio component.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfiguration(CfnStudioComponent.StudioComponentConfigurationProperty value) The configuration of the studio component, based on component type.
void	setConfiguration(IResolvable value) The configuration of the studio component, based on component type.
void	setDescription(String value) A human-readable description for the studio component resource.
void	setEc2SecurityGroupIds(List<String> value) The EC2 security groups that control access to the studio component.
void	setInitializationScripts(IResolvable value) Initialization scripts for studio components.
void	setInitializationScripts(List<Object> value) Initialization scripts for studio components.
void	setName(String value) A friendly name for the studio component resource.
void	setScriptParameters(IResolvable value) Parameters for the studio component scripts.
void	setScriptParameters(List<Object> value) Parameters for the studio component scripts.
void	setStudioId(String value) The unique identifier for a studio resource.
void	setSubtype(String value) The specific subtype of a studio component.
void	setType(String value) The type of the studio component.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStudioComponent

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

CfnStudioComponent

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

CfnStudioComponent

@Stability(value=Stable)
public CfnStudioComponent(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnStudioComponentProps props)

Create a new `AWS::NimbleStudio::StudioComponent`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrStudioComponentId

@Stability(value=Stable)
 @NotNull
public String getAttrStudioComponentId()

The unique identifier for the studio component resource.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

A friendly name for the studio component resource.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A friendly name for the studio component resource.

getStudioId

@Stability(value=Stable)
 @NotNull
public String getStudioId()

The unique identifier for a studio resource.

In Nimble Studio , all other resources are contained in a studio resource.

setStudioId

@Stability(value=Stable)
public void setStudioId(@NotNull
                                                 String value)

The unique identifier for a studio resource.

In Nimble Studio , all other resources are contained in a studio resource.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

The type of the studio component.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

The type of the studio component.

getConfiguration

@Stability(value=Stable)
 @Nullable
public Object getConfiguration()

The configuration of the studio component, based on component type.

setConfiguration

@Stability(value=Stable)
public void setConfiguration(@Nullable
                                                      CfnStudioComponent.StudioComponentConfigurationProperty value)

The configuration of the studio component, based on component type.

setConfiguration

@Stability(value=Stable)
public void setConfiguration(@Nullable
                                                      IResolvable value)

The configuration of the studio component, based on component type.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A human-readable description for the studio component resource.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A human-readable description for the studio component resource.

getEc2SecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getEc2SecurityGroupIds()

The EC2 security groups that control access to the studio component.

setEc2SecurityGroupIds

@Stability(value=Stable)
public void setEc2SecurityGroupIds(@Nullable
                                                            List<String> value)

The EC2 security groups that control access to the studio component.

getInitializationScripts

@Stability(value=Stable)
 @Nullable
public Object getInitializationScripts()

Initialization scripts for studio components.

setInitializationScripts

@Stability(value=Stable)
public void setInitializationScripts(@Nullable
                                                              IResolvable value)

Initialization scripts for studio components.

setInitializationScripts

@Stability(value=Stable)
public void setInitializationScripts(@Nullable
                                                              List<Object> value)

Initialization scripts for studio components.

getScriptParameters

@Stability(value=Stable)
 @Nullable
public Object getScriptParameters()

Parameters for the studio component scripts.

setScriptParameters

@Stability(value=Stable)
public void setScriptParameters(@Nullable
                                                         IResolvable value)

Parameters for the studio component scripts.

setScriptParameters

@Stability(value=Stable)
public void setScriptParameters(@Nullable
                                                         List<Object> value)

Parameters for the studio component scripts.

getSubtype

@Stability(value=Stable)
 @Nullable
public String getSubtype()

The specific subtype of a studio component.

setSubtype

@Stability(value=Stable)
public void setSubtype(@Nullable
                                                String value)

The specific subtype of a studio component.