Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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' {
- studioEncryptionConfiguration :: Maybe StudioEncryptionConfiguration
- clientToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- displayName :: Text
- studioName :: Text
- userRoleArn :: Text
- adminRoleArn :: Text
}
newCreateStudio :: Text -> Text -> Text -> Text -> CreateStudio
createStudio_studioEncryptionConfiguration :: Lens' CreateStudio (Maybe StudioEncryptionConfiguration)
createStudio_clientToken :: Lens' CreateStudio (Maybe Text)
createStudio_tags :: Lens' CreateStudio (Maybe (HashMap Text Text))
createStudio_displayName :: Lens' CreateStudio Text
createStudio_studioName :: Lens' CreateStudio Text
createStudio_userRoleArn :: Lens' CreateStudio Text
createStudio_adminRoleArn :: 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 #

A collection of studio resources.

See: newCreateStudio smart constructor.

Constructors

CreateStudio'

Fields

studioEncryptionConfiguration :: Maybe StudioEncryptionConfiguration
The studio encryption configuration.
clientToken :: Maybe Text
To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.
tags :: Maybe (HashMap Text Text)
A collection of labels, in the form of key:value pairs, that apply to this resource.
displayName :: 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.
adminRoleArn :: Text
The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

Instances

Instances details

Eq CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods (==) :: CreateStudio -> CreateStudio -> Bool # (/=) :: CreateStudio -> CreateStudio -> Bool #
Read CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods readsPrec :: Int -> ReadS CreateStudio # readList :: ReadS [CreateStudio] # readPrec :: ReadPrec CreateStudio # readListPrec :: ReadPrec [CreateStudio] #
Show CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods showsPrec :: Int -> CreateStudio -> ShowS # show :: CreateStudio -> String # showList :: [CreateStudio] -> ShowS #
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 #
NFData CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods rnf :: CreateStudio -> () #
Hashable CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods hashWithSalt :: Int -> CreateStudio -> Int # hash :: CreateStudio -> Int #
ToJSON CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods toJSON :: CreateStudio -> Value # toEncoding :: CreateStudio -> Encoding # toJSONList :: [CreateStudio] -> Value # toEncodingList :: [CreateStudio] -> Encoding #
AWSRequest CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Associated Types type AWSResponse CreateStudio # Methods request :: CreateStudio -> Request CreateStudio # response :: MonadResource m => Logger -> Service -> Proxy CreateStudio -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStudio))) #
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 #
type Rep CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio type Rep CreateStudio = D1 ('MetaData "CreateStudio" "Amazonka.Nimble.CreateStudio" "libZSservicesZSamazonka-nimbleZSamazonka-nimble" 'False) (C1 ('MetaCons "CreateStudio'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "studioEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StudioEncryptionConfiguration)) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "studioName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "userRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "adminRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateStudio Source #
Instance details Defined in Amazonka.Nimble.CreateStudio type AWSResponse CreateStudio = CreateStudioResponse

newCreateStudio Source #

Arguments

:: Text	`$sel:displayName:CreateStudio'`
-> Text	`$sel:studioName:CreateStudio'`
-> Text	`$sel:userRoleArn:CreateStudio'`
-> Text	`$sel:adminRoleArn: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:studioEncryptionConfiguration:CreateStudio', createStudio_studioEncryptionConfiguration - The studio encryption configuration.

$sel:clientToken:CreateStudio', createStudio_clientToken - To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

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

$sel:displayName:CreateStudio', createStudio_displayName - A friendly name for the studio.

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

$sel:userRoleArn:CreateStudio', createStudio_userRoleArn - The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

$sel:adminRoleArn:CreateStudio', createStudio_adminRoleArn - The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

Request Lenses

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

The studio encryption configuration.

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

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

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

createStudio_adminRoleArn :: Lens' CreateStudio Text Source #

The IAM role that Studio Admins 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

Eq CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods (==) :: CreateStudioResponse -> CreateStudioResponse -> Bool # (/=) :: CreateStudioResponse -> CreateStudioResponse -> Bool #
Read CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods readsPrec :: Int -> ReadS CreateStudioResponse # readList :: ReadS [CreateStudioResponse] # readPrec :: ReadPrec CreateStudioResponse # readListPrec :: ReadPrec [CreateStudioResponse] #
Show CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods showsPrec :: Int -> CreateStudioResponse -> ShowS # show :: CreateStudioResponse -> String # showList :: [CreateStudioResponse] -> ShowS #
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 #
NFData CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio Methods rnf :: CreateStudioResponse -> () #
type Rep CreateStudioResponse Source #
Instance details Defined in Amazonka.Nimble.CreateStudio type Rep CreateStudioResponse = D1 ('MetaData "CreateStudioResponse" "Amazonka.Nimble.CreateStudio" "libZSservicesZSamazonka-nimbleZSamazonka-nimble" '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.