1. Packages
  2. AWS Native
  3. API Docs
  4. nimblestudio
  5. StudioComponent

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

aws-native.nimblestudio.StudioComponent

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

    Represents a studio component that connects a non-Nimble Studio resource in your account to your studio

    Create StudioComponent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StudioComponent(name: string, args: StudioComponentArgs, opts?: CustomResourceOptions);
    @overload
    def StudioComponent(resource_name: str,
                        args: StudioComponentArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def StudioComponent(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        studio_id: Optional[str] = None,
                        type: Optional[StudioComponentType] = None,
                        configuration: Optional[Union[StudioComponentConfiguration0PropertiesArgs, StudioComponentConfiguration1PropertiesArgs, StudioComponentConfiguration2PropertiesArgs, StudioComponentConfiguration3PropertiesArgs]] = None,
                        description: Optional[str] = None,
                        ec2_security_group_ids: Optional[Sequence[str]] = None,
                        initialization_scripts: Optional[Sequence[StudioComponentInitializationScriptArgs]] = None,
                        name: Optional[str] = None,
                        runtime_role_arn: Optional[str] = None,
                        script_parameters: Optional[Sequence[StudioComponentScriptParameterKeyValueArgs]] = None,
                        secure_initialization_role_arn: Optional[str] = None,
                        subtype: Optional[StudioComponentSubtype] = None,
                        tags: Optional[Mapping[str, str]] = None)
    func NewStudioComponent(ctx *Context, name string, args StudioComponentArgs, opts ...ResourceOption) (*StudioComponent, error)
    public StudioComponent(string name, StudioComponentArgs args, CustomResourceOptions? opts = null)
    public StudioComponent(String name, StudioComponentArgs args)
    public StudioComponent(String name, StudioComponentArgs args, CustomResourceOptions options)
    
    type: aws-native:nimblestudio:StudioComponent
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args StudioComponentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StudioComponentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StudioComponentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StudioComponentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StudioComponentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    StudioComponent Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The StudioComponent resource accepts the following input properties:

    StudioId string
    Type Pulumi.AwsNative.NimbleStudio.StudioComponentType
    The type of the studio component.
    Configuration Pulumi.AwsNative.NimbleStudio.Inputs.StudioComponentConfiguration0Properties | Pulumi.AwsNative.NimbleStudio.Inputs.StudioComponentConfiguration1Properties | Pulumi.AwsNative.NimbleStudio.Inputs.StudioComponentConfiguration2Properties | Pulumi.AwsNative.NimbleStudio.Inputs.StudioComponentConfiguration3Properties
    The configuration of the studio component, based on component type.
    Description string
    Ec2SecurityGroupIds List<string>
    InitializationScripts List<Pulumi.AwsNative.NimbleStudio.Inputs.StudioComponentInitializationScript>
    Name string
    RuntimeRoleArn 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.
    ScriptParameters List<Pulumi.AwsNative.NimbleStudio.Inputs.StudioComponentScriptParameterKeyValue>
    SecureInitializationRoleArn 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 Pulumi.AwsNative.NimbleStudio.StudioComponentSubtype
    The specific subtype of a studio component.
    Tags Dictionary<string, string>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    StudioId string
    Type StudioComponentType
    The type of the studio component.
    Configuration StudioComponentConfiguration0PropertiesArgs | StudioComponentConfiguration1PropertiesArgs | StudioComponentConfiguration2PropertiesArgs | StudioComponentConfiguration3PropertiesArgs
    The configuration of the studio component, based on component type.
    Description string
    Ec2SecurityGroupIds []string
    InitializationScripts []StudioComponentInitializationScriptArgs
    Name string
    RuntimeRoleArn 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.
    ScriptParameters []StudioComponentScriptParameterKeyValueArgs
    SecureInitializationRoleArn 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 StudioComponentSubtype
    The specific subtype of a studio component.
    Tags map[string]string

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    studioId String
    type StudioComponentType
    The type of the studio component.
    configuration StudioComponentConfiguration0Properties | StudioComponentConfiguration1Properties | StudioComponentConfiguration2Properties | StudioComponentConfiguration3Properties
    The configuration of the studio component, based on component type.
    description String
    ec2SecurityGroupIds List<String>
    initializationScripts List<StudioComponentInitializationScript>
    name String
    runtimeRoleArn 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.
    scriptParameters List<StudioComponentScriptParameterKeyValue>
    secureInitializationRoleArn 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 StudioComponentSubtype
    The specific subtype of a studio component.
    tags Map<String,String>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    studioId string
    type StudioComponentType
    The type of the studio component.
    configuration StudioComponentConfiguration0Properties | StudioComponentConfiguration1Properties | StudioComponentConfiguration2Properties | StudioComponentConfiguration3Properties
    The configuration of the studio component, based on component type.
    description string
    ec2SecurityGroupIds string[]
    initializationScripts StudioComponentInitializationScript[]
    name string
    runtimeRoleArn 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.
    scriptParameters StudioComponentScriptParameterKeyValue[]
    secureInitializationRoleArn 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 StudioComponentSubtype
    The specific subtype of a studio component.
    tags {[key: string]: string}

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    studio_id str
    type StudioComponentType
    The type of the studio component.
    configuration StudioComponentConfiguration0PropertiesArgs | StudioComponentConfiguration1PropertiesArgs | StudioComponentConfiguration2PropertiesArgs | StudioComponentConfiguration3PropertiesArgs
    The configuration of the studio component, based on component type.
    description str
    ec2_security_group_ids Sequence[str]
    initialization_scripts Sequence[StudioComponentInitializationScriptArgs]
    name str
    runtime_role_arn str
    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_parameters Sequence[StudioComponentScriptParameterKeyValueArgs]
    secure_initialization_role_arn str
    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 StudioComponentSubtype
    The specific subtype of a studio component.
    tags Mapping[str, str]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    studioId String
    type "ACTIVE_DIRECTORY" | "SHARED_FILE_SYSTEM" | "COMPUTE_FARM" | "LICENSE_SERVICE" | "CUSTOM"
    The type of the studio component.
    configuration Property Map | Property Map | Property Map | Property Map
    The configuration of the studio component, based on component type.
    description String
    ec2SecurityGroupIds List<String>
    initializationScripts List<Property Map>
    name String
    runtimeRoleArn 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.
    scriptParameters List<Property Map>
    secureInitializationRoleArn 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 "AWS_MANAGED_MICROSOFT_AD" | "AMAZON_FSX_FOR_WINDOWS" | "AMAZON_FSX_FOR_LUSTRE" | "CUSTOM"
    The specific subtype of a studio component.
    tags Map<String>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StudioComponent resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    StudioComponentId string
    The unique identifier for the studio component resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    StudioComponentId string
    The unique identifier for the studio component resource.
    id String
    The provider-assigned unique ID for this managed resource.
    studioComponentId String
    The unique identifier for the studio component resource.
    id string
    The provider-assigned unique ID for this managed resource.
    studioComponentId string
    The unique identifier for the studio component resource.
    id str
    The provider-assigned unique ID for this managed resource.
    studio_component_id str
    The unique identifier for the studio component resource.
    id String
    The provider-assigned unique ID for this managed resource.
    studioComponentId String
    The unique identifier for the studio component resource.

    Supporting Types

    StudioComponentActiveDirectoryComputerAttribute, StudioComponentActiveDirectoryComputerAttributeArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    StudioComponentActiveDirectoryConfiguration, StudioComponentActiveDirectoryConfigurationArgs

    StudioComponentComputeFarmConfiguration, StudioComponentComputeFarmConfigurationArgs

    StudioComponentConfiguration0Properties, StudioComponentConfiguration0PropertiesArgs

    StudioComponentConfiguration1Properties, StudioComponentConfiguration1PropertiesArgs

    StudioComponentConfiguration2Properties, StudioComponentConfiguration2PropertiesArgs

    StudioComponentConfiguration3Properties, StudioComponentConfiguration3PropertiesArgs

    StudioComponentInitializationScript, StudioComponentInitializationScriptArgs

    LaunchProfileProtocolVersion string
    Platform Pulumi.AwsNative.NimbleStudio.StudioComponentLaunchProfilePlatform
    The platform of the initialization script, either Windows or Linux.
    RunContext Pulumi.AwsNative.NimbleStudio.StudioComponentInitializationScriptRunContext
    The method to use when running the initialization script.
    Script string
    LaunchProfileProtocolVersion string
    Platform StudioComponentLaunchProfilePlatform
    The platform of the initialization script, either Windows or Linux.
    RunContext StudioComponentInitializationScriptRunContext
    The method to use when running the initialization script.
    Script string
    launchProfileProtocolVersion String
    platform StudioComponentLaunchProfilePlatform
    The platform of the initialization script, either Windows or Linux.
    runContext StudioComponentInitializationScriptRunContext
    The method to use when running the initialization script.
    script String
    launchProfileProtocolVersion string
    platform StudioComponentLaunchProfilePlatform
    The platform of the initialization script, either Windows or Linux.
    runContext StudioComponentInitializationScriptRunContext
    The method to use when running the initialization script.
    script string
    launch_profile_protocol_version str
    platform StudioComponentLaunchProfilePlatform
    The platform of the initialization script, either Windows or Linux.
    run_context StudioComponentInitializationScriptRunContext
    The method to use when running the initialization script.
    script str
    launchProfileProtocolVersion String
    platform "LINUX" | "WINDOWS"
    The platform of the initialization script, either Windows or Linux.
    runContext "SYSTEM_INITIALIZATION" | "USER_INITIALIZATION"
    The method to use when running the initialization script.
    script String

    StudioComponentInitializationScriptRunContext, StudioComponentInitializationScriptRunContextArgs

    SystemInitialization
    SYSTEM_INITIALIZATION
    UserInitialization
    USER_INITIALIZATION
    StudioComponentInitializationScriptRunContextSystemInitialization
    SYSTEM_INITIALIZATION
    StudioComponentInitializationScriptRunContextUserInitialization
    USER_INITIALIZATION
    SystemInitialization
    SYSTEM_INITIALIZATION
    UserInitialization
    USER_INITIALIZATION
    SystemInitialization
    SYSTEM_INITIALIZATION
    UserInitialization
    USER_INITIALIZATION
    SYSTEM_INITIALIZATION
    SYSTEM_INITIALIZATION
    USER_INITIALIZATION
    USER_INITIALIZATION
    "SYSTEM_INITIALIZATION"
    SYSTEM_INITIALIZATION
    "USER_INITIALIZATION"
    USER_INITIALIZATION

    StudioComponentLaunchProfilePlatform, StudioComponentLaunchProfilePlatformArgs

    Linux
    LINUX
    Windows
    WINDOWS
    StudioComponentLaunchProfilePlatformLinux
    LINUX
    StudioComponentLaunchProfilePlatformWindows
    WINDOWS
    Linux
    LINUX
    Windows
    WINDOWS
    Linux
    LINUX
    Windows
    WINDOWS
    LINUX
    LINUX
    WINDOWS
    WINDOWS
    "LINUX"
    LINUX
    "WINDOWS"
    WINDOWS

    StudioComponentLicenseServiceConfiguration, StudioComponentLicenseServiceConfigurationArgs

    Endpoint string
    Endpoint string
    endpoint String
    endpoint string
    endpoint String

    StudioComponentScriptParameterKeyValue, StudioComponentScriptParameterKeyValueArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    StudioComponentSharedFileSystemConfiguration, StudioComponentSharedFileSystemConfigurationArgs

    StudioComponentSubtype, StudioComponentSubtypeArgs

    AwsManagedMicrosoftAd
    AWS_MANAGED_MICROSOFT_AD
    AmazonFsxForWindows
    AMAZON_FSX_FOR_WINDOWS
    AmazonFsxForLustre
    AMAZON_FSX_FOR_LUSTRE
    Custom
    CUSTOM
    StudioComponentSubtypeAwsManagedMicrosoftAd
    AWS_MANAGED_MICROSOFT_AD
    StudioComponentSubtypeAmazonFsxForWindows
    AMAZON_FSX_FOR_WINDOWS
    StudioComponentSubtypeAmazonFsxForLustre
    AMAZON_FSX_FOR_LUSTRE
    StudioComponentSubtypeCustom
    CUSTOM
    AwsManagedMicrosoftAd
    AWS_MANAGED_MICROSOFT_AD
    AmazonFsxForWindows
    AMAZON_FSX_FOR_WINDOWS
    AmazonFsxForLustre
    AMAZON_FSX_FOR_LUSTRE
    Custom
    CUSTOM
    AwsManagedMicrosoftAd
    AWS_MANAGED_MICROSOFT_AD
    AmazonFsxForWindows
    AMAZON_FSX_FOR_WINDOWS
    AmazonFsxForLustre
    AMAZON_FSX_FOR_LUSTRE
    Custom
    CUSTOM
    AWS_MANAGED_MICROSOFT_AD
    AWS_MANAGED_MICROSOFT_AD
    AMAZON_FSX_FOR_WINDOWS
    AMAZON_FSX_FOR_WINDOWS
    AMAZON_FSX_FOR_LUSTRE
    AMAZON_FSX_FOR_LUSTRE
    CUSTOM
    CUSTOM
    "AWS_MANAGED_MICROSOFT_AD"
    AWS_MANAGED_MICROSOFT_AD
    "AMAZON_FSX_FOR_WINDOWS"
    AMAZON_FSX_FOR_WINDOWS
    "AMAZON_FSX_FOR_LUSTRE"
    AMAZON_FSX_FOR_LUSTRE
    "CUSTOM"
    CUSTOM

    StudioComponentType, StudioComponentTypeArgs

    ActiveDirectory
    ACTIVE_DIRECTORY
    SharedFileSystem
    SHARED_FILE_SYSTEM
    ComputeFarm
    COMPUTE_FARM
    LicenseService
    LICENSE_SERVICE
    Custom
    CUSTOM
    StudioComponentTypeActiveDirectory
    ACTIVE_DIRECTORY
    StudioComponentTypeSharedFileSystem
    SHARED_FILE_SYSTEM
    StudioComponentTypeComputeFarm
    COMPUTE_FARM
    StudioComponentTypeLicenseService
    LICENSE_SERVICE
    StudioComponentTypeCustom
    CUSTOM
    ActiveDirectory
    ACTIVE_DIRECTORY
    SharedFileSystem
    SHARED_FILE_SYSTEM
    ComputeFarm
    COMPUTE_FARM
    LicenseService
    LICENSE_SERVICE
    Custom
    CUSTOM
    ActiveDirectory
    ACTIVE_DIRECTORY
    SharedFileSystem
    SHARED_FILE_SYSTEM
    ComputeFarm
    COMPUTE_FARM
    LicenseService
    LICENSE_SERVICE
    Custom
    CUSTOM
    ACTIVE_DIRECTORY
    ACTIVE_DIRECTORY
    SHARED_FILE_SYSTEM
    SHARED_FILE_SYSTEM
    COMPUTE_FARM
    COMPUTE_FARM
    LICENSE_SERVICE
    LICENSE_SERVICE
    CUSTOM
    CUSTOM
    "ACTIVE_DIRECTORY"
    ACTIVE_DIRECTORY
    "SHARED_FILE_SYSTEM"
    SHARED_FILE_SYSTEM
    "COMPUTE_FARM"
    COMPUTE_FARM
    "LICENSE_SERVICE"
    LICENSE_SERVICE
    "CUSTOM"
    CUSTOM

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi