aws-cdk-lib.aws_nimblestudio.CfnStudioComponentProps

interface CfnStudioComponentProps

LanguageType name
.NETAmazon.CDK.AWS.NimbleStudio.CfnStudioComponentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsnimblestudio#CfnStudioComponentProps
Javasoftware.amazon.awscdk.services.nimblestudio.CfnStudioComponentProps
Pythonaws_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',
  }],
  scriptParameters: [{
    key: 'key',
    value: 'value',
  }],
  subtype: 'subtype',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
namestringA friendly name for the studio component resource.
studioIdstringThe unique identifier for a studio resource.
typestringThe type of the studio component.
configuration?IResolvable | StudioComponentConfigurationPropertyThe configuration of the studio component, based on component type.
description?stringA human-readable description for the studio component resource.
ec2SecurityGroupIds?string[]The EC2 security groups that control access to the studio component.
initializationScripts?IResolvable | IResolvable | StudioComponentInitializationScriptProperty[]Initialization scripts for studio components.
scriptParameters?IResolvable | IResolvable | ScriptParameterKeyValueProperty[]Parameters for the studio component scripts.
subtype?stringThe 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 | StudioComponentConfigurationProperty (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 | StudioComponentInitializationScriptProperty[] (optional)

Initialization scripts for studio components.


scriptParameters?

Type: IResolvable | IResolvable | ScriptParameterKeyValueProperty[] (optional)

Parameters for the studio component scripts.


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 .