CfnStudioComponent

class aws_cdk.aws_nimblestudio.CfnStudioComponent(scope, id, *, name, studio_id, type, configuration=None, description=None, ec2_security_group_ids=None, initialization_scripts=None, runtime_role_arn=None, script_parameters=None, secure_initialization_role_arn=None, subtype=None, tags=None)

Bases: CfnResource

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

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

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

cfn_studio_component = nimblestudio.CfnStudioComponent(self, "MyCfnStudioComponent",
    name="name",
    studio_id="studioId",
    type="type",

    # the properties below are optional
    configuration=nimblestudio.CfnStudioComponent.StudioComponentConfigurationProperty(
        active_directory_configuration=nimblestudio.CfnStudioComponent.ActiveDirectoryConfigurationProperty(
            computer_attributes=[nimblestudio.CfnStudioComponent.ActiveDirectoryComputerAttributeProperty(
                name="name",
                value="value"
            )],
            directory_id="directoryId",
            organizational_unit_distinguished_name="organizationalUnitDistinguishedName"
        ),
        compute_farm_configuration=nimblestudio.CfnStudioComponent.ComputeFarmConfigurationProperty(
            active_directory_user="activeDirectoryUser",
            endpoint="endpoint"
        ),
        license_service_configuration=nimblestudio.CfnStudioComponent.LicenseServiceConfigurationProperty(
            endpoint="endpoint"
        ),
        shared_file_system_configuration=nimblestudio.CfnStudioComponent.SharedFileSystemConfigurationProperty(
            endpoint="endpoint",
            file_system_id="fileSystemId",
            linux_mount_point="linuxMountPoint",
            share_name="shareName",
            windows_mount_drive="windowsMountDrive"
        )
    ),
    description="description",
    ec2_security_group_ids=["ec2SecurityGroupIds"],
    initialization_scripts=[nimblestudio.CfnStudioComponent.StudioComponentInitializationScriptProperty(
        launch_profile_protocol_version="launchProfileProtocolVersion",
        platform="platform",
        run_context="runContext",
        script="script"
    )],
    runtime_role_arn="runtimeRoleArn",
    script_parameters=[nimblestudio.CfnStudioComponent.ScriptParameterKeyValueProperty(
        key="key",
        value="value"
    )],
    secure_initialization_role_arn="secureInitializationRoleArn",
    subtype="subtype",
    tags={
        "tags_key": "tags"
    }
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
name (str) – A friendly name for the studio component resource.
studio_id (str) – The unique identifier for a studio resource. In Nimble Studio , all other resources are contained in a studio resource.
type (str) – The type of the studio component.
configuration (Union[IResolvable, StudioComponentConfigurationProperty, Dict[str, Any], None]) – The configuration of the studio component, based on component type.
description (Optional[str]) – A human-readable description for the studio component resource.
ec2_security_group_ids (Optional[Sequence[str]]) – The EC2 security groups that control access to the studio component.
initialization_scripts (Union[IResolvable, Sequence[Union[IResolvable, StudioComponentInitializationScriptProperty, Dict[str, Any]]], None]) – Initialization scripts for studio components.
runtime_role_arn (Optional[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 (Union[IResolvable, Sequence[Union[IResolvable, ScriptParameterKeyValueProperty, Dict[str, Any]]], None]) – Parameters for the studio component scripts.
secure_initialization_role_arn (Optional[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 (Optional[str]) – The specific subtype of a studio component.
tags (Optional[Mapping[str, str]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::NimbleStudio::StudioComponent'

attr_studio_component_id

The unique identifier for the studio component resource.

CloudformationAttribute:: StudioComponentId

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

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

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: A human-readable description for the studio component resource.

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

initialization_scripts: Initialization scripts for studio components.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: A friendly name for the studio component resource.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

runtime_role_arn: 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: Parameters for the studio component scripts.

secure_initialization_role_arn: 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.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

studio_id: 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.

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

type: The type of the studio component.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

ActiveDirectoryComputerAttributeProperty

class CfnStudioComponent.ActiveDirectoryComputerAttributeProperty(*, name=None, value=None)

Bases: object

An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.

Parameters:

name (Optional[str]) – The name for the LDAP attribute.
value (Optional[str]) – The value for the LDAP attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectorycomputerattribute.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

active_directory_computer_attribute_property = nimblestudio.CfnStudioComponent.ActiveDirectoryComputerAttributeProperty(
    name="name",
    value="value"
)

Attributes

name

The name for the LDAP attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectorycomputerattribute.html#cfn-nimblestudio-studiocomponent-activedirectorycomputerattribute-name

value

The value for the LDAP attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectorycomputerattribute.html#cfn-nimblestudio-studiocomponent-activedirectorycomputerattribute-value

ActiveDirectoryConfigurationProperty

class CfnStudioComponent.ActiveDirectoryConfigurationProperty(*, computer_attributes=None, directory_id=None, organizational_unit_distinguished_name=None)

Bases: object

The configuration for a AWS Directory Service for Microsoft Active Directory studio resource.

Parameters:

computer_attributes (Union[IResolvable, Sequence[Union[IResolvable, ActiveDirectoryComputerAttributeProperty, Dict[str, Any]]], None]) – A collection of custom attributes for an Active Directory computer.
directory_id (Optional[str]) – The directory ID of the AWS Directory Service for Microsoft Active Directory to access using this studio component.
organizational_unit_distinguished_name (Optional[str]) – The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

active_directory_configuration_property = nimblestudio.CfnStudioComponent.ActiveDirectoryConfigurationProperty(
    computer_attributes=[nimblestudio.CfnStudioComponent.ActiveDirectoryComputerAttributeProperty(
        name="name",
        value="value"
    )],
    directory_id="directoryId",
    organizational_unit_distinguished_name="organizationalUnitDistinguishedName"
)

Attributes

computer_attributes

A collection of custom attributes for an Active Directory computer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html#cfn-nimblestudio-studiocomponent-activedirectoryconfiguration-computerattributes

directory_id

The directory ID of the AWS Directory Service for Microsoft Active Directory to access using this studio component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html#cfn-nimblestudio-studiocomponent-activedirectoryconfiguration-directoryid

organizational_unit_distinguished_name

The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html#cfn-nimblestudio-studiocomponent-activedirectoryconfiguration-organizationalunitdistinguishedname

ComputeFarmConfigurationProperty

class CfnStudioComponent.ComputeFarmConfigurationProperty(*, active_directory_user=None, endpoint=None)

Bases: object

The configuration for a render farm that is associated with a studio resource.

Parameters:

active_directory_user (Optional[str]) – The name of an Active Directory user that is used on ComputeFarm worker instances.
endpoint (Optional[str]) – The endpoint of the ComputeFarm that is accessed by the studio component resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-computefarmconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

compute_farm_configuration_property = nimblestudio.CfnStudioComponent.ComputeFarmConfigurationProperty(
    active_directory_user="activeDirectoryUser",
    endpoint="endpoint"
)

Attributes

active_directory_user

The name of an Active Directory user that is used on ComputeFarm worker instances.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-computefarmconfiguration.html#cfn-nimblestudio-studiocomponent-computefarmconfiguration-activedirectoryuser

endpoint

The endpoint of the ComputeFarm that is accessed by the studio component resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-computefarmconfiguration.html#cfn-nimblestudio-studiocomponent-computefarmconfiguration-endpoint

LicenseServiceConfigurationProperty

class CfnStudioComponent.LicenseServiceConfigurationProperty(*, endpoint=None)

Bases: object

The configuration for a license service that is associated with a studio resource.

Parameters:: endpoint (Optional[str]) – The endpoint of the license service that is accessed by the studio component resource.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-licenseserviceconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

license_service_configuration_property = nimblestudio.CfnStudioComponent.LicenseServiceConfigurationProperty(
    endpoint="endpoint"
)

Attributes

endpoint

The endpoint of the license service that is accessed by the studio component resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-licenseserviceconfiguration.html#cfn-nimblestudio-studiocomponent-licenseserviceconfiguration-endpoint

ScriptParameterKeyValueProperty

class CfnStudioComponent.ScriptParameterKeyValueProperty(*, key=None, value=None)

Bases: object

A parameter for a studio component script, in the form of a key-value pair.

Parameters:

key (Optional[str]) – A script parameter key.
value (Optional[str]) – A script parameter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-scriptparameterkeyvalue.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

script_parameter_key_value_property = nimblestudio.CfnStudioComponent.ScriptParameterKeyValueProperty(
    key="key",
    value="value"
)

Attributes

key

A script parameter key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-scriptparameterkeyvalue.html#cfn-nimblestudio-studiocomponent-scriptparameterkeyvalue-key

value

A script parameter value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-scriptparameterkeyvalue.html#cfn-nimblestudio-studiocomponent-scriptparameterkeyvalue-value

SharedFileSystemConfigurationProperty

class CfnStudioComponent.SharedFileSystemConfigurationProperty(*, endpoint=None, file_system_id=None, linux_mount_point=None, share_name=None, windows_mount_drive=None)

Bases: object

The configuration for a shared file storage system that is associated with a studio resource.

Parameters:

endpoint (Optional[str]) – The endpoint of the shared file system that is accessed by the studio component resource.
file_system_id (Optional[str]) – The unique identifier for a file system.
linux_mount_point (Optional[str]) – The mount location for a shared file system on a Linux virtual workstation.
share_name (Optional[str]) – The name of the file share.
windows_mount_drive (Optional[str]) – The mount location for a shared file system on a Windows virtual workstation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

shared_file_system_configuration_property = nimblestudio.CfnStudioComponent.SharedFileSystemConfigurationProperty(
    endpoint="endpoint",
    file_system_id="fileSystemId",
    linux_mount_point="linuxMountPoint",
    share_name="shareName",
    windows_mount_drive="windowsMountDrive"
)

Attributes

endpoint

The endpoint of the shared file system that is accessed by the studio component resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-endpoint

file_system_id

The unique identifier for a file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-filesystemid

linux_mount_point

The mount location for a shared file system on a Linux virtual workstation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-linuxmountpoint

share_name

The name of the file share.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-sharename

windows_mount_drive

The mount location for a shared file system on a Windows virtual workstation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html#cfn-nimblestudio-studiocomponent-sharedfilesystemconfiguration-windowsmountdrive

StudioComponentConfigurationProperty

class CfnStudioComponent.StudioComponentConfigurationProperty(*, active_directory_configuration=None, compute_farm_configuration=None, license_service_configuration=None, shared_file_system_configuration=None)

Bases: object

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

Parameters:

active_directory_configuration (Union[IResolvable, ActiveDirectoryConfigurationProperty, Dict[str, Any], None]) – The configuration for a AWS Directory Service for Microsoft Active Directory studio resource.
compute_farm_configuration (Union[IResolvable, ComputeFarmConfigurationProperty, Dict[str, Any], None]) – The configuration for a render farm that is associated with a studio resource.
license_service_configuration (Union[IResolvable, LicenseServiceConfigurationProperty, Dict[str, Any], None]) – The configuration for a license service that is associated with a studio resource.
shared_file_system_configuration (Union[IResolvable, SharedFileSystemConfigurationProperty, Dict[str, Any], None]) – The configuration for a shared file storage system that is associated with a studio resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

studio_component_configuration_property = nimblestudio.CfnStudioComponent.StudioComponentConfigurationProperty(
    active_directory_configuration=nimblestudio.CfnStudioComponent.ActiveDirectoryConfigurationProperty(
        computer_attributes=[nimblestudio.CfnStudioComponent.ActiveDirectoryComputerAttributeProperty(
            name="name",
            value="value"
        )],
        directory_id="directoryId",
        organizational_unit_distinguished_name="organizationalUnitDistinguishedName"
    ),
    compute_farm_configuration=nimblestudio.CfnStudioComponent.ComputeFarmConfigurationProperty(
        active_directory_user="activeDirectoryUser",
        endpoint="endpoint"
    ),
    license_service_configuration=nimblestudio.CfnStudioComponent.LicenseServiceConfigurationProperty(
        endpoint="endpoint"
    ),
    shared_file_system_configuration=nimblestudio.CfnStudioComponent.SharedFileSystemConfigurationProperty(
        endpoint="endpoint",
        file_system_id="fileSystemId",
        linux_mount_point="linuxMountPoint",
        share_name="shareName",
        windows_mount_drive="windowsMountDrive"
    )
)

Attributes

active_directory_configuration

The configuration for a AWS Directory Service for Microsoft Active Directory studio resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html#cfn-nimblestudio-studiocomponent-studiocomponentconfiguration-activedirectoryconfiguration

compute_farm_configuration

The configuration for a render farm that is associated with a studio resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html#cfn-nimblestudio-studiocomponent-studiocomponentconfiguration-computefarmconfiguration

license_service_configuration

The configuration for a license service that is associated with a studio resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html#cfn-nimblestudio-studiocomponent-studiocomponentconfiguration-licenseserviceconfiguration

shared_file_system_configuration

The configuration for a shared file storage system that is associated with a studio resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentconfiguration.html#cfn-nimblestudio-studiocomponent-studiocomponentconfiguration-sharedfilesystemconfiguration

StudioComponentInitializationScriptProperty

class CfnStudioComponent.StudioComponentInitializationScriptProperty(*, launch_profile_protocol_version=None, platform=None, run_context=None, script=None)

Bases: object

Initialization scripts for studio components.

Parameters:

launch_profile_protocol_version (Optional[str]) – The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.
platform (Optional[str]) – The platform of the initialization script, either Windows or Linux.
run_context (Optional[str]) – The method to use when running the initialization script.
script (Optional[str]) – The initialization script.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

studio_component_initialization_script_property = nimblestudio.CfnStudioComponent.StudioComponentInitializationScriptProperty(
    launch_profile_protocol_version="launchProfileProtocolVersion",
    platform="platform",
    run_context="runContext",
    script="script"
)

Attributes

launch_profile_protocol_version

The version number of the protocol that is used by the launch profile.

The only valid version is “2021-03-31”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html#cfn-nimblestudio-studiocomponent-studiocomponentinitializationscript-launchprofileprotocolversion

platform

The platform of the initialization script, either Windows or Linux.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html#cfn-nimblestudio-studiocomponent-studiocomponentinitializationscript-platform

run_context

The method to use when running the initialization script.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html#cfn-nimblestudio-studiocomponent-studiocomponentinitializationscript-runcontext

script

The initialization script.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-studiocomponentinitializationscript.html#cfn-nimblestudio-studiocomponent-studiocomponentinitializationscript-script