Class: AWSCDK::EC2::AmazonLinux2ImageSSMParameterProps

Inherits:
AmazonLinuxImageSSMParameterCommonOptions
  • Object
show all
Defined in:
ec2/amazon_linux2_image_ssm_parameter_props.rb

Overview

Properties specific to amzn2 images.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(additional_cache_key: nil, cached_in_context: nil, user_data: nil, cpu_type: nil, edition: nil, kernel: nil, storage: nil, virtualization: nil) ⇒ AmazonLinux2ImageSSMParameterProps

Returns a new instance of AmazonLinux2ImageSSMParameterProps.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 15

def initialize(additional_cache_key: nil, cached_in_context: nil, user_data: nil, cpu_type: nil, edition: nil, kernel: nil, storage: nil, virtualization: nil)
  @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?
  @cached_in_context = cached_in_context
  Jsii::Type.check_type(@cached_in_context, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "cachedInContext") unless @cached_in_context.nil?
  @user_data = user_data
  Jsii::Type.check_type(@user_data, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlVzZXJEYXRhIn0=")), "userData") unless @user_data.nil?
  @cpu_type = cpu_type
  Jsii::Type.check_type(@cpu_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkFtYXpvbkxpbnV4Q3B1VHlwZSJ9")), "cpuType") unless @cpu_type.nil?
  @edition = edition
  Jsii::Type.check_type(@edition, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkFtYXpvbkxpbnV4RWRpdGlvbiJ9")), "edition") unless @edition.nil?
  @kernel = kernel
  Jsii::Type.check_type(@kernel, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkFtYXpvbkxpbnV4Mktlcm5lbCJ9")), "kernel") unless @kernel.nil?
  @storage = storage
  Jsii::Type.check_type(@storage, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkFtYXpvbkxpbnV4U3RvcmFnZSJ9")), "storage") unless @storage.nil?
  @virtualization = virtualization
  Jsii::Type.check_type(@virtualization, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkFtYXpvbkxpbnV4VmlydCJ9")), "virtualization") unless @virtualization.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) 


38
39
40
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 38

def additional_cache_key
  @additional_cache_key
end

#cached_in_context ⇒ Boolean? (readonly)

Note:

Default: false

Whether the AMI ID is cached to be stable between deployments.

By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren't enough running instances in the AutoScalingGroup to reschedule the tasks on.

If set to true, the AMI ID will be cached in cdk.context.json and the same value will be used on future runs. Your instances will not be replaced but your AMI version will grow old over time. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.

Can not be set to true in environment-agnostic stacks.

Returns:

  • (Boolean, nil) 


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

def cached_in_context
  @cached_in_context
end

#cpu_type ⇒ AWSCDK::EC2::AmazonLinuxCpuType? (readonly)

Note:

Default: AmazonLinuxCpuType.X86_64

CPU Type.

Returns:



67
68
69
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 67

def cpu_type
  @cpu_type
end

#edition ⇒ AWSCDK::EC2::AmazonLinuxEdition? (readonly)

Note:

Default: AmazonLinuxEdition.Standard

What edition of Amazon Linux to use.

Returns:



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

def edition
  @edition
end

#kernel ⇒ AWSCDK::EC2::AmazonLinux2Kernel? (readonly)

Note:

Default: -

What kernel version of Amazon Linux to use.

Returns:



77
78
79
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 77

def kernel
  @kernel
end

#storage ⇒ AWSCDK::EC2::AmazonLinuxStorage? (readonly)

Note:

Default: GeneralPurpose

What storage backed image to use.

Returns:



82
83
84
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 82

def storage
  @storage
end

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

Note:

Default: - Empty UserData for Linux machines

Initial user data.

Returns:



62
63
64
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 62

def user_data
  @user_data
end

#virtualization ⇒ AWSCDK::EC2::AmazonLinuxVirt? (readonly)

Note:

Default: HVM

Virtualization type.

Returns:



87
88
89
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 87

def virtualization
  @virtualization
end

Class Method Details

.jsii_properties ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 89

def self.jsii_properties
  {
    :additional_cache_key => "additionalCacheKey",
    :cached_in_context => "cachedInContext",
    :user_data => "userData",
    :cpu_type => "cpuType",
    :edition => "edition",
    :kernel => "kernel",
    :storage => "storage",
    :virtualization => "virtualization",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'ec2/amazon_linux2_image_ssm_parameter_props.rb', line 102

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "additionalCacheKey" => @additional_cache_key,
    "cachedInContext" => @cached_in_context,
    "userData" => @user_data,
    "cpuType" => @cpu_type,
    "edition" => @edition,
    "kernel" => @kernel,
    "storage" => @storage,
    "virtualization" => @virtualization,
  })
  result.compact
end