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.74.0 (build 6d08790)",
           date="2023-05-31T18:43:33.890Z")
@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()))
         .scriptParameters(List.of(ScriptParameterKeyValueProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .subtype("subtype")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

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 Object	getScriptParameters()	Parameters for the studio component scripts.
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.

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.

getType

@Stability(Stable)
@NotNull
String getType()

The type of the studio component.

getConfiguration

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

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

getDescription

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

A human-readable description for the studio component resource.

getEc2SecurityGroupIds

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

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

getInitializationScripts

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

Initialization scripts for studio components.

getScriptParameters

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

Parameters for the studio component scripts.

getSubtype

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

The specific subtype of a studio component.

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 .

builder

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

Returns:

a CfnStudioComponentProps.Builder of CfnStudioComponentProps