Package software.amazon.awscdk.services.nimblestudio

Interface CfnStudioComponentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStudioComponentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:10.212Z")
@Stability(Stable)
public interface CfnStudioComponentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStudioComponent.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.nimblestudio.*;
 CfnStudioComponentProps cfnStudioComponentProps = CfnStudioComponentProps.builder()
         .name("name")
         .studioId("studioId")
         .type("type")
         // the properties below are optional
         .configuration(StudioComponentConfigurationProperty.builder()
                 .activeDirectoryConfiguration(ActiveDirectoryConfigurationProperty.builder()
                         .computerAttributes(List.of(ActiveDirectoryComputerAttributeProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .directoryId("directoryId")
                         .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                         .build())
                 .computeFarmConfiguration(ComputeFarmConfigurationProperty.builder()
                         .activeDirectoryUser("activeDirectoryUser")
                         .endpoint("endpoint")
                         .build())
                 .licenseServiceConfiguration(LicenseServiceConfigurationProperty.builder()
                         .endpoint("endpoint")
                         .build())
                 .sharedFileSystemConfiguration(SharedFileSystemConfigurationProperty.builder()
                         .endpoint("endpoint")
                         .fileSystemId("fileSystemId")
                         .linuxMountPoint("linuxMountPoint")
                         .shareName("shareName")
                         .windowsMountDrive("windowsMountDrive")
                         .build())
                 .build())
         .description("description")
         .ec2SecurityGroupIds(List.of("ec2SecurityGroupIds"))
         .initializationScripts(List.of(StudioComponentInitializationScriptProperty.builder()
                 .launchProfileProtocolVersion("launchProfileProtocolVersion")
                 .platform("platform")
                 .runContext("runContext")
                 .script("script")
                 .build()))
         .runtimeRoleArn("runtimeRoleArn")
         .scriptParameters(List.of(ScriptParameterKeyValueProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .secureInitializationRoleArn("secureInitializationRoleArn")
         .subtype("subtype")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStudioComponentProps.Builder	A builder for CfnStudioComponentProps
static final class	CfnStudioComponentProps.Jsii$Proxy	An implementation for CfnStudioComponentProps

Method Summary

Modifier and Type	Method	Description
static CfnStudioComponentProps.Builder	builder()
default Object	getConfiguration()	The configuration of the studio component, based on component type.
default String	getDescription()	A human-readable description for the studio component resource.
default List<String>	getEc2SecurityGroupIds()	The EC2 security groups that control access to the studio component.
default Object	getInitializationScripts()	Initialization scripts for studio components.
String	getName()	A friendly name for the studio component resource.
default String	getRuntimeRoleArn()	An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
default Object	getScriptParameters()	Parameters for the studio component scripts.
default String	getSecureInitializationRoleArn()	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.
String	getStudioId()	The unique identifier for a studio resource.
default String	getSubtype()	The specific subtype of a studio component.
default Map<String,String>	getTags()	An array of key-value pairs to apply to this resource.
String	getType()	The type of the studio component.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A friendly name for the studio component resource.

See Also:

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

getStudioId

@Stability(Stable)
@NotNull
String getStudioId()

The unique identifier for a studio resource.

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

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of the studio component.

See Also:

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

getConfiguration

@Stability(Stable)
@Nullable
default Object getConfiguration()

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

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A human-readable description for the studio component resource.

See Also:

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

getEc2SecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getEc2SecurityGroupIds()

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

See Also:

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

getInitializationScripts

@Stability(Stable)
@Nullable
default Object getInitializationScripts()

Initialization scripts for studio components.

See Also:

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

getRuntimeRoleArn

@Stability(Stable)
@Nullable
default String getRuntimeRoleArn()

An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.

See Also:

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

getScriptParameters

@Stability(Stable)
@Nullable
default Object getScriptParameters()

Parameters for the studio component scripts.

See Also:

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

getSecureInitializationRoleArn

@Stability(Stable)
@Nullable
default String getSecureInitializationRoleArn()

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.

See Also:

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

getSubtype

@Stability(Stable)
@Nullable
default String getSubtype()

The specific subtype of a studio component.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnStudioComponentProps.Builder builder()

Returns:

a CfnStudioComponentProps.Builder of CfnStudioComponentProps