AWS Native v0.126.0, Sep 30 24

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.nimblestudio.getLaunchProfile

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getLaunchProfile

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 getLaunchProfile(args: GetLaunchProfileArgs, opts?: InvokeOptions): Promise<GetLaunchProfileResult>
function getLaunchProfileOutput(args: GetLaunchProfileOutputArgs, opts?: InvokeOptions): Output<GetLaunchProfileResult>

def get_launch_profile(launch_profile_id: Optional[str] = None,
                       studio_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetLaunchProfileResult
def get_launch_profile_output(launch_profile_id: Optional[pulumi.Input[str]] = None,
                       studio_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetLaunchProfileResult]

func LookupLaunchProfile(ctx *Context, args *LookupLaunchProfileArgs, opts ...InvokeOption) (*LookupLaunchProfileResult, error)
func LookupLaunchProfileOutput(ctx *Context, args *LookupLaunchProfileOutputArgs, opts ...InvokeOption) LookupLaunchProfileResultOutput

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

public static class GetLaunchProfile 
{
    public static Task<GetLaunchProfileResult> InvokeAsync(GetLaunchProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetLaunchProfileResult> Invoke(GetLaunchProfileInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLaunchProfileResult> getLaunchProfile(GetLaunchProfileArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:nimblestudio:getLaunchProfile
  arguments:
    # arguments dictionary

The following arguments are supported:

LaunchProfileId string: The unique identifier for the launch profile resource.
StudioId string

LaunchProfileId string: The unique identifier for the launch profile resource.
StudioId string

launchProfileId String: The unique identifier for the launch profile resource.
studioId String

launchProfileId string: The unique identifier for the launch profile resource.
studioId string

launch_profile_id str: The unique identifier for the launch profile resource.
studio_id str

launchProfileId String: The unique identifier for the launch profile resource.
studioId String

getLaunchProfile Result

The following output properties are available:

Description string
LaunchProfileId string: The unique identifier for the launch profile resource.
LaunchProfileProtocolVersions List<string>
Name string
StreamConfiguration Pulumi.AwsNative.NimbleStudio.Outputs.LaunchProfileStreamConfiguration: A configuration for a streaming session.
StudioComponentIds List<string>

Description string
LaunchProfileId string: The unique identifier for the launch profile resource.
LaunchProfileProtocolVersions []string
Name string
StreamConfiguration LaunchProfileStreamConfiguration: A configuration for a streaming session.
StudioComponentIds []string

description String
launchProfileId String: The unique identifier for the launch profile resource.
launchProfileProtocolVersions List<String>
name String
streamConfiguration LaunchProfileStreamConfiguration: A configuration for a streaming session.
studioComponentIds List<String>

description string
launchProfileId string: The unique identifier for the launch profile resource.
launchProfileProtocolVersions string[]
name string
streamConfiguration LaunchProfileStreamConfiguration: A configuration for a streaming session.
studioComponentIds string[]

description str
launch_profile_id str: The unique identifier for the launch profile resource.
launch_profile_protocol_versions Sequence[str]
name str
stream_configuration LaunchProfileStreamConfiguration: A configuration for a streaming session.
studio_component_ids Sequence[str]

description String
launchProfileId String: The unique identifier for the launch profile resource.
launchProfileProtocolVersions List<String>
name String
streamConfiguration Property Map: A configuration for a streaming session.
studioComponentIds List<String>

Supporting Types

LaunchProfileAutomaticTerminationMode

LaunchProfileSessionBackupMode

LaunchProfileSessionPersistenceMode

LaunchProfileStreamConfiguration

ClipboardMode Pulumi.AwsNative.NimbleStudio.LaunchProfileStreamingClipboardMode

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

Ec2InstanceTypes List<Pulumi.AwsNative.NimbleStudio.LaunchProfileStreamingInstanceType>

StreamingImageIds List<string>

AutomaticTerminationMode Pulumi.AwsNative.NimbleStudio.LaunchProfileAutomaticTerminationMode

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

MaxSessionLengthInMinutes double

MaxStoppedSessionLengthInMinutes double

SessionBackup Pulumi.AwsNative.NimbleStudio.Inputs.LaunchProfileStreamConfigurationSessionBackup

Information about the streaming session backup.

SessionPersistenceMode Pulumi.AwsNative.NimbleStudio.LaunchProfileSessionPersistenceMode

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

SessionStorage Pulumi.AwsNative.NimbleStudio.Inputs.LaunchProfileStreamConfigurationSessionStorage

The upload storage for a streaming session.

VolumeConfiguration Pulumi.AwsNative.NimbleStudio.Inputs.LaunchProfileVolumeConfiguration

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

ClipboardMode LaunchProfileStreamingClipboardMode

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

Ec2InstanceTypes []LaunchProfileStreamingInstanceType

StreamingImageIds []string

AutomaticTerminationMode LaunchProfileAutomaticTerminationMode

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

MaxSessionLengthInMinutes float64

MaxStoppedSessionLengthInMinutes float64

SessionBackup LaunchProfileStreamConfigurationSessionBackup

Information about the streaming session backup.

SessionPersistenceMode LaunchProfileSessionPersistenceMode

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

SessionStorage LaunchProfileStreamConfigurationSessionStorage

The upload storage for a streaming session.

VolumeConfiguration LaunchProfileVolumeConfiguration

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

clipboardMode LaunchProfileStreamingClipboardMode

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

ec2InstanceTypes List<LaunchProfileStreamingInstanceType>

streamingImageIds List<String>

automaticTerminationMode LaunchProfileAutomaticTerminationMode

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

maxSessionLengthInMinutes Double

maxStoppedSessionLengthInMinutes Double

sessionBackup LaunchProfileStreamConfigurationSessionBackup

Information about the streaming session backup.

sessionPersistenceMode LaunchProfileSessionPersistenceMode

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

sessionStorage LaunchProfileStreamConfigurationSessionStorage

The upload storage for a streaming session.

volumeConfiguration LaunchProfileVolumeConfiguration

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

clipboardMode LaunchProfileStreamingClipboardMode

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

ec2InstanceTypes LaunchProfileStreamingInstanceType[]

streamingImageIds string[]

automaticTerminationMode LaunchProfileAutomaticTerminationMode

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

maxSessionLengthInMinutes number

maxStoppedSessionLengthInMinutes number

sessionBackup LaunchProfileStreamConfigurationSessionBackup

Information about the streaming session backup.

sessionPersistenceMode LaunchProfileSessionPersistenceMode

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

sessionStorage LaunchProfileStreamConfigurationSessionStorage

The upload storage for a streaming session.

volumeConfiguration LaunchProfileVolumeConfiguration

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

clipboard_mode LaunchProfileStreamingClipboardMode

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

ec2_instance_types Sequence[LaunchProfileStreamingInstanceType]

streaming_image_ids Sequence[str]

automatic_termination_mode LaunchProfileAutomaticTerminationMode

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

max_session_length_in_minutes float

max_stopped_session_length_in_minutes float

session_backup LaunchProfileStreamConfigurationSessionBackup

Information about the streaming session backup.

session_persistence_mode LaunchProfileSessionPersistenceMode

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

session_storage LaunchProfileStreamConfigurationSessionStorage

The upload storage for a streaming session.

volume_configuration LaunchProfileVolumeConfiguration

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

clipboardMode "ENABLED" | "DISABLED"

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

streamingImageIds List<String>

automaticTerminationMode "DEACTIVATED" | "ACTIVATED"

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

maxSessionLengthInMinutes Number

maxStoppedSessionLengthInMinutes Number

sessionBackup Property Map

Information about the streaming session backup.

sessionPersistenceMode "DEACTIVATED" | "ACTIVATED"

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

sessionStorage Property Map

The upload storage for a streaming session.

volumeConfiguration Property Map

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

LaunchProfileStreamConfigurationSessionBackup

MaxBackupsToRetain double

Mode Pulumi.AwsNative.NimbleStudio.LaunchProfileSessionBackupMode

Specifies how artists sessions are backed up.

Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED , which means that backups are deactivated. To allow backups, set this value to AUTOMATIC .

MaxBackupsToRetain float64

Mode LaunchProfileSessionBackupMode