CfnStudioComponentProps

class aws_cdk.aws_nimblestudio.CfnStudioComponentProps(*, name, studio_id, type, configuration=None, description=None, ec2_security_group_ids=None, initialization_scripts=None, script_parameters=None, subtype=None, tags=None)

Bases: object

Properties for defining a CfnStudioComponent.

Parameters
  • 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.

  • script_parameters (Union[IResolvable, Sequence[Union[IResolvable, ScriptParameterKeyValueProperty, Dict[str, Any]]], None]) – Parameters for the studio component scripts.

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

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_studio_component_props = nimblestudio.CfnStudioComponentProps(
    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"
    )],
    script_parameters=[nimblestudio.CfnStudioComponent.ScriptParameterKeyValueProperty(
        key="key",
        value="value"
    )],
    subtype="subtype",
    tags={
        "tags_key": "tags"
    }
)

Attributes

configuration

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

Link

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

Return type

Union[IResolvable, StudioComponentConfigurationProperty, None]

description

A human-readable description for the studio component resource.

Link

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

Return type

Optional[str]

ec2_security_group_ids

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

Link

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

Return type

Optional[List[str]]

initialization_scripts

Initialization scripts for studio components.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, StudioComponentInitializationScriptProperty]], None]

name

A friendly name for the studio component resource.

Link

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

Return type

str

script_parameters

Parameters for the studio component scripts.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ScriptParameterKeyValueProperty]], None]

studio_id

The unique identifier for a studio resource.

In Nimble Studio , all other resources are contained in a studio resource.

Link

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

Return type

str

subtype

The specific subtype of a studio component.

Link

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

Return type

Optional[str]

tags

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

For more information, see Tag .

Link

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

Return type

Optional[Mapping[str, str]]

type

The type of the studio component.

Link

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

Return type

str