View a markdown version of this page

AWS::Lightsail::KeyPair - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Lightsail::KeyPair

Describes an SSH key pair.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Lightsail::KeyPair",
  "Properties" : {
      "KeyPairName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Lightsail::KeyPair
Properties:
  KeyPairName: String
  Tags: 
    - Tag

Properties

KeyPairName

The friendly name of the SSH key pair.

Required: Yes

Type: String

Pattern: ^\w[\w\-]*\w$

Update requires: Replacement

Tags

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreatedAt

The timestamp when the key pair was created (1479816991.349).

Fingerprint

The RSA fingerprint of the key pair.

KeyPairArn

The Amazon Resource Name (ARN) of the key pair (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

ResourceType

The resource type (usually KeyPair).

SupportCode

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.