Class: AWSCDK::EC2::AmazonLinux2023ImageSSMParameter

Inherits:
AmazonLinuxImageSSMParameterBase
  • Object
show all
Defined in:
ec2/amazon_linux2023_image_ssm_parameter.rb

Overview

A SSM Parameter that contains the AMI ID for Amazon Linux 2023.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(props = nil) ⇒ AmazonLinux2023ImageSSMParameter

Returns a new instance of AmazonLinux2023ImageSSMParameter.

Parameters:



9
10
11
12
13
 
# File 'ec2/amazon_linux2023_image_ssm_parameter.rb', line 9

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



15
16
17
18
19
 
# File 'ec2/amazon_linux2023_image_ssm_parameter.rb', line 15

def self.jsii_overridable_methods
  {
    :get_image => { kind: :method, name: "getImage", is_optional: false },
  }
end

.ssm_parameter_name(props) ⇒ String

Generates a SSM Parameter name for a specific amazon linux 2023 AMI.

Example values:

"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-arm64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-arm64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-arm64",

Parameters:

Returns:

  • (String) 


38
39
40
41
42
 
# File 'ec2/amazon_linux2023_image_ssm_parameter.rb', line 38

def self.ssm_parameter_name(props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::AmazonLinux2023ImageSSMParameterProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkFtYXpvbkxpbnV4MjAyM0ltYWdlU3NtUGFyYW1ldGVyUHJvcHMifQ==")), "props")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.AmazonLinux2023ImageSsmParameter", "ssmParameterName", [props])
end

Instance Method Details

#get_image(scope) ⇒ AWSCDK::EC2::MachineImageConfig

Return the image to use in the given context.

Parameters:

  • scope (Constructs::Construct)

Returns:



48
49
50
51
 
# File 'ec2/amazon_linux2023_image_ssm_parameter.rb', line 48

def get_image(scope)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  jsii_call_method("getImage", [scope])
end