Update Studio Component

nimblestudio_update_studio_component

R Documentation

Updates a studio component resource

Description

Updates a studio component resource.

Usage

nimblestudio_update_studio_component(clientToken, configuration,
  description, ec2SecurityGroupIds, initializationScripts, name,
  runtimeRoleArn, scriptParameters, secureInitializationRoleArn,
  studioComponentId, studioId, subtype, type)

Arguments

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

configuration

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

description

The description.

ec2SecurityGroupIds

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

initializationScripts

Initialization scripts for studio components.

name

The name for the studio component.

runtimeRoleArn

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

scriptParameters

Parameters for the studio component scripts.

secureInitializationRoleArn

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

studioComponentId

[required] The studio component ID.

studioId

[required] The studio ID.

subtype

The specific subtype of a studio component.

type

The type of the studio component.

Value

A list with the following syntax:

list(
  studioComponent = list(
    arn = "string",
    configuration = list(
      activeDirectoryConfiguration = list(
        computerAttributes = list(
          list(
            name = "string",
            value = "string"
          )
        ),
        directoryId = "string",
        organizationalUnitDistinguishedName = "string"
      ),
      computeFarmConfiguration = list(
        activeDirectoryUser = "string",
        endpoint = "string"
      ),
      licenseServiceConfiguration = list(
        endpoint = "string"
      ),
      sharedFileSystemConfiguration = list(
        endpoint = "string",
        fileSystemId = "string",
        linuxMountPoint = "string",
        shareName = "string",
        windowsMountDrive = "string"
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    createdBy = "string",
    description = "string",
    ec2SecurityGroupIds = list(
      "string"
    ),
    initializationScripts = list(
      list(
        launchProfileProtocolVersion = "string",
        platform = "LINUX"|"WINDOWS",
        runContext = "SYSTEM_INITIALIZATION"|"USER_INITIALIZATION",
        script = "string"
      )
    ),
    name = "string",
    runtimeRoleArn = "string",
    scriptParameters = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    secureInitializationRoleArn = "string",
    state = "CREATE_IN_PROGRESS"|"READY"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DELETE_FAILED"|"CREATE_FAILED"|"UPDATE_FAILED",
    statusCode = "ACTIVE_DIRECTORY_ALREADY_EXISTS"|"STUDIO_COMPONENT_CREATED"|"STUDIO_COMPONENT_UPDATED"|"STUDIO_COMPONENT_DELETED"|"ENCRYPTION_KEY_ACCESS_DENIED"|"ENCRYPTION_KEY_NOT_FOUND"|"STUDIO_COMPONENT_CREATE_IN_PROGRESS"|"STUDIO_COMPONENT_UPDATE_IN_PROGRESS"|"STUDIO_COMPONENT_DELETE_IN_PROGRESS"|"INTERNAL_ERROR",
    statusMessage = "string",
    studioComponentId = "string",
    subtype = "AWS_MANAGED_MICROSOFT_AD"|"AMAZON_FSX_FOR_WINDOWS"|"AMAZON_FSX_FOR_LUSTRE"|"CUSTOM",
    tags = list(
      "string"
    ),
    type = "ACTIVE_DIRECTORY"|"SHARED_FILE_SYSTEM"|"COMPUTE_FARM"|"LICENSE_SERVICE"|"CUSTOM",
    updatedAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedBy = "string"
  )
)

Request syntax

svc$update_studio_component(
  clientToken = "string",
  configuration = list(
    activeDirectoryConfiguration = list(
      computerAttributes = list(
        list(
          name = "string",
          value = "string"
        )
      ),
      directoryId = "string",
      organizationalUnitDistinguishedName = "string"
    ),
    computeFarmConfiguration = list(
      activeDirectoryUser = "string",
      endpoint = "string"
    ),
    licenseServiceConfiguration = list(
      endpoint = "string"
    ),
    sharedFileSystemConfiguration = list(
      endpoint = "string",
      fileSystemId = "string",
      linuxMountPoint = "string",
      shareName = "string",
      windowsMountDrive = "string"
    )
  ),
  description = "string",
  ec2SecurityGroupIds = list(
    "string"
  ),
  initializationScripts = list(
    list(
      launchProfileProtocolVersion = "string",
      platform = "LINUX"|"WINDOWS",
      runContext = "SYSTEM_INITIALIZATION"|"USER_INITIALIZATION",
      script = "string"
    )
  ),
  name = "string",
  runtimeRoleArn = "string",
  scriptParameters = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  secureInitializationRoleArn = "string",
  studioComponentId = "string",
  studioId = "string",
  subtype = "AWS_MANAGED_MICROSOFT_AD"|"AMAZON_FSX_FOR_WINDOWS"|"AMAZON_FSX_FOR_LUSTRE"|"CUSTOM",
  type = "ACTIVE_DIRECTORY"|"SHARED_FILE_SYSTEM"|"COMPUTE_FARM"|"LICENSE_SERVICE"|"CUSTOM"
)