interface CfnStudioComponentProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.NimbleStudio.CfnStudioComponentProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsnimblestudio#CfnStudioComponentProps |
Java | software.amazon.awscdk.services.nimblestudio.CfnStudioComponentProps |
Python | aws_cdk.aws_nimblestudio.CfnStudioComponentProps |
TypeScript | aws-cdk-lib » aws_nimblestudio » CfnStudioComponentProps |
Properties for defining a CfnStudioComponent
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_nimblestudio as nimblestudio } from 'aws-cdk-lib';
const cfnStudioComponentProps: nimblestudio.CfnStudioComponentProps = {
name: 'name',
studioId: 'studioId',
type: 'type',
// the properties below are optional
configuration: {
activeDirectoryConfiguration: {
computerAttributes: [{
name: 'name',
value: 'value',
}],
directoryId: 'directoryId',
organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
},
computeFarmConfiguration: {
activeDirectoryUser: 'activeDirectoryUser',
endpoint: 'endpoint',
},
licenseServiceConfiguration: {
endpoint: 'endpoint',
},
sharedFileSystemConfiguration: {
endpoint: 'endpoint',
fileSystemId: 'fileSystemId',
linuxMountPoint: 'linuxMountPoint',
shareName: 'shareName',
windowsMountDrive: 'windowsMountDrive',
},
},
description: 'description',
ec2SecurityGroupIds: ['ec2SecurityGroupIds'],
initializationScripts: [{
launchProfileProtocolVersion: 'launchProfileProtocolVersion',
platform: 'platform',
runContext: 'runContext',
script: 'script',
}],
runtimeRoleArn: 'runtimeRoleArn',
scriptParameters: [{
key: 'key',
value: 'value',
}],
secureInitializationRoleArn: 'secureInitializationRoleArn',
subtype: 'subtype',
tags: {
tagsKey: 'tags',
},
};
Properties
Name | Type | Description |
---|---|---|
name | string | A friendly name for the studio component resource. |
studio | string | The unique identifier for a studio resource. |
type | string | The type of the studio component. |
configuration? | IResolvable | Studio | The configuration of the studio component, based on component type. |
description? | string | A human-readable description for the studio component resource. |
ec2 | string[] | The EC2 security groups that control access to the studio component. |
initialization | IResolvable | IResolvable | Studio [] | Initialization scripts for studio components. |
runtime | string | An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running. |
script | IResolvable | IResolvable | Script [] | Parameters for the studio component scripts. |
secure | string | An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs. |
subtype? | string | The specific subtype of a studio component. |
tags? | { [string]: string } | An array of key-value pairs to apply to this resource. |
name
Type:
string
A friendly name for the studio component resource.
studioId
Type:
string
The unique identifier for a studio resource.
In Nimble Studio , all other resources are contained in a studio resource.
type
Type:
string
The type of the studio component.
configuration?
Type:
IResolvable
|
Studio
(optional)
The configuration of the studio component, based on component type.
description?
Type:
string
(optional)
A human-readable description for the studio component resource.
ec2SecurityGroupIds?
Type:
string[]
(optional)
The EC2 security groups that control access to the studio component.
initializationScripts?
Type:
IResolvable
|
IResolvable
|
Studio
[]
(optional)
Initialization scripts for studio components.
runtimeRoleArn?
Type:
string
(optional)
An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
scriptParameters?
Type:
IResolvable
|
IResolvable
|
Script
[]
(optional)
Parameters for the studio component scripts.
secureInitializationRoleArn?
Type:
string
(optional)
An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
subtype?
Type:
string
(optional)
The specific subtype of a studio component.
tags?
Type:
{ [string]: string }
(optional)
An array of key-value pairs to apply to this resource.
For more information, see Tag .