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

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

Create LaunchProfile Resource

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

Constructor syntax

new LaunchProfile(name: string, args: LaunchProfileArgs, opts?: CustomResourceOptions);

@overload
def LaunchProfile(resource_name: str,
                  args: LaunchProfileArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def LaunchProfile(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  ec2_subnet_ids: Optional[Sequence[str]] = None,
                  launch_profile_protocol_versions: Optional[Sequence[str]] = None,
                  stream_configuration: Optional[LaunchProfileStreamConfigurationArgs] = None,
                  studio_component_ids: Optional[Sequence[str]] = None,
                  studio_id: Optional[str] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)

func NewLaunchProfile(ctx *Context, name string, args LaunchProfileArgs, opts ...ResourceOption) (*LaunchProfile, error)

public LaunchProfile(string name, LaunchProfileArgs args, CustomResourceOptions? opts = null)

public LaunchProfile(String name, LaunchProfileArgs args)
public LaunchProfile(String name, LaunchProfileArgs args, CustomResourceOptions options)

type: aws-native:nimblestudio:LaunchProfile
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 LaunchProfileArgs: 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 LaunchProfileArgs: 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 LaunchProfileArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LaunchProfileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args LaunchProfileArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

LaunchProfile 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 LaunchProfile resource accepts the following input properties:

Ec2SubnetIds List<string>

LaunchProfileProtocolVersions List<string>

StreamConfiguration Pulumi.AwsNative.NimbleStudio.Inputs.LaunchProfileStreamConfiguration

A configuration for a streaming session.

StudioComponentIds List<string>

StudioId string

Description string

Name string

Tags Dictionary<string, string>

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

For more information, see Tag .

Ec2SubnetIds []string

LaunchProfileProtocolVersions []string

StreamConfiguration LaunchProfileStreamConfigurationArgs

A configuration for a streaming session.

StudioComponentIds []string

StudioId string

Description string

Name string

Tags map[string]string

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

For more information, see Tag .

ec2SubnetIds List<String>

launchProfileProtocolVersions List<String>

streamConfiguration LaunchProfileStreamConfiguration

A configuration for a streaming session.

studioComponentIds List<String>

studioId String

description String

name String

tags Map<String,String>

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

For more information, see Tag .

ec2SubnetIds string[]

launchProfileProtocolVersions string[]

streamConfiguration LaunchProfileStreamConfiguration

A configuration for a streaming session.

studioComponentIds string[]

studioId string

description string

name string

tags {[key: string]: string}

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

For more information, see Tag .

ec2_subnet_ids Sequence[str]

launch_profile_protocol_versions Sequence[str]

stream_configuration LaunchProfileStreamConfigurationArgs

A configuration for a streaming session.

studio_component_ids Sequence[str]

studio_id str

description str

name str

tags Mapping[str, str]

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

For more information, see Tag .

ec2SubnetIds List<String>

launchProfileProtocolVersions List<String>

streamConfiguration Property Map

A configuration for a streaming session.

studioComponentIds List<String>

studioId String

description String

name String

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 LaunchProfile resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
LaunchProfileId string: The unique identifier for the launch profile resource.

Id string: The provider-assigned unique ID for this managed resource.
LaunchProfileId string: The unique identifier for the launch profile resource.

id String: The provider-assigned unique ID for this managed resource.
launchProfileId String: The unique identifier for the launch profile resource.

id string: The provider-assigned unique ID for this managed resource.
launchProfileId string: The unique identifier for the launch profile resource.

id str: The provider-assigned unique ID for this managed resource.
launch_profile_id str: The unique identifier for the launch profile resource.

id String: The provider-assigned unique ID for this managed resource.
launchProfileId String: The unique identifier for the launch profile resource.

Supporting Types

LaunchProfileAutomaticTerminationMode, LaunchProfileAutomaticTerminationModeArgs

Deactivated: DEACTIVATED
Activated: ACTIVATED

LaunchProfileAutomaticTerminationModeDeactivated: DEACTIVATED
LaunchProfileAutomaticTerminationModeActivated: ACTIVATED

Deactivated: DEACTIVATED
Activated: ACTIVATED

Deactivated: DEACTIVATED
Activated: ACTIVATED

DEACTIVATED: DEACTIVATED
ACTIVATED: ACTIVATED

"DEACTIVATED": DEACTIVATED
"ACTIVATED": ACTIVATED

LaunchProfileSessionBackupMode, LaunchProfileSessionBackupModeArgs

Automatic: AUTOMATIC
Deactivated: DEACTIVATED

LaunchProfileSessionBackupModeAutomatic: AUTOMATIC
LaunchProfileSessionBackupModeDeactivated: DEACTIVATED

Automatic: AUTOMATIC
Deactivated: DEACTIVATED

Automatic: AUTOMATIC
Deactivated: DEACTIVATED

AUTOMATIC: AUTOMATIC
DEACTIVATED: DEACTIVATED

"AUTOMATIC": AUTOMATIC
"DEACTIVATED": DEACTIVATED

LaunchProfileSessionPersistenceMode, LaunchProfileSessionPersistenceModeArgs

Deactivated: DEACTIVATED
Activated: ACTIVATED

LaunchProfileSessionPersistenceModeDeactivated: DEACTIVATED
LaunchProfileSessionPersistenceModeActivated: ACTIVATED

Deactivated: DEACTIVATED
Activated: ACTIVATED

Deactivated: DEACTIVATED
Activated: ACTIVATED

DEACTIVATED: DEACTIVATED
ACTIVATED: ACTIVATED

"DEACTIVATED": DEACTIVATED
"ACTIVATED": ACTIVATED

LaunchProfileStreamConfiguration, LaunchProfileStreamConfigurationArgs

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, LaunchProfileStreamConfigurationSessionBackupArgs

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