Class: AWSCDK::EC2::LookupMachineImageProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ec2/lookup_machine_image_props.rb

Overview

Properties for looking up an image.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, additional_cache_key: nil, filters: nil, owners: nil, user_data: nil, windows: nil) ⇒ LookupMachineImageProps

Returns a new instance of LookupMachineImageProps.

Parameters:

  • name (String) —

    Name of the image (may contain wildcards).

  • additional_cache_key (String, nil) (defaults to: nil) —

    Adds an additional discriminator to the cdk.context.json cache key.

  • filters (Hash{String => Array<String>}, nil) (defaults to: nil) —

    Additional filters on the AMI.

  • owners (Array<String>, nil) (defaults to: nil) —

    Owner account IDs or aliases.

  • user_data (AWSCDK::EC2::UserData, nil) (defaults to: nil) —

    Custom userdata for this image.

  • windows (Boolean, nil) (defaults to: nil) —

    Look for Windows images.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'ec2/lookup_machine_image_props.rb', line 13

def initialize(name:, additional_cache_key: nil, filters: nil, owners: nil, user_data: nil, windows: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @additional_cache_key = additional_cache_key
  Jsii::Type.check_type(@additional_cache_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "additionalCacheKey") unless @additional_cache_key.nil?
  @filters = filters
  Jsii::Type.check_type(@filters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJhcnJheSJ9fSwia2luZCI6Im1hcCJ9fQ==")), "filters") unless @filters.nil?
  @owners = owners
  Jsii::Type.check_type(@owners, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "owners") unless @owners.nil?
  @user_data = user_data
  Jsii::Type.check_type(@user_data, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlVzZXJEYXRhIn0=")), "userData") unless @user_data.nil?
  @windows = windows
  Jsii::Type.check_type(@windows, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "windows") unless @windows.nil?
end

Instance Attribute Details

#additional_cache_key ⇒ String? (readonly)

Note:

Default: - no additional cache key

Adds an additional discriminator to the cdk.context.json cache key.

Returns:

  • (String, nil) 


36
37
38
 
# File 'ec2/lookup_machine_image_props.rb', line 36

def additional_cache_key
  @additional_cache_key
end

#filters ⇒ Hash{String => Array<String>}? (readonly)

Note:

Default: - No additional filters

Additional filters on the AMI.

Returns:

  • (Hash{String => Array<String>}, nil)

See Also:



42
43
44
 
# File 'ec2/lookup_machine_image_props.rb', line 42

def filters
  @filters
end

#name ⇒ String (readonly)

Name of the image (may contain wildcards).

Returns:

  • (String) 


31
32
33
 
# File 'ec2/lookup_machine_image_props.rb', line 31

def name
  @name
end

#owners ⇒ Array<String>? (readonly)

Note:

Default: - All owners

Owner account IDs or aliases.

Returns:

  • (Array<String>, nil) 


47
48
49
 
# File 'ec2/lookup_machine_image_props.rb', line 47

def owners
  @owners
end

#user_data ⇒ AWSCDK::EC2::UserData? (readonly)

Note:

Default: - Empty user data appropriate for the platform type

Custom userdata for this image.

Returns:



52
53
54
 
# File 'ec2/lookup_machine_image_props.rb', line 52

def user_data
  @user_data
end

#windows ⇒ Boolean? (readonly)

Note:

Default: false

Look for Windows images.

Returns:

  • (Boolean, nil) 


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

def windows
  @windows
end

Class Method Details

.jsii_properties ⇒ Object 



59
60
61
62
63
64
65
66
67
68
 
# File 'ec2/lookup_machine_image_props.rb', line 59

def self.jsii_properties
  {
    :name => "name",
    :additional_cache_key => "additionalCacheKey",
    :filters => "filters",
    :owners => "owners",
    :user_data => "userData",
    :windows => "windows",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'ec2/lookup_machine_image_props.rb', line 70

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "additionalCacheKey" => @additional_cache_key,
    "filters" => @filters,
    "owners" => @owners,
    "userData" => @user_data,
    "windows" => @windows,
  })
  result.compact
end