Class: AWSCDK::EC2::KeyPair

Inherits:
Resource
  • Object
show all
Includes:
IKeyPair
Defined in:
ec2/key_pair.rb

Overview

An EC2 Key Pair.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ KeyPair

Returns a new instance of KeyPair.

Parameters:



12
13
14
15
16
17
18
 
# File 'ec2/key_pair.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::KeyPairProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLktleVBhaXJQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_key_pair_attributes(scope, id, attrs) ⇒ AWSCDK::EC2::IKeyPair

Imports a key pair with a name and optional type.

Parameters:

Returns:



50
51
52
53
54
55
56
 
# File 'ec2/key_pair.rb', line 50

def self.from_key_pair_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::EC2::KeyPairAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLktleVBhaXJBdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.KeyPair", "fromKeyPairAttributes", [scope, id, attrs])
end

.from_key_pair_name(scope, id, key_pair_name) ⇒ AWSCDK::EC2::IKeyPair

Imports a key pair based on the name.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • key_pair_name (String)

Returns:



64
65
66
67
68
69
 
# File 'ec2/key_pair.rb', line 64

def self.from_key_pair_name(scope, id, key_pair_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(key_pair_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyPairName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.KeyPair", "fromKeyPairName", [scope, id, key_pair_name])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'ec2/key_pair.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :format => { kind: :property, name: "format", is_optional: false },
    :has_imported_material => { kind: :property, name: "hasImportedMaterial", is_optional: false },
    :key_pair_fingerprint => { kind: :property, name: "keyPairFingerprint", is_optional: false },
    :key_pair_id => { kind: :property, name: "keyPairId", is_optional: false },
    :key_pair_name => { kind: :property, name: "keyPairName", is_optional: false },
    :key_pair_ref => { kind: :property, name: "keyPairRef", is_optional: false },
    :private_key => { kind: :property, name: "privateKey", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


117
118
119
 
# File 'ec2/key_pair.rb', line 117

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.KeyPair", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



213
214
215
216
 
# File 'ec2/key_pair.rb', line 213

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



230
231
232
233
 
# File 'ec2/key_pair.rb', line 230

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



89
90
91
 
# File 'ec2/key_pair.rb', line 89

def env()
  jsii_get_property("env")
end

#format ⇒ AWSCDK::EC2::KeyPairFormat

The format of the key pair.

Returns:



124
125
126
 
# File 'ec2/key_pair.rb', line 124

def format()
  jsii_get_property("format")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


236
237
238
 
# File 'ec2/key_pair.rb', line 236

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


250
251
252
253
254
255
 
# File 'ec2/key_pair.rb', line 250

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


265
266
267
268
 
# File 'ec2/key_pair.rb', line 265

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#has_imported_material ⇒ Boolean

Whether the key material was imported.

Keys with imported material do not have their private key material stored or returned automatically.

Returns:

  • (Boolean) 


134
135
136
 
# File 'ec2/key_pair.rb', line 134

def has_imported_material()
  jsii_get_property("hasImportedMaterial")
end

#key_pair_fingerprint ⇒ String

The fingerprint of the key pair.

Returns:

  • (String) 


141
142
143
 
# File 'ec2/key_pair.rb', line 141

def key_pair_fingerprint()
  jsii_get_property("keyPairFingerprint")
end

#key_pair_id ⇒ String

The unique ID of the key pair.

Returns:

  • (String) 


148
149
150
 
# File 'ec2/key_pair.rb', line 148

def key_pair_id()
  jsii_get_property("keyPairId")
end

#key_pair_name ⇒ String

The unique name of the key pair.

Returns:

  • (String) 


155
156
157
 
# File 'ec2/key_pair.rb', line 155

def key_pair_name()
  jsii_get_property("keyPairName")
end

#key_pair_ref ⇒ AWSCDK::Interfaces::AWSEC2::KeyPairReference

A reference to a KeyPair resource.

Returns:



162
163
164
 
# File 'ec2/key_pair.rb', line 162

def key_pair_ref()
  jsii_get_property("keyPairRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


74
75
76
 
# File 'ec2/key_pair.rb', line 74

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


103
104
105
 
# File 'ec2/key_pair.rb', line 103

def physical_name()
  jsii_get_property("physicalName")
end

#private_key ⇒ AWSCDK::SSM::IStringParameter

The Systems Manager Parameter Store parameter with the pair's private key material.

Returns:



169
170
171
 
# File 'ec2/key_pair.rb', line 169

def private_key()
  jsii_get_property("privateKey")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



110
111
112
 
# File 'ec2/key_pair.rb', line 110

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


183
184
185
 
# File 'ec2/key_pair.rb', line 183

def to_string()
  jsii_call_method("toString", [])
end

#type ⇒ AWSCDK::EC2::KeyPairType?

The type of the key pair.

Returns:



176
177
178
 
# File 'ec2/key_pair.rb', line 176

def type()
  jsii_get_property("type")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


196
197
198
199
200
201
 
# File 'ec2/key_pair.rb', line 196

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end