libZSservicesZSamazonka-opsworksZSamazonka-opsworks
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.OpsWorks.GrantAccess

Description

This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

Synopsis

Creating a Request

data GrantAccess Source #

See: newGrantAccess smart constructor.

Constructors

GrantAccess' 

Fields

  • validForInMinutes :: Maybe Natural

    The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

  • instanceId :: Text

    The instance's AWS OpsWorks Stacks ID.

Instances

Instances details
Eq GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

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

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

Read GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

readsPrec :: Int -> ReadS GrantAccess #

readList :: ReadS [GrantAccess] #

readPrec :: ReadPrec GrantAccess #

readListPrec :: ReadPrec [GrantAccess] #

Show GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

showsPrec :: Int -> GrantAccess -> ShowS #

show :: GrantAccess -> String #

showList :: [GrantAccess] -> ShowS #

Generic GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Associated Types

type Rep GrantAccess :: Type -> Type #

Methods

from :: GrantAccess -> Rep GrantAccess x #

to :: Rep GrantAccess x -> GrantAccess #

NFData GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

rnf :: GrantAccess -> () #

Hashable GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

hashWithSalt :: Int -> GrantAccess -> Int #

hash :: GrantAccess -> Int #

ToJSON GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

toJSON :: GrantAccess -> Value #

toEncoding :: GrantAccess -> Encoding #

toJSONList :: [GrantAccess] -> Value #

toEncodingList :: [GrantAccess] -> Encoding #

AWSRequest GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Associated Types

type AWSResponse GrantAccess #

Methods

request :: GrantAccess -> Request GrantAccess #

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

ToHeaders GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

toHeaders :: GrantAccess -> [Header] #

ToPath GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

toPath :: GrantAccess -> ByteString #

ToQuery GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

toQuery :: GrantAccess -> QueryString #

type Rep GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

type Rep GrantAccess = D1 ('MetaData "GrantAccess" "Amazonka.OpsWorks.GrantAccess" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "GrantAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "validForInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GrantAccess Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

type AWSResponse GrantAccess = GrantAccessResponse

newGrantAccess Source #

Arguments

:: Text

$sel:instanceId:GrantAccess'

-> GrantAccess 

Create a value of GrantAccess 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:validForInMinutes:GrantAccess', grantAccess_validForInMinutes - The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

$sel:instanceId:GrantAccess', grantAccess_instanceId - The instance's AWS OpsWorks Stacks ID.

Request Lenses

grantAccess_validForInMinutes :: Lens' GrantAccess (Maybe Natural) Source #

The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

grantAccess_instanceId :: Lens' GrantAccess Text Source #

The instance's AWS OpsWorks Stacks ID.

Destructuring the Response

data GrantAccessResponse Source #

Contains the response to a GrantAccess request.

See: newGrantAccessResponse smart constructor.

Constructors

GrantAccessResponse' 

Fields

Instances

Instances details
Eq GrantAccessResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

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

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

Read GrantAccessResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

readsPrec :: Int -> ReadS GrantAccessResponse #

readList :: ReadS [GrantAccessResponse] #

readPrec :: ReadPrec GrantAccessResponse #

readListPrec :: ReadPrec [GrantAccessResponse] #

Show GrantAccessResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

showsPrec :: Int -> GrantAccessResponse -> ShowS #

show :: GrantAccessResponse -> String #

showList :: [GrantAccessResponse] -> ShowS #

Generic GrantAccessResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Associated Types

type Rep GrantAccessResponse :: Type -> Type #

Methods

from :: GrantAccessResponse -> Rep GrantAccessResponse x #

to :: Rep GrantAccessResponse x -> GrantAccessResponse #

NFData GrantAccessResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

Methods

rnf :: GrantAccessResponse -> () #

type Rep GrantAccessResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.GrantAccess

type Rep GrantAccessResponse = D1 ('MetaData "GrantAccessResponse" "Amazonka.OpsWorks.GrantAccess" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "GrantAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "temporaryCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemporaryCredential)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGrantAccessResponse Source #

Arguments

:: Int

$sel:httpStatus:GrantAccessResponse'

-> GrantAccessResponse 

Create a value of GrantAccessResponse 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:temporaryCredential:GrantAccessResponse', grantAccessResponse_temporaryCredential - A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.

$sel:httpStatus:GrantAccessResponse', grantAccessResponse_httpStatus - The response's http status code.

Response Lenses

grantAccessResponse_temporaryCredential :: Lens' GrantAccessResponse (Maybe TemporaryCredential) Source #

A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.

grantAccessResponse_httpStatus :: Lens' GrantAccessResponse Int Source #

The response's http status code.