awscc.nimblestudio_studiocomponent

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - nimble:DeleteStudioComponent, nimble:UntagResource, ds:UnauthorizeApplication

update

Parent base class for filters and actions.

definitions:
  ActiveDirectoryComputerAttribute:
    additionalProperties: false
    description: <p>An LDAP attribute of an Active Directory computer account, in
      the form of a name:value pair.</p>
    properties:
      Name:
        description: <p>The name for the LDAP attribute.</p>
        maxLength: 40
        minLength: 1
        type: string
      Value:
        description: <p>The value for the LDAP attribute.</p>
        maxLength: 64
        minLength: 1
        type: string
    type: object
  ActiveDirectoryConfiguration:
    additionalProperties: false
    description: <p>The configuration for a Microsoft Active Directory (Microsoft
      AD) studio resource.</p>
    properties:
      ComputerAttributes:
        description: <p>A collection of custom attributes for an Active Directory
          computer.</p>
        items:
          additionalProperties: false
          description: <p>An LDAP attribute of an Active Directory computer account,
            in the form of a name:value pair.</p>
          properties:
            Name:
              description: <p>The name for the LDAP attribute.</p>
              maxLength: 40
              minLength: 1
              type: string
            Value:
              description: <p>The value for the LDAP attribute.</p>
              maxLength: 64
              minLength: 1
              type: string
          type: object
        maxItems: 50
        minItems: 0
        type: array
      DirectoryId:
        description: <p>The directory ID of the Directory Service for Microsoft Active
          Directory to access using this studio component.</p>
        type: string
      OrganizationalUnitDistinguishedName:
        description: <p>The distinguished name (DN) and organizational unit (OU) of
          an Active Directory computer.</p>
        maxLength: 2000
        minLength: 1
        type: string
    type: object
  ComputeFarmConfiguration:
    additionalProperties: false
    description: <p>The configuration for a render farm that is associated with a
      studio resource.</p>
    properties:
      ActiveDirectoryUser:
        description: <p>The name of an Active Directory user that is used on ComputeFarm
          worker instances.</p>
        type: string
      Endpoint:
        description: <p>The endpoint of the ComputeFarm that is accessed by the studio
          component resource.</p>
        type: string
    type: object
  LaunchProfilePlatform:
    description: ''
    enum:
    - LINUX
    - WINDOWS
    type: string
  LicenseServiceConfiguration:
    additionalProperties: false
    description: <p>The configuration for a license service that is associated with
      a studio resource.</p>
    properties:
      Endpoint:
        description: <p>The endpoint of the license service that is accessed by the
          studio component resource.</p>
        type: string
    type: object
  ScriptParameterKeyValue:
    additionalProperties: false
    description: <p>A parameter for a studio component script, in the form of a key:value
      pair.</p>
    properties:
      Key:
        description: <p>A script parameter key.</p>
        maxLength: 64
        minLength: 1
        pattern: ^[a-zA-Z_][a-zA-Z0-9_]+$
        type: string
      Value:
        description: <p>A script parameter value.</p>
        maxLength: 256
        minLength: 1
        type: string
    type: object
  SharedFileSystemConfiguration:
    additionalProperties: false
    description: <p>The configuration for a shared file storage system that is associated
      with a studio resource.</p>
    properties:
      Endpoint:
        description: <p>The endpoint of the shared file system that is accessed by
          the studio component resource.</p>
        type: string
      FileSystemId:
        description: <p>The unique identifier for a file system.</p>
        type: string
      LinuxMountPoint:
        description: <p>The mount location for a shared file system on a Linux virtual
          workstation.</p>
        maxLength: 128
        minLength: 0
        pattern: ^(/?|(\$HOME)?(/[^/\n\s\\]+)*)$
        type: string
      ShareName:
        description: <p>The name of the file share.</p>
        type: string
      WindowsMountDrive:
        description: <p>The mount location for a shared file system on a Windows virtual
          workstation.</p>
        pattern: ^[A-Z]$
        type: string
    type: object
  StudioComponentConfiguration:
    additionalProperties: false
    description: <p>The configuration of the studio component, based on component
      type.</p>
    properties:
      ActiveDirectoryConfiguration:
        additionalProperties: false
        description: <p>The configuration for a Microsoft Active Directory (Microsoft
          AD) studio resource.</p>
        properties:
          ComputerAttributes:
            description: <p>A collection of custom attributes for an Active Directory
              computer.</p>
            items:
              additionalProperties: false
              description: <p>An LDAP attribute of an Active Directory computer account,
                in the form of a name:value pair.</p>
              properties:
                Name:
                  description: <p>The name for the LDAP attribute.</p>
                  maxLength: 40
                  minLength: 1
                  type: string
                Value:
                  description: <p>The value for the LDAP attribute.</p>
                  maxLength: 64
                  minLength: 1
                  type: string
              type: object
            maxItems: 50
            minItems: 0
            type: array
          DirectoryId:
            description: <p>The directory ID of the Directory Service for Microsoft
              Active Directory to access using this studio component.</p>
            type: string
          OrganizationalUnitDistinguishedName:
            description: <p>The distinguished name (DN) and organizational unit (OU)
              of an Active Directory computer.</p>
            maxLength: 2000
            minLength: 1
            type: string
        type: object
      ComputeFarmConfiguration:
        additionalProperties: false
        description: <p>The configuration for a render farm that is associated with
          a studio resource.</p>
        properties:
          ActiveDirectoryUser:
            description: <p>The name of an Active Directory user that is used on ComputeFarm
              worker instances.</p>
            type: string
          Endpoint:
            description: <p>The endpoint of the ComputeFarm that is accessed by the
              studio component resource.</p>
            type: string
        type: object
      LicenseServiceConfiguration:
        additionalProperties: false
        description: <p>The configuration for a license service that is associated
          with a studio resource.</p>
        properties:
          Endpoint:
            description: <p>The endpoint of the license service that is accessed by
              the studio component resource.</p>
            type: string
        type: object
      SharedFileSystemConfiguration:
        additionalProperties: false
        description: <p>The configuration for a shared file storage system that is
          associated with a studio resource.</p>
        properties:
          Endpoint:
            description: <p>The endpoint of the shared file system that is accessed
              by the studio component resource.</p>
            type: string
          FileSystemId:
            description: <p>The unique identifier for a file system.</p>
            type: string
          LinuxMountPoint:
            description: <p>The mount location for a shared file system on a Linux
              virtual workstation.</p>
            maxLength: 128
            minLength: 0
            pattern: ^(/?|(\$HOME)?(/[^/\n\s\\]+)*)$
            type: string
          ShareName:
            description: <p>The name of the file share.</p>
            type: string
          WindowsMountDrive:
            description: <p>The mount location for a shared file system on a Windows
              virtual workstation.</p>
            pattern: ^[A-Z]$
            type: string
        type: object
    type: object
  StudioComponentInitializationScript:
    additionalProperties: false
    description: <p>Initialization scripts for studio components.</p>
    properties:
      LaunchProfileProtocolVersion:
        description: <p>The version number of the protocol that is used by the launch
          profile. The only valid version is "2021-03-31".</p>
        maxLength: 10
        minLength: 0
        pattern: ^2021\-03\-31$
        type: string
      Platform:
        description: ''
        enum:
        - LINUX
        - WINDOWS
        type: string
      RunContext:
        description: ''
        enum:
        - SYSTEM_INITIALIZATION
        - USER_INITIALIZATION
        type: string
      Script:
        description: <p>The initialization script.</p>
        maxLength: 5120
        minLength: 1
        type: string
    type: object
  StudioComponentInitializationScriptRunContext:
    description: ''
    enum:
    - SYSTEM_INITIALIZATION
    - USER_INITIALIZATION
    type: string
  StudioComponentSubtype:
    description: ''
    enum:
    - AWS_MANAGED_MICROSOFT_AD
    - AMAZON_FSX_FOR_WINDOWS
    - AMAZON_FSX_FOR_LUSTRE
    - CUSTOM
    type: string
  StudioComponentType:
    description: ''
    enum:
    - ACTIVE_DIRECTORY
    - SHARED_FILE_SYSTEM
    - COMPUTE_FARM
    - LICENSE_SERVICE
    - CUSTOM
    type: string
  Tags:
    additionalProperties: false
    description: ''
    patternProperties:
      .+:
        type: string
    type: object
properties:
  Configuration:
    additionalProperties: false
    description: <p>The configuration of the studio component, based on component
      type.</p>
    properties:
      ActiveDirectoryConfiguration:
        additionalProperties: false
        description: <p>The configuration for a Microsoft Active Directory (Microsoft
          AD) studio resource.</p>
        properties:
          ComputerAttributes:
            description: <p>A collection of custom attributes for an Active Directory
              computer.</p>
            items:
              additionalProperties: false
              description: <p>An LDAP attribute of an Active Directory computer account,
                in the form of a name:value pair.</p>
              properties:
                Name:
                  description: <p>The name for the LDAP attribute.</p>
                  maxLength: 40
                  minLength: 1
                  type: string
                Value:
                  description: <p>The value for the LDAP attribute.</p>
                  maxLength: 64
                  minLength: 1
                  type: string
              type: object
            maxItems: 50
            minItems: 0
            type: array
          DirectoryId:
            description: <p>The directory ID of the Directory Service for Microsoft
              Active Directory to access using this studio component.</p>
            type: string
          OrganizationalUnitDistinguishedName:
            description: <p>The distinguished name (DN) and organizational unit (OU)
              of an Active Directory computer.</p>
            maxLength: 2000
            minLength: 1
            type: string
        type: object
      ComputeFarmConfiguration:
        additionalProperties: false
        description: <p>The configuration for a render farm that is associated with
          a studio resource.</p>
        properties:
          ActiveDirectoryUser:
            description: <p>The name of an Active Directory user that is used on ComputeFarm
              worker instances.</p>
            type: string
          Endpoint:
            description: <p>The endpoint of the ComputeFarm that is accessed by the
              studio component resource.</p>
            type: string
        type: object
      LicenseServiceConfiguration:
        additionalProperties: false
        description: <p>The configuration for a license service that is associated
          with a studio resource.</p>
        properties:
          Endpoint:
            description: <p>The endpoint of the license service that is accessed by
              the studio component resource.</p>
            type: string
        type: object
      SharedFileSystemConfiguration:
        additionalProperties: false
        description: <p>The configuration for a shared file storage system that is
          associated with a studio resource.</p>
        properties:
          Endpoint:
            description: <p>The endpoint of the shared file system that is accessed
              by the studio component resource.</p>
            type: string
          FileSystemId:
            description: <p>The unique identifier for a file system.</p>
            type: string
          LinuxMountPoint:
            description: <p>The mount location for a shared file system on a Linux
              virtual workstation.</p>
            maxLength: 128
            minLength: 0
            pattern: ^(/?|(\$HOME)?(/[^/\n\s\\]+)*)$
            type: string
          ShareName:
            description: <p>The name of the file share.</p>
            type: string
          WindowsMountDrive:
            description: <p>The mount location for a shared file system on a Windows
              virtual workstation.</p>
            pattern: ^[A-Z]$
            type: string
        type: object
    type: object
  Description:
    description: <p>The description.</p>
    maxLength: 256
    minLength: 0
    type: string
  Ec2SecurityGroupIds:
    description: <p>The EC2 security groups that control access to the studio component.</p>
    items:
      description: ''
      type: string
    maxItems: 30
    minItems: 1
    type: array
  InitializationScripts:
    description: <p>Initialization scripts for studio components.</p>
    items:
      additionalProperties: false
      description: <p>Initialization scripts for studio components.</p>
      properties:
        LaunchProfileProtocolVersion:
          description: <p>The version number of the protocol that is used by the launch
            profile. The only valid version is "2021-03-31".</p>
          maxLength: 10
          minLength: 0
          pattern: ^2021\-03\-31$
          type: string
        Platform:
          description: ''
          enum:
          - LINUX
          - WINDOWS
          type: string
        RunContext:
          description: ''
          enum:
          - SYSTEM_INITIALIZATION
          - USER_INITIALIZATION
          type: string
        Script:
          description: <p>The initialization script.</p>
          maxLength: 5120
          minLength: 1
          type: string
      type: object
    type: array
  Name:
    description: <p>The name for the studio component.</p>
    maxLength: 64
    minLength: 0
    type: string
  ScriptParameters:
    description: <p>Parameters for the studio component scripts.</p>
    items:
      additionalProperties: false
      description: <p>A parameter for a studio component script, in the form of a
        key:value pair.</p>
      properties:
        Key:
          description: <p>A script parameter key.</p>
          maxLength: 64
          minLength: 1
          pattern: ^[a-zA-Z_][a-zA-Z0-9_]+$
          type: string
        Value:
          description: <p>A script parameter value.</p>
          maxLength: 256
          minLength: 1
          type: string
      type: object
    maxItems: 30
    minItems: 0
    type: array
  Type:
    description: ''
    enum:
    - ACTIVE_DIRECTORY
    - SHARED_FILE_SYSTEM
    - COMPUTE_FARM
    - LICENSE_SERVICE
    - CUSTOM
    type: string
  type:
    enum:
    - update

Permissions - nimble:UpdateStudioComponent, ds:AuthorizeApplication, ec2:DescribeSecurityGroups, fsx:DescribeFilesystems, ds:DescribeDirectories