Package software.amazon.awscdk.services.nimblestudio

Class CfnStudioComponent

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.nimblestudio.CfnStudioComponent
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IStudioComponentRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:09.806Z") @Stability(Stable) public class CfnStudioComponent extends CfnResource implements IInspectable, IStudioComponentRef, ITaggable
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studiocomponent.html.

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.*;
 CfnStudioComponent cfnStudioComponent = CfnStudioComponent.Builder.create(this, "MyCfnStudioComponent")
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStudioComponent

      protected CfnStudioComponent(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStudioComponent

      protected CfnStudioComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStudioComponent

      @Stability(Stable) public CfnStudioComponent(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStudioComponentProps props)
      Create a new AWS::NimbleStudio::StudioComponent.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrStudioComponentId

      @Stability(Stable) @NotNull public String getAttrStudioComponentId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStudioComponentRef

      @Stability(Stable) @NotNull public StudioComponentReference getStudioComponentRef()
      A reference to a StudioComponent resource.
      Specified by:
      getStudioComponentRef in interface IStudioComponentRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()

    • setName

      @Stability(Stable) public void setName(@NotNull String value)

    • getStudioId

      @Stability(Stable) @NotNull public String getStudioId()

    • setStudioId

      @Stability(Stable) public void setStudioId(@NotNull String value)

    • getType

      @Stability(Stable) @NotNull public String getType()

    • setType

      @Stability(Stable) public void setType(@NotNull String value)

    • getConfiguration

      @Stability(Stable) @Nullable public Object getConfiguration()
      Returns union: either IResolvable or CfnStudioComponent.StudioComponentConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable IResolvable value)

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable CfnStudioComponent.StudioComponentConfigurationProperty value)

    • getDescription

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

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)

    • getEc2SecurityGroupIds

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

    • setEc2SecurityGroupIds

      @Stability(Stable) public void setEc2SecurityGroupIds(@Nullable List<String> value)

    • getInitializationScripts

      @Stability(Stable) @Nullable public Object getInitializationScripts()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStudioComponent.StudioComponentInitializationScriptProperty>

    • setInitializationScripts

      @Stability(Stable) public void setInitializationScripts(@Nullable IResolvable value)

    • setInitializationScripts

      @Stability(Stable) public void setInitializationScripts(@Nullable List<Object> value)

    • getScriptParameters

      @Stability(Stable) @Nullable public Object getScriptParameters()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStudioComponent.ScriptParameterKeyValueProperty>

    • setScriptParameters

      @Stability(Stable) public void setScriptParameters(@Nullable IResolvable value)

    • setScriptParameters

      @Stability(Stable) public void setScriptParameters(@Nullable List<Object> value)

    • getSubtype

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

    • setSubtype

      @Stability(Stable) public void setSubtype(@Nullable String value)

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)