Class: AWSCDK::EC2::AmazonLinuxImageSSMParameterCommonOptions

Inherits:
AmazonLinuxImageSSMParameterBaseOptions
  • Object
show all
Defined in:
ec2/amazon_linux_image_ssm_parameter_common_options.rb

Overview

Common options across all generations.

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) ⇒ AmazonLinuxImageSSMParameterCommonOptions

Returns a new instance of AmazonLinuxImageSSMParameterCommonOptions.

Parameters:

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

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

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

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

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

    Initial user data.

  • cpu_type (AWSCDK::EC2::AmazonLinuxCpuType, nil) (defaults to: nil) —

    CPU Type.

  • edition (AWSCDK::EC2::AmazonLinuxEdition, nil) (defaults to: nil) —

    What edition of Amazon Linux to use.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'ec2/amazon_linux_image_ssm_parameter_common_options.rb', line 12

def initialize(additional_cache_key: nil, cached_in_context: nil, user_data: nil, cpu_type: nil, edition: 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?
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) 


29
30
31
 
# File 'ec2/amazon_linux_image_ssm_parameter_common_options.rb', line 29

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) 


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

def cached_in_context
  @cached_in_context
end

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

Note:

Default: AmazonLinuxCpuType.X86_64

CPU Type.

Returns:



58
59
60
 
# File 'ec2/amazon_linux_image_ssm_parameter_common_options.rb', line 58

def cpu_type
  @cpu_type
end

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

Note:

Default: AmazonLinuxEdition.Standard

What edition of Amazon Linux to use.

Returns:



63
64
65
 
# File 'ec2/amazon_linux_image_ssm_parameter_common_options.rb', line 63

def edition
  @edition
end

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

Note:

Default: - Empty UserData for Linux machines

Initial user data.

Returns:



53
54
55
 
# File 'ec2/amazon_linux_image_ssm_parameter_common_options.rb', line 53

def user_data
  @user_data
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'ec2/amazon_linux_image_ssm_parameter_common_options.rb', line 65

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

Instance Method Details

#to_jsii ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'ec2/amazon_linux_image_ssm_parameter_common_options.rb', line 75

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,
  })
  result.compact
end