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

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.getStudioComponent

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

    Using getStudioComponent

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStudioComponent(args: GetStudioComponentArgs, opts?: InvokeOptions): Promise<GetStudioComponentResult>
    function getStudioComponentOutput(args: GetStudioComponentOutputArgs, opts?: InvokeOptions): Output<GetStudioComponentResult>
    def get_studio_component(studio_component_id: Optional[str] = None,
                             studio_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetStudioComponentResult
    def get_studio_component_output(studio_component_id: Optional[pulumi.Input[str]] = None,
                             studio_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetStudioComponentResult]
    func LookupStudioComponent(ctx *Context, args *LookupStudioComponentArgs, opts ...InvokeOption) (*LookupStudioComponentResult, error)
    func LookupStudioComponentOutput(ctx *Context, args *LookupStudioComponentOutputArgs, opts ...InvokeOption) LookupStudioComponentResultOutput

    > Note: This function is named LookupStudioComponent in the Go SDK.

    public static class GetStudioComponent 
    {
        public static Task<GetStudioComponentResult> InvokeAsync(GetStudioComponentArgs args, InvokeOptions? opts = null)
        public static Output<GetStudioComponentResult> Invoke(GetStudioComponentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStudioComponentResult> getStudioComponent(GetStudioComponentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:nimblestudio:getStudioComponent
      arguments:
        # arguments dictionary

    The following arguments are supported:

    StudioComponentId string
    The unique identifier for the studio component resource.
    StudioId string
    StudioComponentId string
    The unique identifier for the studio component resource.
    StudioId string
    studioComponentId String
    The unique identifier for the studio component resource.
    studioId String
    studioComponentId string
    The unique identifier for the studio component resource.
    studioId string
    studio_component_id str
    The unique identifier for the studio component resource.
    studio_id str
    studioComponentId String
    The unique identifier for the studio component resource.
    studioId String

    getStudioComponent Result

    The following output properties are available:

    Configuration Pulumi.AwsNative.NimbleStudio.Outputs.StudioComponentConfiguration0Properties | Pulumi.AwsNative.NimbleStudio.Outputs.StudioComponentConfiguration1Properties | Pulumi.AwsNative.NimbleStudio.Outputs.StudioComponentConfiguration2Properties | Pulumi.AwsNative.NimbleStudio.Outputs.StudioComponentConfiguration3Properties
    The configuration of the studio component, based on component type.
    Description string
    Ec2SecurityGroupIds List<string>
    InitializationScripts List<Pulumi.AwsNative.NimbleStudio.Outputs.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.Outputs.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.
    StudioComponentId string
    The unique identifier for the studio component resource.
    Type Pulumi.AwsNative.NimbleStudio.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.
    StudioComponentId string
    The unique identifier for the studio component resource.
    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.
    studioComponentId String
    The unique identifier for the studio component resource.
    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.
    studioComponentId string
    The unique identifier for the studio component resource.
    type StudioComponentType
    The type of the studio component.
    configuration StudioComponentConfiguration0Properties | StudioComponentConfiguration1Properties | StudioComponentConfiguration2Properties | StudioComponentConfiguration3Properties
    The configuration of the studio component, based on component type.
    description str
    ec2_security_group_ids Sequence[str]
    initialization_scripts Sequence[StudioComponentInitializationScript]
    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[StudioComponentScriptParameterKeyValue]
    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.
    studio_component_id str
    The unique identifier for the studio component resource.
    type StudioComponentType
    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.
    studioComponentId String
    The unique identifier for the studio component resource.
    type "ACTIVE_DIRECTORY" | "SHARED_FILE_SYSTEM" | "COMPUTE_FARM" | "LICENSE_SERVICE" | "CUSTOM"
    The type of the studio component.

    Supporting Types

    StudioComponentActiveDirectoryComputerAttribute

    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

    StudioComponentComputeFarmConfiguration

    StudioComponentConfiguration0Properties

    StudioComponentConfiguration1Properties

    StudioComponentConfiguration2Properties

    StudioComponentConfiguration3Properties

    StudioComponentInitializationScript

    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

    StudioComponentLaunchProfilePlatform

    StudioComponentLicenseServiceConfiguration

    Endpoint string
    Endpoint string
    endpoint String
    endpoint string
    endpoint String

    StudioComponentScriptParameterKeyValue

    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

    StudioComponentType

    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