Class: AWSCDK::EC2::BastionHostLinux

Inherits:
Resource
  • Object
show all
Includes:
IInstance
Defined in:
ec2/bastion_host_linux.rb

Overview

This creates a linux bastion host you can use to connect to other instances or services in your VPC.

The recommended way to connect to the bastion host is by using AWS Systems Manager Session Manager.

The operating system is Amazon Linux 2 with the latest SSM agent installed

You can also configure this bastion host to allow connections via SSH

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ BastionHostLinux

Returns a new instance of BastionHostLinux.

Parameters:



18
19
20
21
22
23
24
 
# File 'ec2/bastion_host_linux.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::BastionHostLinuxProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkJhc3Rpb25Ib3N0TGludXhQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'ec2/bastion_host_linux.rb', line 26

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 },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :instance => { kind: :property, name: "instance", is_optional: false },
    :instance_availability_zone => { kind: :property, name: "instanceAvailabilityZone", is_optional: false },
    :instance_id => { kind: :property, name: "instanceId", is_optional: false },
    :instance_private_dns_name => { kind: :property, name: "instancePrivateDnsName", is_optional: false },
    :instance_private_ip => { kind: :property, name: "instancePrivateIp", is_optional: false },
    :instance_public_dns_name => { kind: :property, name: "instancePublicDnsName", is_optional: false },
    :instance_public_ip => { kind: :property, name: "instancePublicIp", is_optional: false },
    :instance_ref => { kind: :property, name: "instanceRef", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: false },
    :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 },
    :allow_ssh_access_from => { kind: :method, name: "allowSshAccessFrom", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


100
101
102
 
# File 'ec2/bastion_host_linux.rb', line 100

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

Instance Method Details

#allow_ssh_access_from(*peer) ⇒ void

This method returns an undefined value.

Allow SSH access from the given peer or peers.

Necessary if you want to connect to the instance using ssh. If not called, you should use SSM Session Manager to connect to the instance.

Parameters:



282
283
284
285
286
287
 
# File 'ec2/bastion_host_linux.rb', line 282

def allow_ssh_access_from(*peer)
  peer.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklQZWVyIn0=")), "peer[#{index}]")
  end
  jsii_call_method("allowSshAccessFrom", [*peer])
end

#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:



218
219
220
221
 
# File 'ec2/bastion_host_linux.rb', line 218

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:



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

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

#connections ⇒ AWSCDK::EC2::Connections

Allows specify security group connections for the instance.

Returns:



107
108
109
 
# File 'ec2/bastion_host_linux.rb', line 107

def connections()
  jsii_get_property("connections")
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:



72
73
74
 
# File 'ec2/bastion_host_linux.rb', line 72

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


241
242
243
 
# File 'ec2/bastion_host_linux.rb', line 241

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) 


255
256
257
258
259
260
 
# File 'ec2/bastion_host_linux.rb', line 255

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) 


270
271
272
273
 
# File 'ec2/bastion_host_linux.rb', line 270

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

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



114
115
116
 
# File 'ec2/bastion_host_linux.rb', line 114

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#instance ⇒ AWSCDK::EC2::Instance

The underlying instance resource.

Returns:



121
122
123
 
# File 'ec2/bastion_host_linux.rb', line 121

def instance()
  jsii_get_property("instance")
end

#instance_availability_zone ⇒ String

The availability zone the instance was launched in.

Returns:

  • (String) 


128
129
130
 
# File 'ec2/bastion_host_linux.rb', line 128

def instance_availability_zone()
  jsii_get_property("instanceAvailabilityZone")
end

#instance_id ⇒ String

The instance's ID.

Returns:

  • (String) 


135
136
137
 
# File 'ec2/bastion_host_linux.rb', line 135

def instance_id()
  jsii_get_property("instanceId")
end

#instance_private_dns_name ⇒ String

Private DNS name for this instance.

Returns:

  • (String) 


142
143
144
 
# File 'ec2/bastion_host_linux.rb', line 142

def instance_private_dns_name()
  jsii_get_property("instancePrivateDnsName")
end

#instance_private_ip ⇒ String

Private IP for this instance.

Returns:

  • (String) 


149
150
151
 
# File 'ec2/bastion_host_linux.rb', line 149

def instance_private_ip()
  jsii_get_property("instancePrivateIp")
end

#instance_public_dns_name ⇒ String

Publicly-routable DNS name for this instance.

(May be an empty string if the instance does not have a public name).

Returns:

  • (String) 


158
159
160
 
# File 'ec2/bastion_host_linux.rb', line 158

def instance_public_dns_name()
  jsii_get_property("instancePublicDnsName")
end

#instance_public_ip ⇒ String

Publicly-routable IP address for this instance.

(May be an empty string if the instance does not have a public IP).

Returns:

  • (String) 


167
168
169
 
# File 'ec2/bastion_host_linux.rb', line 167

def instance_public_ip()
  jsii_get_property("instancePublicIp")
end

#instance_ref ⇒ AWSCDK::Interfaces::AWSEC2::InstanceReference

A reference to a Instance resource.

Returns:



174
175
176
 
# File 'ec2/bastion_host_linux.rb', line 174

def instance_ref()
  jsii_get_property("instanceRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


57
58
59
 
# File 'ec2/bastion_host_linux.rb', line 57

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) 


86
87
88
 
# File 'ec2/bastion_host_linux.rb', line 86

def physical_name()
  jsii_get_property("physicalName")
end

#role ⇒ AWSCDK::IAM::IRole

The IAM role assumed by the instance.

Returns:



181
182
183
 
# File 'ec2/bastion_host_linux.rb', line 181

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



93
94
95
 
# File 'ec2/bastion_host_linux.rb', line 93

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


188
189
190
 
# File 'ec2/bastion_host_linux.rb', line 188

def to_string()
  jsii_call_method("toString", [])
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) 


201
202
203
204
205
206
 
# File 'ec2/bastion_host_linux.rb', line 201

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