@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:38.969Z") public class CfnStudioComponent extends CfnResource implements IInspectable
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();
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 AWS Directory Service for Microsoft Active Directory 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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnStudioComponent(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrStudioComponentId()
The unique identifier for the studio component resource.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getConfiguration()
The configuration of the studio component, based on component type.
|
java.lang.String |
getDescription()
A human-readable description for the studio component resource.
|
java.util.List<java.lang.String> |
getEc2SecurityGroupIds()
The EC2 security groups that control access to the studio component.
|
java.lang.Object |
getInitializationScripts()
Initialization scripts for studio components.
|
java.lang.String |
getName()
A friendly name for the studio component resource.
|
java.lang.Object |
getScriptParameters()
Parameters for the studio component scripts.
|
java.lang.String |
getStudioId()
The unique identifier for a studio resource.
|
java.lang.String |
getSubtype()
The specific subtype of a studio component.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
java.lang.String |
getType()
The type of the studio component.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.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(java.lang.String value)
A human-readable description for the studio component resource.
|
void |
setEc2SecurityGroupIds(java.util.List<java.lang.String> value)
The EC2 security groups that control access to the studio component.
|
void |
setInitializationScripts(IResolvable value)
Initialization scripts for studio components.
|
void |
setInitializationScripts(java.util.List<java.lang.Object> value)
Initialization scripts for studio components.
|
void |
setName(java.lang.String value)
A friendly name for the studio component resource.
|
void |
setScriptParameters(IResolvable value)
Parameters for the studio component scripts.
|
void |
setScriptParameters(java.util.List<java.lang.Object> value)
Parameters for the studio component scripts.
|
void |
setStudioId(java.lang.String value)
The unique identifier for a studio resource.
|
void |
setSubtype(java.lang.String value)
The specific subtype of a studio component.
|
void |
setType(java.lang.String value)
The type of the studio component.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnStudioComponent(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnStudioComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnStudioComponent(Construct scope, java.lang.String id, CfnStudioComponentProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrStudioComponentId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getStudioId()
In Nimble Studio , all other resources are contained in a studio resource.
public void setStudioId(java.lang.String value)
In Nimble Studio , all other resources are contained in a studio resource.
public java.lang.String getType()
public void setType(java.lang.String value)
public java.lang.Object getConfiguration()
public void setConfiguration(IResolvable value)
public void setConfiguration(CfnStudioComponent.StudioComponentConfigurationProperty value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.util.List<java.lang.String> getEc2SecurityGroupIds()
public void setEc2SecurityGroupIds(java.util.List<java.lang.String> value)
public java.lang.Object getInitializationScripts()
public void setInitializationScripts(IResolvable value)
public void setInitializationScripts(java.util.List<java.lang.Object> value)
public java.lang.Object getScriptParameters()
public void setScriptParameters(IResolvable value)
public void setScriptParameters(java.util.List<java.lang.Object> value)
public java.lang.String getSubtype()
public void setSubtype(java.lang.String value)