Class CfnStudio

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnStudio

Implements

IInspectable

IStudioRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.NimbleStudio

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnStudio : CfnResource, IInspectable, IStudioRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnStudio Inherits CfnResource Implements IInspectable, IStudioRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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(Construct, string, ICfnStudioProps)

Create a new AWS::NimbleStudio::Studio.

Properties

AdminRoleArn	<p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>.
AttrHomeRegion	<p>The Amazon Web Services Region where the studio resource is located.</p>.
AttrSsoClientId	<p>The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.</p>.
AttrStudioId	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.
AttrStudioUrl	<p>The address of the web page for the studio.</p>.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.
DisplayName	<p>A friendly name for the studio.</p>.
StudioEncryptionConfiguration	<p>Configuration of the encryption method that is used for the studio.</p>.
StudioName	<p>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</p>.
StudioRef	A reference to a Studio resource.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.
UserRoleArn	<p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>.

Methods

ArnForStudio(IStudioRef)	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.
FromStudioId(Construct, string, string)	Creates a new IStudioRef from a studioId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnStudio(object)	Checks whether the given object is a CfnStudio.
RenderProperties(IDictionary<string, object>)	http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.

Constructors

CfnStudio(Construct, string, ICfnStudioProps)

Create a new AWS::NimbleStudio::Studio.

public CfnStudio(Construct scope, string id, ICfnStudioProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnStudioProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

Properties

AdminRoleArn

<p>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</p>.

public virtual string AdminRoleArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

AttrHomeRegion

<p>The Amazon Web Services Region where the studio resource is located.</p>.

public virtual string AttrHomeRegion { get; }

Property Value

string

Remarks

CloudformationAttribute: HomeRegion

AttrSsoClientId

<p>The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.</p>.

public virtual string AttrSsoClientId { get; }

Property Value

string

Remarks

CloudformationAttribute: SsoClientId

AttrStudioId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.

public virtual string AttrStudioId { get; }

Property Value

string

Remarks

CloudformationAttribute: StudioId

AttrStudioUrl

<p>The address of the web page for the studio.</p>.

public virtual string AttrStudioUrl { get; }

Property Value

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

CfnProperties

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

DisplayName

<p>A friendly name for the studio.</p>.

public virtual string DisplayName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

StudioEncryptionConfiguration

<p>Configuration of the encryption method that is used for the studio.</p>.

public virtual object? StudioEncryptionConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnStudio.IStudioEncryptionConfigurationProperty

StudioName

<p>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</p>.

public virtual string StudioName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

StudioRef

A reference to a Studio resource.

public virtual IStudioReference StudioRef { get; }

Property Value

IStudioReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

TagsRaw

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

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" }
                 }
             });

UserRoleArn

<p>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</p>.

public virtual string UserRoleArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

Methods

ArnForStudio(IStudioRef)

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.

public static string ArnForStudio(IStudioRef resource)

Parameters

resource IStudioRef

Returns

string

Remarks

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" }
                 }
             });

FromStudioId(Construct, string, string)

Creates a new IStudioRef from a studioId.

public static IStudioRef FromStudioId(Construct scope, string id, string studioId)

Parameters

scope Construct

id string

studioId string

Returns

IStudioRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

IsCfnStudio(object)

Checks whether the given object is a CfnStudio.

public static bool IsCfnStudio(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-studio.html

CloudformationResource: AWS::NimbleStudio::Studio

ExampleMetadata: fixture=_generated

Implements

IInspectable

IStudioRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable