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.Lightsail.CreateKeyPair

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

Synopsis

data CreateKeyPair = CreateKeyPair' {
- tags :: Maybe [Tag]
- keyPairName :: Text
}
newCreateKeyPair :: Text -> CreateKeyPair
createKeyPair_tags :: Lens' CreateKeyPair (Maybe [Tag])
createKeyPair_keyPairName :: Lens' CreateKeyPair Text
data CreateKeyPairResponse = CreateKeyPairResponse' {
- keyPair :: Maybe KeyPair
- operation :: Maybe Operation
- privateKeyBase64 :: Maybe Text
- publicKeyBase64 :: Maybe Text
- httpStatus :: Int
}
newCreateKeyPairResponse :: Int -> CreateKeyPairResponse
createKeyPairResponse_keyPair :: Lens' CreateKeyPairResponse (Maybe KeyPair)
createKeyPairResponse_operation :: Lens' CreateKeyPairResponse (Maybe Operation)
createKeyPairResponse_privateKeyBase64 :: Lens' CreateKeyPairResponse (Maybe Text)
createKeyPairResponse_publicKeyBase64 :: Lens' CreateKeyPairResponse (Maybe Text)
createKeyPairResponse_httpStatus :: Lens' CreateKeyPairResponse Int

Creating a Request

data CreateKeyPair Source #

See: newCreateKeyPair smart constructor.

Constructors

CreateKeyPair'
Fields tags :: Maybe [Tag] The tag keys and optional values to add to the resource during create. Use the `TagResource` action to tag a resource after it's created. keyPairName :: Text The name for your new key pair.

Instances

Instances details

ToJSON CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods toJSON :: CreateKeyPair -> Value # toEncoding :: CreateKeyPair -> Encoding # toJSONList :: [CreateKeyPair] -> Value # toEncodingList :: [CreateKeyPair] -> Encoding #
ToHeaders CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods toHeaders :: CreateKeyPair -> [Header] #
ToPath CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods toPath :: CreateKeyPair -> ByteString #
ToQuery CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods toQuery :: CreateKeyPair -> QueryString #
AWSRequest CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Associated Types type AWSResponse CreateKeyPair # Methods request :: (Service -> Service) -> CreateKeyPair -> Request CreateKeyPair # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateKeyPair -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateKeyPair))) #
Generic CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Associated Types type Rep CreateKeyPair :: Type -> Type # Methods from :: CreateKeyPair -> Rep CreateKeyPair x # to :: Rep CreateKeyPair x -> CreateKeyPair #
Read CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods readsPrec :: Int -> ReadS CreateKeyPair # readList :: ReadS [CreateKeyPair] # readPrec :: ReadPrec CreateKeyPair # readListPrec :: ReadPrec [CreateKeyPair] #
Show CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods showsPrec :: Int -> CreateKeyPair -> ShowS # show :: CreateKeyPair -> String # showList :: [CreateKeyPair] -> ShowS #
NFData CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods rnf :: CreateKeyPair -> () #
Eq CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods (==) :: CreateKeyPair -> CreateKeyPair -> Bool # (/=) :: CreateKeyPair -> CreateKeyPair -> Bool #
Hashable CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods hashWithSalt :: Int -> CreateKeyPair -> Int # hash :: CreateKeyPair -> Int #
type AWSResponse CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair type AWSResponse CreateKeyPair = CreateKeyPairResponse
type Rep CreateKeyPair Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair type Rep CreateKeyPair = D1 ('MetaData "CreateKeyPair" "Amazonka.Lightsail.CreateKeyPair" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "CreateKeyPair'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "keyPairName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateKeyPair Source #

Arguments

:: Text	`CreateKeyPair`
-> CreateKeyPair

Create a value of CreateKeyPair 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:

CreateKeyPair, createKeyPair_tags - The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

CreateKeyPair, createKeyPair_keyPairName - The name for your new key pair.

Request Lenses

createKeyPair_tags :: Lens' CreateKeyPair (Maybe [Tag]) Source #

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

createKeyPair_keyPairName :: Lens' CreateKeyPair Text Source #

The name for your new key pair.

Destructuring the Response

data CreateKeyPairResponse Source #

See: newCreateKeyPairResponse smart constructor.

Constructors

CreateKeyPairResponse'

Fields

keyPair :: Maybe KeyPair
An array of key-value pairs containing information about the new key pair you just created.
operation :: Maybe Operation
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
privateKeyBase64 :: Maybe Text
A base64-encoded RSA private key.
publicKeyBase64 :: Maybe Text
A base64-encoded public key of the ssh-rsa type.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateKeyPairResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Associated Types type Rep CreateKeyPairResponse :: Type -> Type # Methods from :: CreateKeyPairResponse -> Rep CreateKeyPairResponse x # to :: Rep CreateKeyPairResponse x -> CreateKeyPairResponse #
Read CreateKeyPairResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods readsPrec :: Int -> ReadS CreateKeyPairResponse # readList :: ReadS [CreateKeyPairResponse] # readPrec :: ReadPrec CreateKeyPairResponse # readListPrec :: ReadPrec [CreateKeyPairResponse] #
Show CreateKeyPairResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods showsPrec :: Int -> CreateKeyPairResponse -> ShowS # show :: CreateKeyPairResponse -> String # showList :: [CreateKeyPairResponse] -> ShowS #
NFData CreateKeyPairResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods rnf :: CreateKeyPairResponse -> () #
Eq CreateKeyPairResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair Methods (==) :: CreateKeyPairResponse -> CreateKeyPairResponse -> Bool # (/=) :: CreateKeyPairResponse -> CreateKeyPairResponse -> Bool #
type Rep CreateKeyPairResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateKeyPair type Rep CreateKeyPairResponse = D1 ('MetaData "CreateKeyPairResponse" "Amazonka.Lightsail.CreateKeyPair" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "CreateKeyPairResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyPair)) :: S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operation))) :: (S1 ('MetaSel ('Just "privateKeyBase64") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "publicKeyBase64") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateKeyPairResponse Source #

Arguments

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

Create a value of CreateKeyPairResponse 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:keyPair:CreateKeyPairResponse', createKeyPairResponse_keyPair - An array of key-value pairs containing information about the new key pair you just created.

$sel:operation:CreateKeyPairResponse', createKeyPairResponse_operation - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:privateKeyBase64:CreateKeyPairResponse', createKeyPairResponse_privateKeyBase64 - A base64-encoded RSA private key.

$sel:publicKeyBase64:CreateKeyPairResponse', createKeyPairResponse_publicKeyBase64 - A base64-encoded public key of the ssh-rsa type.

$sel:httpStatus:CreateKeyPairResponse', createKeyPairResponse_httpStatus - The response's http status code.

Response Lenses

createKeyPairResponse_keyPair :: Lens' CreateKeyPairResponse (Maybe KeyPair) Source #

An array of key-value pairs containing information about the new key pair you just created.

createKeyPairResponse_operation :: Lens' CreateKeyPairResponse (Maybe Operation) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createKeyPairResponse_privateKeyBase64 :: Lens' CreateKeyPairResponse (Maybe Text) Source #

A base64-encoded RSA private key.

createKeyPairResponse_publicKeyBase64 :: Lens' CreateKeyPairResponse (Maybe Text) Source #

A base64-encoded public key of the ssh-rsa type.

createKeyPairResponse_httpStatus :: Lens' CreateKeyPairResponse Int Source #

The response's http status code.