Class: Aws::NimbleStudio::Types::CreateStudioComponentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb

Overview

Note:

When making an API call, you may pass CreateStudioComponentRequest data as a hash:

{
  client_token: "ClientToken",
  configuration: {
    active_directory_configuration: {
      computer_attributes: [
        {
          name: "ActiveDirectoryComputerAttributeName",
          value: "ActiveDirectoryComputerAttributeValue",
        },
      ],
      directory_id: "DirectoryId",
      organizational_unit_distinguished_name: "ActiveDirectoryOrganizationalUnitDistinguishedName",
    },
    compute_farm_configuration: {
      active_directory_user: "String",
      endpoint: "SyntheticComputeFarmConfigurationString",
    },
    license_service_configuration: {
      endpoint: "SyntheticLicenseServiceConfigurationString",
    },
    shared_file_system_configuration: {
      endpoint: "SyntheticSharedFileSystemConfigurationString",
      file_system_id: "String",
      linux_mount_point: "LinuxMountPoint",
      share_name: "SyntheticSharedFileSystemConfigurationString",
      windows_mount_drive: "WindowsMountDrive",
    },
  },
  description: "StudioComponentDescription",
  ec2_security_group_ids: ["SecurityGroupId"],
  initialization_scripts: [
    {
      launch_profile_protocol_version: "LaunchProfileProtocolVersion",
      platform: "LINUX", # accepts LINUX, WINDOWS
      run_context: "SYSTEM_INITIALIZATION", # accepts SYSTEM_INITIALIZATION, USER_INITIALIZATION
      script: "StudioComponentInitializationScriptContent",
    },
  ],
  name: "StudioComponentName", # required
  script_parameters: [
    {
      key: "ScriptParameterKey",
      value: "ScriptParameterValue",
    },
  ],
  studio_id: "String", # required
  subtype: "AWS_MANAGED_MICROSOFT_AD", # accepts AWS_MANAGED_MICROSOFT_AD, AMAZON_FSX_FOR_WINDOWS, AMAZON_FSX_FOR_LUSTRE, CUSTOM
  tags: {
    "String" => "String",
  },
  type: "ACTIVE_DIRECTORY", # required, accepts ACTIVE_DIRECTORY, SHARED_FILE_SYSTEM, COMPUTE_FARM, LICENSE_SERVICE, CUSTOM
}

Constant Summary collapse

SENSITIVE =
[:description, :name, :script_parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#configurationTypes::StudioComponentConfiguration

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



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#descriptionString

The description.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#ec2_security_group_idsArray<String>

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

Returns:

  • (Array<String>)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#initialization_scriptsArray<Types::StudioComponentInitializationScript>

Initialization scripts for studio components.



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#nameString

The name for the studio component.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#script_parametersArray<Types::ScriptParameterKeyValue>

Parameters for the studio component scripts.

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#studio_idString

The studio ID.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#subtypeString

The specific subtype of a studio component.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#tagsHash<String,String>

A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (Hash<String,String>)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#typeString

The type of the studio component.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 628

class CreateStudioComponentRequest < Struct.new(
  :client_token,
  :configuration,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :script_parameters,
  :studio_id,
  :subtype,
  :tags,
  :type)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end