software.amazon.awscdk.services.nimblestudio

Class CfnStudio

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

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.071Z")
 @Stability(value=Stable)
public class CfnStudio
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NimbleStudio::Studio`.

The AWS::NimbleStudio::Studio resource creates a new studio resource. In , all other resources are contained in a studio.

When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the portal. The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly. The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.

You can optionally specify an AWS Key Management Service key in the StudioEncryptionConfiguration. In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an AWS Key Management Service key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS Key Management Service key when calling CreateStudio to encrypt this data using a key that you own and manage. When providing an AWS Key Management Service key during studio creation, creates AWS Key Management Service grants in your account to provide your studio user and admin roles access to these AWS Key Management Service keys. If you delete this grant, the studio will no longer be accessible to your portal users. If you delete the studio AWS Key Management Service key, your studio will no longer be accessible.

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.*;
 CfnStudio cfnStudio = CfnStudio.Builder.create(this, "MyCfnStudio")
         .adminRoleArn("adminRoleArn")
         .displayName("displayName")
         .studioName("studioName")
         .userRoleArn("userRoleArn")
         // the properties below are optional
         .studioEncryptionConfiguration(StudioEncryptionConfigurationProperty.builder()
                 .keyType("keyType")
                 // the properties below are optional
                 .keyArn("keyArn")
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStudio.Builder A fluent builder for CfnStudio.
static interface	CfnStudio.StudioEncryptionConfigurationProperty Configuration of the encryption method that is used for the studio.

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
	CfnStudio(software.constructs.Construct scope, String id, CfnStudioProps props) Create a new `AWS::NimbleStudio::Studio`.
protected	CfnStudio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStudio(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAdminRoleArn() The IAM role that studio admins assume when logging in to the Nimble Studio portal.
String	getAttrHomeRegion() The AWS Region where the studio resource is located.
String	getAttrSsoClientId() The AWS SSO application client ID that is used to integrate with AWS SSO , which enables AWS SSO users to log into the portal.
String	getAttrStudioId() The unique identifier for the studio resource.
String	getAttrStudioUrl() The unique identifier for the studio resource.
protected Map<String,Object>	getCfnProperties()
String	getDisplayName() A friendly name for the studio.
Object	getStudioEncryptionConfiguration() Configuration of the encryption method that is used for the studio.
String	getStudioName() The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getUserRoleArn() The IAM role that studio users assume when logging in to the Nimble Studio portal.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdminRoleArn(String value) The IAM role that studio admins assume when logging in to the Nimble Studio portal.
void	setDisplayName(String value) A friendly name for the studio.
void	setStudioEncryptionConfiguration(CfnStudio.StudioEncryptionConfigurationProperty value) Configuration of the encryption method that is used for the studio.
void	setStudioEncryptionConfiguration(IResolvable value) Configuration of the encryption method that is used for the studio.
void	setStudioName(String value) The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
void	setUserRoleArn(String value) The IAM role that studio users assume when logging in to the Nimble Studio portal.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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

CfnStudio

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

CfnStudio

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

CfnStudio

@Stability(value=Stable)
public CfnStudio(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnStudioProps props)

Create a new `AWS::NimbleStudio::Studio`.

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.

getAttrHomeRegion

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

The AWS Region where the studio resource is located.

For example, us-west-2 .

getAttrSsoClientId

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

The AWS SSO application client ID that is used to integrate with AWS SSO , which enables AWS SSO users to log into the portal.

getAttrStudioId

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

The unique identifier for the studio resource.

getAttrStudioUrl

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

The unique identifier for the studio resource.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

For more information, see Tag .

getAdminRoleArn

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

The IAM role that studio admins assume when logging in to the Nimble Studio portal.

setAdminRoleArn

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

The IAM role that studio admins assume when logging in to the Nimble Studio portal.

getDisplayName

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

A friendly name for the studio.

setDisplayName

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

A friendly name for the studio.

getStudioName

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

The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

setStudioName

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

The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

getUserRoleArn

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

The IAM role that studio users assume when logging in to the Nimble Studio portal.

setUserRoleArn

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

The IAM role that studio users assume when logging in to the Nimble Studio portal.

getStudioEncryptionConfiguration

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

Configuration of the encryption method that is used for the studio.

setStudioEncryptionConfiguration

@Stability(value=Stable)
public void setStudioEncryptionConfiguration(@Nullable
                                                                      CfnStudio.StudioEncryptionConfigurationProperty value)

Configuration of the encryption method that is used for the studio.

setStudioEncryptionConfiguration

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

Configuration of the encryption method that is used for the studio.