Class CfnStudio
The AWS::NimbleStudio::Studio
resource creates a new studio resource. In , all other resources are contained in a studio.
Inherited Members
Namespace: Amazon.CDK.AWS.NimbleStudio
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStudio : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStudio
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html
CloudformationResource: AWS::NimbleStudio::Studio
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.NimbleStudio;
var cfnStudio = new CfnStudio(this, "MyCfnStudio", new CfnStudioProps {
AdminRoleArn = "adminRoleArn",
DisplayName = "displayName",
StudioName = "studioName",
UserRoleArn = "userRoleArn",
// the properties below are optional
StudioEncryptionConfiguration = new StudioEncryptionConfigurationProperty {
KeyType = "keyType",
// the properties below are optional
KeyArn = "keyArn"
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
Synopsis
Constructors
CfnStudio(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStudio(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnStudio(Construct, String, ICfnStudioProps) |
Properties
AdminRoleArn | The IAM role that studio admins assume when logging in to the Nimble Studio portal. |
AttrHomeRegion | The AWS Region where the studio resource is located. |
AttrSsoClientId | The IAM Identity Center application client ID that is used to integrate with IAM Identity Center , which enables IAM Identity Center users to log into the portal. |
AttrStudioId | The unique identifier for the studio resource. |
AttrStudioUrl | The unique identifier for the studio resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DisplayName | A friendly name for the studio. |
StudioEncryptionConfiguration | Configuration of the encryption method that is used for the studio. |
StudioName | The name of the studio, as included in the URL when accessing it in the Nimble Studio portal. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
UserRoleArn | The IAM role that studio users assume when logging in to the Nimble Studio portal. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStudio(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStudio(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStudio(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStudio(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnStudio(Construct, String, ICfnStudioProps)
public CfnStudio(Construct scope, string id, ICfnStudioProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnStudioProps
Resource properties.
Properties
AdminRoleArn
The IAM role that studio admins assume when logging in to the Nimble Studio portal.
public virtual string AdminRoleArn { get; set; }
Property Value
System.String
AttrHomeRegion
The AWS Region where the studio resource is located.
public virtual string AttrHomeRegion { get; }
Property Value
System.String
Remarks
For example, us-west-2
.
CloudformationAttribute: HomeRegion
AttrSsoClientId
The IAM Identity Center application client ID that is used to integrate with IAM Identity Center , which enables IAM Identity Center users to log into the portal.
public virtual string AttrSsoClientId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SsoClientId
AttrStudioId
The unique identifier for the studio resource.
public virtual string AttrStudioId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: StudioId
AttrStudioUrl
The unique identifier for the studio resource.
public virtual string AttrStudioUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: StudioUrl
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DisplayName
A friendly name for the studio.
public virtual string DisplayName { get; set; }
Property Value
System.String
StudioEncryptionConfiguration
Configuration of the encryption method that is used for the studio.
public virtual object StudioEncryptionConfiguration { get; set; }
Property Value
System.Object
StudioName
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
public virtual string StudioName { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
UserRoleArn
The IAM role that studio users assume when logging in to the Nimble Studio portal.
public virtual string UserRoleArn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>