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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a studio component resource.

Synopsis

Creating a Request

data CreateStudioComponent Source #

See: newCreateStudioComponent smart constructor.

Constructors

CreateStudioComponent'

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.
configuration :: Maybe StudioComponentConfiguration
The configuration of the studio component, based on component type.
description :: Maybe (Sensitive Text)
The description.
ec2SecurityGroupIds :: Maybe [Text]
The EC2 security groups that control access to the studio component.
initializationScripts :: Maybe [StudioComponentInitializationScript]
Initialization scripts for studio components.
runtimeRoleArn :: Maybe Text
An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
scriptParameters :: Maybe (Sensitive [ScriptParameterKeyValue])
Parameters for the studio component scripts.
secureInitializationRoleArn :: Maybe Text
An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
subtype :: Maybe StudioComponentSubtype
The specific subtype of a studio component.
tags :: Maybe (HashMap Text Text)
A collection of labels, in the form of key-value pairs, that apply to this resource.
name :: Sensitive Text
The name for the studio component.
studioId :: Text
The studio ID.
type' :: StudioComponentType
The type of the studio component.

Instances

Instances details

ToJSON CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Methods toJSON :: CreateStudioComponent -> Value # toEncoding :: CreateStudioComponent -> Encoding # toJSONList :: [CreateStudioComponent] -> Value # toEncodingList :: [CreateStudioComponent] -> Encoding #
ToHeaders CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Methods toHeaders :: CreateStudioComponent -> [Header] #
ToPath CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Methods toPath :: CreateStudioComponent -> ByteString #
ToQuery CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Methods toQuery :: CreateStudioComponent -> QueryString #
AWSRequest CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Associated Types type AWSResponse CreateStudioComponent # Methods request :: (Service -> Service) -> CreateStudioComponent -> Request CreateStudioComponent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateStudioComponent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStudioComponent))) #
Generic CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Associated Types type Rep CreateStudioComponent :: Type -> Type # Methods from :: CreateStudioComponent -> Rep CreateStudioComponent x # to :: Rep CreateStudioComponent x -> CreateStudioComponent #
Show CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Methods showsPrec :: Int -> CreateStudioComponent -> ShowS # show :: CreateStudioComponent -> String # showList :: [CreateStudioComponent] -> ShowS #
NFData CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Methods rnf :: CreateStudioComponent -> () #
Eq CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Methods (==) :: CreateStudioComponent -> CreateStudioComponent -> Bool # (/=) :: CreateStudioComponent -> CreateStudioComponent -> Bool #
Hashable CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent Methods hashWithSalt :: Int -> CreateStudioComponent -> Int # hash :: CreateStudioComponent -> Int #
type AWSResponse CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent type AWSResponse CreateStudioComponent = CreateStudioComponentResponse
type Rep CreateStudioComponent Source #
Instance details Defined in Amazonka.Nimble.CreateStudioComponent type Rep CreateStudioComponent = D1 ('MetaData "CreateStudioComponent" "Amazonka.Nimble.CreateStudioComponent" "amazonka-nimble-2.0-GaSxVwPXmRh7tifR7EIdTs" 'False) (C1 ('MetaCons "CreateStudioComponent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StudioComponentConfiguration)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "ec2SecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "initializationScripts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StudioComponentInitializationScript])) :: S1 ('MetaSel ('Just "runtimeRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "scriptParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive [ScriptParameterKeyValue]))) :: (S1 ('MetaSel ('Just "secureInitializationRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "subtype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StudioComponentSubtype)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :: (S1 ('MetaSel ('Just "studioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StudioComponentType))))))

newCreateStudioComponent Source #

Arguments

:: Text	`CreateStudioComponent`
-> Text	`CreateStudioComponent`
-> StudioComponentType	`CreateStudioComponent`
-> CreateStudioComponent

Create a value of CreateStudioComponent 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:CreateStudioComponent', createStudioComponent_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.

CreateStudioComponent, createStudioComponent_configuration - The configuration of the studio component, based on component type.

CreateStudioComponent, createStudioComponent_description - The description.

CreateStudioComponent, createStudioComponent_ec2SecurityGroupIds - The EC2 security groups that control access to the studio component.

CreateStudioComponent, createStudioComponent_initializationScripts - Initialization scripts for studio components.

CreateStudioComponent, createStudioComponent_runtimeRoleArn - An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

CreateStudioComponent, createStudioComponent_scriptParameters - Parameters for the studio component scripts.

CreateStudioComponent, createStudioComponent_secureInitializationRoleArn - An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

CreateStudioComponent, createStudioComponent_subtype - The specific subtype of a studio component.

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

CreateStudioComponent, createStudioComponent_name - The name for the studio component.

CreateStudioComponent, createStudioComponent_studioId - The studio ID.

CreateStudioComponent, createStudioComponent_type - The type of the studio component.

Request Lenses

createStudioComponent_clientToken :: Lens' CreateStudioComponent (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.

createStudioComponent_configuration :: Lens' CreateStudioComponent (Maybe StudioComponentConfiguration) Source #

The configuration of the studio component, based on component type.

createStudioComponent_description :: Lens' CreateStudioComponent (Maybe Text) Source #

The description.

createStudioComponent_ec2SecurityGroupIds :: Lens' CreateStudioComponent (Maybe [Text]) Source #

The EC2 security groups that control access to the studio component.

createStudioComponent_initializationScripts :: Lens' CreateStudioComponent (Maybe [StudioComponentInitializationScript]) Source #

Initialization scripts for studio components.

createStudioComponent_runtimeRoleArn :: Lens' CreateStudioComponent (Maybe Text) Source #

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

createStudioComponent_scriptParameters :: Lens' CreateStudioComponent (Maybe [ScriptParameterKeyValue]) Source #

Parameters for the studio component scripts.

createStudioComponent_secureInitializationRoleArn :: Lens' CreateStudioComponent (Maybe Text) Source #

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

createStudioComponent_subtype :: Lens' CreateStudioComponent (Maybe StudioComponentSubtype) Source #

The specific subtype of a studio component.

createStudioComponent_tags :: Lens' CreateStudioComponent (Maybe (HashMap Text Text)) Source #

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

createStudioComponent_name :: Lens' CreateStudioComponent Text Source #

The name for the studio component.

createStudioComponent_studioId :: Lens' CreateStudioComponent Text Source #

The studio ID.

createStudioComponent_type :: Lens' CreateStudioComponent StudioComponentType Source #

The type of the studio component.

Destructuring the Response

data CreateStudioComponentResponse Source #

See: newCreateStudioComponentResponse smart constructor.

Constructors

CreateStudioComponentResponse'
Fields studioComponent :: Maybe StudioComponent Information about the studio component. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateStudioComponentResponse Source #

Arguments

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

Create a value of CreateStudioComponentResponse 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:studioComponent:CreateStudioComponentResponse', createStudioComponentResponse_studioComponent - Information about the studio component.

$sel:httpStatus:CreateStudioComponentResponse', createStudioComponentResponse_httpStatus - The response's http status code.

Response Lenses

createStudioComponentResponse_studioComponent :: Lens' CreateStudioComponentResponse (Maybe StudioComponent) Source #

Information about the studio component.

createStudioComponentResponse_httpStatus :: Lens' CreateStudioComponentResponse Int Source #

The response's http status code.