libZSservicesZSamazonka-lightsailZSamazonka-lightsail
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.Lightsail.CreateKeyPair

Description

Creates an SSH key pair.

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

Synopsis

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
Eq CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Read CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Show CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Generic CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Associated Types

type Rep CreateKeyPair :: Type -> Type #

NFData CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Methods

rnf :: CreateKeyPair -> () #

Hashable CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

ToJSON CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

AWSRequest CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Associated Types

type AWSResponse CreateKeyPair #

ToHeaders CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

ToPath CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

ToQuery CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

type Rep CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

type Rep CreateKeyPair = D1 ('MetaData "CreateKeyPair" "Amazonka.Lightsail.CreateKeyPair" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" '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)))
type AWSResponse CreateKeyPair Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

newCreateKeyPair Source #

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:

$sel:tags: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.

$sel:keyPairName: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

Instances

Instances details
Eq CreateKeyPairResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Read CreateKeyPairResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Show CreateKeyPairResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Generic CreateKeyPairResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Associated Types

type Rep CreateKeyPairResponse :: Type -> Type #

NFData CreateKeyPairResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

Methods

rnf :: CreateKeyPairResponse -> () #

type Rep CreateKeyPairResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateKeyPair

type Rep CreateKeyPairResponse = D1 ('MetaData "CreateKeyPairResponse" "Amazonka.Lightsail.CreateKeyPair" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" '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 "publicKeyBase64") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "privateKeyBase64") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateKeyPairResponse Source #

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:publicKeyBase64:CreateKeyPairResponse', createKeyPairResponse_publicKeyBase64 - A base64-encoded public key of the ssh-rsa type.

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

$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_publicKeyBase64 :: Lens' CreateKeyPairResponse (Maybe Text) Source #

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