Class: Aws::EC2::Types::CreateKeyPairRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateKeyPairRequest data as a hash:

{
  key_name: "String", # required
  dry_run: false,
  key_type: "rsa", # accepts rsa, ed25519
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


7515
7516
7517
7518
7519
7520
7521
7522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7515

class CreateKeyPairRequest < Struct.new(
  :key_name,
  :dry_run,
  :key_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#key_nameString

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

Returns:

  • (String)


7515
7516
7517
7518
7519
7520
7521
7522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7515

class CreateKeyPairRequest < Struct.new(
  :key_name,
  :dry_run,
  :key_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#key_typeString

The type of key pair. Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.

Default: rsa

Returns:

  • (String)


7515
7516
7517
7518
7519
7520
7521
7522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7515

class CreateKeyPairRequest < Struct.new(
  :key_name,
  :dry_run,
  :key_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the new key pair.

Returns:



7515
7516
7517
7518
7519
7520
7521
7522
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7515

class CreateKeyPairRequest < Struct.new(
  :key_name,
  :dry_run,
  :key_type,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end