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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.661Z")
 @Stability(value=Stable)
public class CfnStudioComponent
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NimbleStudio::StudioComponent`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnStudioComponent.ActiveDirectoryComputerAttributeProperty Example:
static interface	CfnStudioComponent.ActiveDirectoryConfigurationProperty Example:
static class	CfnStudioComponent.Builder A fluent builder for CfnStudioComponent.
static interface	CfnStudioComponent.ComputeFarmConfigurationProperty Example:
static interface	CfnStudioComponent.LicenseServiceConfigurationProperty Example:
static interface	CfnStudioComponent.ScriptParameterKeyValueProperty Example:
static interface	CfnStudioComponent.SharedFileSystemConfigurationProperty Example:
static interface	CfnStudioComponent.StudioComponentConfigurationProperty Example:
static interface	CfnStudioComponent.StudioComponentInitializationScriptProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStudioComponent(software.constructs.Construct scope, String id, CfnStudioComponentProps props) Create a new `AWS::NimbleStudio::StudioComponent`.
protected	CfnStudioComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStudioComponent(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrStudioComponentId()
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration() `AWS::NimbleStudio::StudioComponent.Configuration`.
String	getDescription() `AWS::NimbleStudio::StudioComponent.Description`.
List<String>	getEc2SecurityGroupIds() `AWS::NimbleStudio::StudioComponent.Ec2SecurityGroupIds`.
Object	getInitializationScripts() `AWS::NimbleStudio::StudioComponent.InitializationScripts`.
String	getName() `AWS::NimbleStudio::StudioComponent.Name`.
Object	getScriptParameters() `AWS::NimbleStudio::StudioComponent.ScriptParameters`.
String	getStudioId() `AWS::NimbleStudio::StudioComponent.StudioId`.
String	getSubtype() `AWS::NimbleStudio::StudioComponent.Subtype`.
TagManager	getTags() `AWS::NimbleStudio::StudioComponent.Tags`.
String	getType() `AWS::NimbleStudio::StudioComponent.Type`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfiguration(CfnStudioComponent.StudioComponentConfigurationProperty value) `AWS::NimbleStudio::StudioComponent.Configuration`.
void	setConfiguration(IResolvable value) `AWS::NimbleStudio::StudioComponent.Configuration`.
void	setDescription(String value) `AWS::NimbleStudio::StudioComponent.Description`.
void	setEc2SecurityGroupIds(List<String> value) `AWS::NimbleStudio::StudioComponent.Ec2SecurityGroupIds`.
void	setInitializationScripts(IResolvable value) `AWS::NimbleStudio::StudioComponent.InitializationScripts`.
void	setInitializationScripts(List<Object> value) `AWS::NimbleStudio::StudioComponent.InitializationScripts`.
void	setName(String value) `AWS::NimbleStudio::StudioComponent.Name`.
void	setScriptParameters(IResolvable value) `AWS::NimbleStudio::StudioComponent.ScriptParameters`.
void	setScriptParameters(List<Object> value) `AWS::NimbleStudio::StudioComponent.ScriptParameters`.
void	setStudioId(String value) `AWS::NimbleStudio::StudioComponent.StudioId`.
void	setSubtype(String value) `AWS::NimbleStudio::StudioComponent.Subtype`.
void	setType(String value) `AWS::NimbleStudio::StudioComponent.Type`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStudioComponent

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

CfnStudioComponent

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

CfnStudioComponent

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrStudioComponentId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfiguration

@Stability(value=Stable)
 @Nullable
public Object getConfiguration()

`AWS::NimbleStudio::StudioComponent.Configuration`.

setConfiguration

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

`AWS::NimbleStudio::StudioComponent.Configuration`.

setConfiguration

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

`AWS::NimbleStudio::StudioComponent.Configuration`.

getDescription

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

`AWS::NimbleStudio::StudioComponent.Description`.

setDescription

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

`AWS::NimbleStudio::StudioComponent.Description`.

getEc2SecurityGroupIds

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

`AWS::NimbleStudio::StudioComponent.Ec2SecurityGroupIds`.

setEc2SecurityGroupIds

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

`AWS::NimbleStudio::StudioComponent.Ec2SecurityGroupIds`.

getInitializationScripts

@Stability(value=Stable)
 @Nullable
public Object getInitializationScripts()

`AWS::NimbleStudio::StudioComponent.InitializationScripts`.

setInitializationScripts

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

`AWS::NimbleStudio::StudioComponent.InitializationScripts`.

setInitializationScripts

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

`AWS::NimbleStudio::StudioComponent.InitializationScripts`.

getName

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

`AWS::NimbleStudio::StudioComponent.Name`.

setName

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

`AWS::NimbleStudio::StudioComponent.Name`.

getScriptParameters

@Stability(value=Stable)
 @Nullable
public Object getScriptParameters()

`AWS::NimbleStudio::StudioComponent.ScriptParameters`.

setScriptParameters

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

`AWS::NimbleStudio::StudioComponent.ScriptParameters`.

setScriptParameters

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

`AWS::NimbleStudio::StudioComponent.ScriptParameters`.

getStudioId

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

`AWS::NimbleStudio::StudioComponent.StudioId`.

setStudioId

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

`AWS::NimbleStudio::StudioComponent.StudioId`.

getSubtype

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

`AWS::NimbleStudio::StudioComponent.Subtype`.

setSubtype

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

`AWS::NimbleStudio::StudioComponent.Subtype`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::NimbleStudio::StudioComponent.Tags`.

getType

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

`AWS::NimbleStudio::StudioComponent.Type`.

setType

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

`AWS::NimbleStudio::StudioComponent.Type`.