Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Nimble.CreateStudio

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create a new 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 Nimble Studio 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 may optionally specify a KMS key in the StudioEncryptionConfiguration.

In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.

When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.

If you delete this grant, the studio will no longer be accessible to your portal users.

If you delete the studio KMS key, your studio will no longer be accessible.

Synopsis

data CreateStudio = CreateStudio' {
- clientToken :: Maybe Text
- studioEncryptionConfiguration :: Maybe StudioEncryptionConfiguration
- tags :: Maybe (HashMap Text Text)
- adminRoleArn :: Text
- displayName :: Sensitive Text
- studioName :: Text
- userRoleArn :: Text
}
newCreateStudio :: Text -> Text -> Text -> Text -> CreateStudio
createStudio_clientToken :: Lens' CreateStudio (Maybe Text)
createStudio_studioEncryptionConfiguration :: Lens' CreateStudio (Maybe StudioEncryptionConfiguration)
createStudio_tags :: Lens' CreateStudio (Maybe (HashMap Text Text))
createStudio_adminRoleArn :: Lens' CreateStudio Text
createStudio_displayName :: Lens' CreateStudio Text
createStudio_studioName :: Lens' CreateStudio Text
createStudio_userRoleArn :: Lens' CreateStudio Text
data CreateStudioResponse = CreateStudioResponse' {
- studio :: Maybe Studio
- httpStatus :: Int
}
newCreateStudioResponse :: Int -> CreateStudioResponse
createStudioResponse_studio :: Lens' CreateStudioResponse (Maybe Studio)
createStudioResponse_httpStatus :: Lens' CreateStudioResponse Int

Creating a Request

data CreateStudio Source #

See: newCreateStudio smart constructor.

Constructors

CreateStudio'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
studioEncryptionConfiguration :: Maybe StudioEncryptionConfiguration
The studio encryption configuration.
tags :: Maybe (HashMap Text Text)
A collection of labels, in the form of key-value pairs, that apply to this resource.
adminRoleArn :: Text
The IAM role that studio admins will assume when logging in to the Nimble Studio portal.
displayName :: Sensitive Text
A friendly name for the studio.
studioName :: Text
The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
userRoleArn :: Text
The IAM role that studio users will assume when logging in to the Nimble Studio portal.

Instances

Instances details

ToJSON CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods toJSON :: CreateStudio -> Value # toEncoding :: CreateStudio -> Encoding # toJSONList :: [CreateStudio] -> Value # toEncodingList :: [CreateStudio] -> Encoding #
ToHeaders CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods toHeaders :: CreateStudio -> [Header] #
ToPath CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods toPath :: CreateStudio -> ByteString #
ToQuery CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods toQuery :: CreateStudio -> QueryString #
AWSRequest CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Associated Types type AWSResponse CreateStudio # Methods request :: (Service -> Service) -> CreateStudio -> Request CreateStudio # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateStudio -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStudio))) #
Generic CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Associated Types type Rep CreateStudio :: Type -> Type # Methods from :: CreateStudio -> Rep CreateStudio x # to :: Rep CreateStudio x -> CreateStudio #
Show CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods showsPrec :: Int -> CreateStudio -> ShowS # show :: CreateStudio -> String # showList :: [CreateStudio] -> ShowS #
NFData CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods rnf :: CreateStudio -> () #
Eq CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods (==) :: CreateStudio -> CreateStudio -> Bool # (/=) :: CreateStudio -> CreateStudio -> Bool #
Hashable CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods hashWithSalt :: Int -> CreateStudio -> Int # hash :: CreateStudio -> Int #
type AWSResponse CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio type AWSResponse CreateStudio = CreateStudioResponse
type Rep CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio type Rep CreateStudio = D1 ('MetaData "CreateStudio" "Amazonka.Nimble.CreateStudio" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "CreateStudio'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "studioEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StudioEncryptionConfiguration)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "adminRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :: (S1 ('MetaSel ('Just "studioName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateStudio Source #

Arguments

:: Text	`CreateStudio`
-> Text	`CreateStudio`
-> Text	`CreateStudio`
-> Text	`CreateStudio`
-> CreateStudio

Create a value of CreateStudio with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateStudio', createStudio_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

CreateStudio, createStudio_studioEncryptionConfiguration - The studio encryption configuration.

CreateStudio, createStudio_tags - A collection of labels, in the form of key-value pairs, that apply to this resource.

CreateStudio, createStudio_adminRoleArn - The IAM role that studio admins will assume when logging in to the Nimble Studio portal.

CreateStudio, createStudio_displayName - A friendly name for the studio.

CreateStudio, createStudio_studioName - The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

CreateStudio, createStudio_userRoleArn - The IAM role that studio users will assume when logging in to the Nimble Studio portal.

Request Lenses

createStudio_clientToken :: Lens' CreateStudio (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

createStudio_studioEncryptionConfiguration :: Lens' CreateStudio (Maybe StudioEncryptionConfiguration) Source #

The studio encryption configuration.

createStudio_tags :: Lens' CreateStudio (Maybe (HashMap Text Text)) Source #

A collection of labels, in the form of key-value pairs, that apply to this resource.

createStudio_adminRoleArn :: Lens' CreateStudio Text Source #

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

createStudio_displayName :: Lens' CreateStudio Text Source #

A friendly name for the studio.

createStudio_studioName :: Lens' CreateStudio Text Source #

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

createStudio_userRoleArn :: Lens' CreateStudio Text Source #

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

Destructuring the Response

data CreateStudioResponse Source #

See: newCreateStudioResponse smart constructor.

Constructors

CreateStudioResponse'
Fields studio :: Maybe Studio Information about a studio. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Associated Types type Rep CreateStudioResponse :: Type -> Type # Methods from :: CreateStudioResponse -> Rep CreateStudioResponse x # to :: Rep CreateStudioResponse x -> CreateStudioResponse #
Show CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods showsPrec :: Int -> CreateStudioResponse -> ShowS # show :: CreateStudioResponse -> String # showList :: [CreateStudioResponse] -> ShowS #
NFData CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods rnf :: CreateStudioResponse -> () #
Eq CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods (==) :: CreateStudioResponse -> CreateStudioResponse -> Bool # (/=) :: CreateStudioResponse -> CreateStudioResponse -> Bool #
type Rep CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio type Rep CreateStudioResponse = D1 ('MetaData "CreateStudioResponse" "Amazonka.Nimble.CreateStudio" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "CreateStudioResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "studio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Studio)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateStudioResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateStudioResponse'`
-> CreateStudioResponse

Create a value of CreateStudioResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:studio:CreateStudioResponse', createStudioResponse_studio - Information about a studio.

$sel:httpStatus:CreateStudioResponse', createStudioResponse_httpStatus - The response's http status code.

Response Lenses

createStudioResponse_studio :: Lens' CreateStudioResponse (Maybe Studio) Source #

Information about a studio.

createStudioResponse_httpStatus :: Lens' CreateStudioResponse Int Source #

The response's http status code.