Package software.amazon.awscdk.services.nimblestudio

Interface CfnStudioProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStudioProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:11.468Z")
@Stability(Stable)
public interface CfnStudioProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStudio.

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.*;
 CfnStudioProps cfnStudioProps = CfnStudioProps.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStudioProps.Builder	A builder for CfnStudioProps
static final class	CfnStudioProps.Jsii$Proxy	An implementation for CfnStudioProps

Method Summary

Modifier and Type	Method	Description
static CfnStudioProps.Builder	builder()
String	getAdminRoleArn()	The IAM role that studio admins assume when logging in to the Nimble Studio portal.
String	getDisplayName()	A friendly name for the studio.
default 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.
default Map<String,String>	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdminRoleArn

@Stability(Stable)
@NotNull
String getAdminRoleArn()

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

See Also:

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

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

A friendly name for the studio.

See Also:

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

getStudioName

@Stability(Stable)
@NotNull
String getStudioName()

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

See Also:

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

getUserRoleArn

@Stability(Stable)
@NotNull
String getUserRoleArn()

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

See Also:

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

getStudioEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getStudioEncryptionConfiguration()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnStudioProps.Builder builder()

Returns:

a CfnStudioProps.Builder of CfnStudioProps