Class CfnStudioComponent

The AWS::NimbleStudio::StudioComponent resource represents a network resource that is used by a studio's users and workflows.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnStudioComponent
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.NimbleStudio
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStudioComponent : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStudioComponent
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

A typical studio contains studio components for the following: a render farm, an Active Directory, a licensing service, and a shared file system.

Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.

A studio component also has a set of initialization scripts, which are returned by GetLaunchProfileInitialization . These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how studio resources are configured on a streaming session.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html

CloudformationResource: AWS::NimbleStudio::StudioComponent

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.NimbleStudio;

var cfnStudioComponent = new CfnStudioComponent(this, "MyCfnStudioComponent", new CfnStudioComponentProps {
    Name = "name",
    StudioId = "studioId",
    Type = "type",

    // the properties below are optional
    Configuration = new StudioComponentConfigurationProperty {
        ActiveDirectoryConfiguration = new ActiveDirectoryConfigurationProperty {
            ComputerAttributes = new [] { new ActiveDirectoryComputerAttributeProperty {
                Name = "name",
                Value = "value"
            } },
            DirectoryId = "directoryId",
            OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName"
        },
        ComputeFarmConfiguration = new ComputeFarmConfigurationProperty {
            ActiveDirectoryUser = "activeDirectoryUser",
            Endpoint = "endpoint"
        },
        LicenseServiceConfiguration = new LicenseServiceConfigurationProperty {
            Endpoint = "endpoint"
        },
        SharedFileSystemConfiguration = new SharedFileSystemConfigurationProperty {
            Endpoint = "endpoint",
            FileSystemId = "fileSystemId",
            LinuxMountPoint = "linuxMountPoint",
            ShareName = "shareName",
            WindowsMountDrive = "windowsMountDrive"
        }
    },
    Description = "description",
    Ec2SecurityGroupIds = new [] { "ec2SecurityGroupIds" },
    InitializationScripts = new [] { new StudioComponentInitializationScriptProperty {
        LaunchProfileProtocolVersion = "launchProfileProtocolVersion",
        Platform = "platform",
        RunContext = "runContext",
        Script = "script"
    } },
    ScriptParameters = new [] { new ScriptParameterKeyValueProperty {
        Key = "key",
        Value = "value"
    } },
    Subtype = "subtype",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
});

Synopsis

Constructors

CfnStudioComponent(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnStudioComponent(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnStudioComponent(Construct, String, ICfnStudioComponentProps)

Properties

AttrStudioComponentId

The unique identifier for the studio component resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Configuration

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

A human-readable description for the studio component resource.
Ec2SecurityGroupIds

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

Initialization scripts for studio components.
Name

A friendly name for the studio component resource.
ScriptParameters

Parameters for the studio component scripts.
StudioId

The unique identifier for a studio resource.
Subtype

The specific subtype of a studio component.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

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

The type of the studio component.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnStudioComponent(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnStudioComponent(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnStudioComponent(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnStudioComponent(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnStudioComponent(Construct, String, ICfnStudioComponentProps)

public CfnStudioComponent(Construct scope, string id, ICfnStudioComponentProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnStudioComponentProps

Resource properties.

Properties

AttrStudioComponentId

The unique identifier for the studio component resource.

public virtual string AttrStudioComponentId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: StudioComponentId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Configuration

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

public virtual object Configuration { get; set; }
Property Value

System.Object

Description

A human-readable description for the studio component resource.

public virtual string Description { get; set; }
Property Value

System.String

Ec2SecurityGroupIds

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

public virtual string[] Ec2SecurityGroupIds { get; set; }
Property Value

System.String[]

InitializationScripts

Initialization scripts for studio components.

public virtual object InitializationScripts { get; set; }
Property Value

System.Object

Name

A friendly name for the studio component resource.

public virtual string Name { get; set; }
Property Value

System.String

ScriptParameters

Parameters for the studio component scripts.

public virtual object ScriptParameters { get; set; }
Property Value

System.Object

StudioId

The unique identifier for a studio resource.

public virtual string StudioId { get; set; }
Property Value

System.String

Subtype

The specific subtype of a studio component.

public virtual string Subtype { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

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

public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Type

The type of the studio component.

public virtual string Type { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements