libZSservicesZSamazonka-appstreamZSamazonka-appstream
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppStream.CreateStack

Description

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Synopsis

Creating a Request

data CreateStack Source #

See: newCreateStack smart constructor.

Constructors

CreateStack' 

Fields

  • userSettings :: Maybe (NonEmpty UserSetting)

    The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

  • applicationSettings :: Maybe ApplicationSettings

    The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

  • feedbackURL :: Maybe Text

    The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

  • storageConnectors :: Maybe [StorageConnector]

    The storage connectors to enable.

  • accessEndpoints :: Maybe (NonEmpty AccessEndpoint)

    The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

  • displayName :: Maybe Text

    The stack name to display.

  • embedHostDomains :: Maybe (NonEmpty Text)

    The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

  • description :: Maybe Text

    The description to display.

  • tags :: Maybe (HashMap Text Text)

    The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

    If you do not specify a value, the value is set to an empty string.

    Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

    _ . : / = + \ - @

    For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

  • redirectURL :: Maybe Text

    The URL that users are redirected to after their streaming session ends.

  • name :: Text

    The name of the stack.

Instances

Instances details
Eq CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

(==) :: CreateStack -> CreateStack -> Bool #

(/=) :: CreateStack -> CreateStack -> Bool #

Read CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

readsPrec :: Int -> ReadS CreateStack #

readList :: ReadS [CreateStack] #

readPrec :: ReadPrec CreateStack #

readListPrec :: ReadPrec [CreateStack] #

Show CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

showsPrec :: Int -> CreateStack -> ShowS #

show :: CreateStack -> String #

showList :: [CreateStack] -> ShowS #

Generic CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Associated Types

type Rep CreateStack :: Type -> Type #

Methods

from :: CreateStack -> Rep CreateStack x #

to :: Rep CreateStack x -> CreateStack #

NFData CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

rnf :: CreateStack -> () #

Hashable CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

hashWithSalt :: Int -> CreateStack -> Int #

hash :: CreateStack -> Int #

ToJSON CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

toJSON :: CreateStack -> Value #

toEncoding :: CreateStack -> Encoding #

toJSONList :: [CreateStack] -> Value #

toEncodingList :: [CreateStack] -> Encoding #

AWSRequest CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Associated Types

type AWSResponse CreateStack #

Methods

request :: CreateStack -> Request CreateStack #

response :: MonadResource m => Logger -> Service -> Proxy CreateStack -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStack))) #

ToHeaders CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

toHeaders :: CreateStack -> [Header] #

ToPath CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

toPath :: CreateStack -> ByteString #

ToQuery CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

toQuery :: CreateStack -> QueryString #

type Rep CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

type Rep CreateStack = D1 ('MetaData "CreateStack" "Amazonka.AppStream.CreateStack" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "CreateStack'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "userSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty UserSetting))) :*: S1 ('MetaSel ('Just "applicationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplicationSettings))) :*: (S1 ('MetaSel ('Just "feedbackURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "storageConnectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StorageConnector])) :*: S1 ('MetaSel ('Just "accessEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AccessEndpoint)))))) :*: ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "embedHostDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "redirectURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateStack Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

type AWSResponse CreateStack = CreateStackResponse

newCreateStack Source #

Arguments

:: Text

$sel:name:CreateStack'

-> CreateStack 

Create a value of CreateStack 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:userSettings:CreateStack', createStack_userSettings - The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

$sel:applicationSettings:CreateStack', createStack_applicationSettings - The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

$sel:feedbackURL:CreateStack', createStack_feedbackURL - The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

$sel:storageConnectors:CreateStack', createStack_storageConnectors - The storage connectors to enable.

$sel:accessEndpoints:CreateStack', createStack_accessEndpoints - The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

$sel:displayName:CreateStack', createStack_displayName - The stack name to display.

$sel:embedHostDomains:CreateStack', createStack_embedHostDomains - The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

$sel:description:CreateStack', createStack_description - The description to display.

$sel:tags:CreateStack', createStack_tags - The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

$sel:redirectURL:CreateStack', createStack_redirectURL - The URL that users are redirected to after their streaming session ends.

$sel:name:CreateStack', createStack_name - The name of the stack.

Request Lenses

createStack_userSettings :: Lens' CreateStack (Maybe (NonEmpty UserSetting)) Source #

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

createStack_applicationSettings :: Lens' CreateStack (Maybe ApplicationSettings) Source #

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

createStack_feedbackURL :: Lens' CreateStack (Maybe Text) Source #

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

createStack_storageConnectors :: Lens' CreateStack (Maybe [StorageConnector]) Source #

The storage connectors to enable.

createStack_accessEndpoints :: Lens' CreateStack (Maybe (NonEmpty AccessEndpoint)) Source #

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

createStack_displayName :: Lens' CreateStack (Maybe Text) Source #

The stack name to display.

createStack_embedHostDomains :: Lens' CreateStack (Maybe (NonEmpty Text)) Source #

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

createStack_description :: Lens' CreateStack (Maybe Text) Source #

The description to display.

createStack_tags :: Lens' CreateStack (Maybe (HashMap Text Text)) Source #

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

createStack_redirectURL :: Lens' CreateStack (Maybe Text) Source #

The URL that users are redirected to after their streaming session ends.

createStack_name :: Lens' CreateStack Text Source #

The name of the stack.

Destructuring the Response

data CreateStackResponse Source #

See: newCreateStackResponse smart constructor.

Constructors

CreateStackResponse' 

Fields

Instances

Instances details
Eq CreateStackResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

(==) :: CreateStackResponse -> CreateStackResponse -> Bool #

(/=) :: CreateStackResponse -> CreateStackResponse -> Bool #

Read CreateStackResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

readsPrec :: Int -> ReadS CreateStackResponse #

readList :: ReadS [CreateStackResponse] #

readPrec :: ReadPrec CreateStackResponse #

readListPrec :: ReadPrec [CreateStackResponse] #

Show CreateStackResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

showsPrec :: Int -> CreateStackResponse -> ShowS #

show :: CreateStackResponse -> String #

showList :: [CreateStackResponse] -> ShowS #

Generic CreateStackResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Associated Types

type Rep CreateStackResponse :: Type -> Type #

Methods

from :: CreateStackResponse -> Rep CreateStackResponse x #

to :: Rep CreateStackResponse x -> CreateStackResponse #

NFData CreateStackResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

Methods

rnf :: CreateStackResponse -> () #

type Rep CreateStackResponse Source # 
Instance details

Defined in Amazonka.AppStream.CreateStack

type Rep CreateStackResponse = D1 ('MetaData "CreateStackResponse" "Amazonka.AppStream.CreateStack" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "CreateStackResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stack") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Stack)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateStackResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateStackResponse'

-> CreateStackResponse 

Create a value of CreateStackResponse 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:stack:CreateStackResponse', createStackResponse_stack - Information about the stack.

$sel:httpStatus:CreateStackResponse', createStackResponse_httpStatus - The response's http status code.

Response Lenses

createStackResponse_stack :: Lens' CreateStackResponse (Maybe Stack) Source #

Information about the stack.

createStackResponse_httpStatus :: Lens' CreateStackResponse Int Source #

The response's http status code.