Class: AWSCDK::Lambda::CfnMicrovmImage

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSLambda::IMicrovmImageRef
Defined in:
lambda/cfn_microvm_image.rb

Overview

Resource Type definition for AWS::Lambda::MicrovmImage.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMicrovmImage

Create a new AWS::Lambda::MicrovmImage.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Lambda::CfnMicrovmImageProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'lambda/cfn_microvm_image.rb', line 18

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


190
191
192
 
# File 'lambda/cfn_microvm_image.rb', line 190

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_lambda.CfnMicrovmImage", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_microvm_image(x) ⇒ Boolean

Checks whether the given object is a CfnMicrovmImage.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'lambda/cfn_microvm_image.rb', line 92

def self.is_cfn_microvm_image(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CfnMicrovmImage", "isCfnMicrovmImage", [x])
end

.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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lambda/cfn_microvm_image.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_image_arn => { kind: :property, name: "attrImageArn", is_optional: false },
    :attr_latest_active_image_version => { kind: :property, name: "attrLatestActiveImageVersion", is_optional: false },
    :attr_latest_failed_image_version => { kind: :property, name: "attrLatestFailedImageVersion", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :microvm_image_ref => { kind: :property, name: "microvmImageRef", is_optional: false },
    :additional_os_capabilities => { kind: :property, name: "additionalOsCapabilities", is_optional: false },
    :base_image_arn => { kind: :property, name: "baseImageArn", is_optional: false },
    :base_image_version => { kind: :property, name: "baseImageVersion", is_optional: false },
    :build_role_arn => { kind: :property, name: "buildRoleArn", is_optional: false },
    :code_artifact => { kind: :property, name: "codeArtifact", is_optional: false },
    :cpu_configurations => { kind: :property, name: "cpuConfigurations", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: false },
    :egress_network_connectors => { kind: :property, name: "egressNetworkConnectors", is_optional: false },
    :environment_variables => { kind: :property, name: "environmentVariables", is_optional: false },
    :hooks => { kind: :property, name: "hooks", is_optional: false },
    :logging => { kind: :property, name: "logging", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :resources => { kind: :property, name: "resources", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



442
443
444
445
 
# File 'lambda/cfn_microvm_image.rb', line 442

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



454
455
456
457
 
# File 'lambda/cfn_microvm_image.rb', line 454

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



464
465
466
467
 
# File 'lambda/cfn_microvm_image.rb', line 464

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



475
476
477
478
479
 
# File 'lambda/cfn_microvm_image.rb', line 475

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


532
533
534
535
536
 
# File 'lambda/cfn_microvm_image.rb', line 532

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



542
543
544
545
 
# File 'lambda/cfn_microvm_image.rb', line 542

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



554
555
556
557
558
 
# File 'lambda/cfn_microvm_image.rb', line 554

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#additional_os_capabilities ⇒ Array<String>

Returns:

  • (Array<String>) 


249
250
251
 
# File 'lambda/cfn_microvm_image.rb', line 249

def additional_os_capabilities()
  jsii_get_property("additionalOsCapabilities")
end

#additional_os_capabilities=(value) ⇒ Object 



253
254
255
256
 
# File 'lambda/cfn_microvm_image.rb', line 253

def additional_os_capabilities=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "additionalOsCapabilities")
  jsii_set_property("additionalOsCapabilities", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



567
568
569
570
 
# File 'lambda/cfn_microvm_image.rb', line 567

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



589
590
591
592
593
594
 
# File 'lambda/cfn_microvm_image.rb', line 589

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_at ⇒ String

Timestamp when the MicroVM image was created.

Returns:

  • (String) 


197
198
199
 
# File 'lambda/cfn_microvm_image.rb', line 197

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_image_arn ⇒ String

ARN of the MicroVM image.

Returns:

  • (String) 


204
205
206
 
# File 'lambda/cfn_microvm_image.rb', line 204

def attr_image_arn()
  jsii_get_property("attrImageArn")
end

#attr_latest_active_image_version ⇒ String

The latest active version of the MicroVM image.

Returns:

  • (String) 


211
212
213
 
# File 'lambda/cfn_microvm_image.rb', line 211

def attr_latest_active_image_version()
  jsii_get_property("attrLatestActiveImageVersion")
end

#attr_latest_failed_image_version ⇒ String

The latest failed version of the MicroVM image.

Returns:

  • (String) 


218
219
220
 
# File 'lambda/cfn_microvm_image.rb', line 218

def attr_latest_failed_image_version()
  jsii_get_property("attrLatestFailedImageVersion")
end

#attr_state ⇒ String

Returns:

  • (String) 


223
224
225
 
# File 'lambda/cfn_microvm_image.rb', line 223

def attr_state()
  jsii_get_property("attrState")
end

#attr_updated_at ⇒ String

Timestamp when the MicroVM image was updated.

Returns:

  • (String) 


230
231
232
 
# File 'lambda/cfn_microvm_image.rb', line 230

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#base_image_arn ⇒ String

ARN of the base MicroVM image.

Returns:

  • (String) 


261
262
263
 
# File 'lambda/cfn_microvm_image.rb', line 261

def base_image_arn()
  jsii_get_property("baseImageArn")
end

#base_image_arn=(value) ⇒ Object 



265
266
267
268
 
# File 'lambda/cfn_microvm_image.rb', line 265

def base_image_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseImageArn")
  jsii_set_property("baseImageArn", value)
end

#base_image_version ⇒ String

Specific version of the base MicroVM image to use.

Returns:

  • (String) 


273
274
275
 
# File 'lambda/cfn_microvm_image.rb', line 273

def base_image_version()
  jsii_get_property("baseImageVersion")
end

#base_image_version=(value) ⇒ Object 



277
278
279
280
 
# File 'lambda/cfn_microvm_image.rb', line 277

def base_image_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseImageVersion")
  jsii_set_property("baseImageVersion", value)
end

#build_role_arn ⇒ String

ARN of the IAM build role.

Returns:

  • (String) 


285
286
287
 
# File 'lambda/cfn_microvm_image.rb', line 285

def build_role_arn()
  jsii_get_property("buildRoleArn")
end

#build_role_arn=(value) ⇒ Object 



289
290
291
292
 
# File 'lambda/cfn_microvm_image.rb', line 289

def build_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "buildRoleArn")
  jsii_set_property("buildRoleArn", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



237
238
239
 
# File 'lambda/cfn_microvm_image.rb', line 237

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



143
144
145
 
# File 'lambda/cfn_microvm_image.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'lambda/cfn_microvm_image.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


598
599
600
601
 
# File 'lambda/cfn_microvm_image.rb', line 598

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


153
154
155
 
# File 'lambda/cfn_microvm_image.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'lambda/cfn_microvm_image.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#code_artifact ⇒ AWSCDK::IResolvable, AWSCDK::Lambda::CfnMicrovmImage::CodeArtifactProperty

Returns:



295
296
297
 
# File 'lambda/cfn_microvm_image.rb', line 295

def code_artifact()
  jsii_get_property("codeArtifact")
end

#code_artifact=(value) ⇒ Object 



299
300
301
302
303
 
# File 'lambda/cfn_microvm_image.rb', line 299

def code_artifact=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnMicrovmImage::CodeArtifactProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuTWljcm92bUltYWdlLkNvZGVBcnRpZmFjdFByb3BlcnR5In1dfX0=")), "codeArtifact")
  jsii_set_property("codeArtifact", value)
end

#cpu_configurations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Lambda::CfnMicrovmImage::CpuConfigurationProperty>

Returns:



306
307
308
 
# File 'lambda/cfn_microvm_image.rb', line 306

def cpu_configurations()
  jsii_get_property("cpuConfigurations")
end

#cpu_configurations=(value) ⇒ Object 



310
311
312
313
 
# File 'lambda/cfn_microvm_image.rb', line 310

def cpu_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNmbk1pY3Jvdm1JbWFnZS5DcHVDb25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "cpuConfigurations")
  jsii_set_property("cpuConfigurations", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'lambda/cfn_microvm_image.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String

Human-readable description of the MicroVM image and its purpose.

Returns:

  • (String) 


318
319
320
 
# File 'lambda/cfn_microvm_image.rb', line 318

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



322
323
324
325
 
# File 'lambda/cfn_microvm_image.rb', line 322

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  jsii_set_property("description", value)
end

#egress_network_connectors ⇒ Array<String>

Returns:

  • (Array<String>) 


328
329
330
 
# File 'lambda/cfn_microvm_image.rb', line 328

def egress_network_connectors()
  jsii_get_property("egressNetworkConnectors")
end

#egress_network_connectors=(value) ⇒ Object 



332
333
334
335
 
# File 'lambda/cfn_microvm_image.rb', line 332

def egress_network_connectors=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "egressNetworkConnectors")
  jsii_set_property("egressNetworkConnectors", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



165
166
167
 
# File 'lambda/cfn_microvm_image.rb', line 165

def env()
  jsii_get_property("env")
end

#environment_variables ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Lambda::CfnMicrovmImage::EnvironmentVariableProperty>

Environment variables to set in the container during the snapshot build.

Returns:



340
341
342
 
# File 'lambda/cfn_microvm_image.rb', line 340

def environment_variables()
  jsii_get_property("environmentVariables")
end

#environment_variables=(value) ⇒ Object 



344
345
346
347
 
# File 'lambda/cfn_microvm_image.rb', line 344

def environment_variables=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNmbk1pY3Jvdm1JbWFnZS5FbnZpcm9ubWVudFZhcmlhYmxlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "environmentVariables")
  jsii_set_property("environmentVariables", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



611
612
613
614
615
 
# File 'lambda/cfn_microvm_image.rb', line 611

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



622
623
624
625
 
# File 'lambda/cfn_microvm_image.rb', line 622

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#hooks ⇒ AWSCDK::IResolvable, AWSCDK::Lambda::CfnMicrovmImage::HooksProperty

Returns:



350
351
352
 
# File 'lambda/cfn_microvm_image.rb', line 350

def hooks()
  jsii_get_property("hooks")
end

#hooks=(value) ⇒ Object 



354
355
356
357
358
 
# File 'lambda/cfn_microvm_image.rb', line 354

def hooks=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnMicrovmImage::HooksProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuTWljcm92bUltYWdlLkhvb2tzUHJvcGVydHkifV19fQ==")), "hooks")
  jsii_set_property("hooks", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



692
693
694
695
 
# File 'lambda/cfn_microvm_image.rb', line 692

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logging ⇒ AWSCDK::IResolvable, AWSCDK::Lambda::CfnMicrovmImage::LoggingProperty

Returns:



361
362
363
 
# File 'lambda/cfn_microvm_image.rb', line 361

def logging()
  jsii_get_property("logging")
end

#logging=(value) ⇒ Object 



365
366
367
368
369
 
# File 'lambda/cfn_microvm_image.rb', line 365

def logging=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnMicrovmImage::LoggingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuTWljcm92bUltYWdlLkxvZ2dpbmdQcm9wZXJ0eSJ9XX19")), "logging")
  jsii_set_property("logging", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


117
118
119
 
# File 'lambda/cfn_microvm_image.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#microvm_image_ref ⇒ AWSCDK::Interfaces::AWSLambda::MicrovmImageReference

A reference to a MicrovmImage resource.

Returns:



244
245
246
 
# File 'lambda/cfn_microvm_image.rb', line 244

def microvm_image_ref()
  jsii_get_property("microvmImageRef")
end

#name ⇒ String

Unique name for the MicroVM image within the account.

Returns:

  • (String) 


374
375
376
 
# File 'lambda/cfn_microvm_image.rb', line 374

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



378
379
380
381
 
# File 'lambda/cfn_microvm_image.rb', line 378

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'lambda/cfn_microvm_image.rb', line 100

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



633
634
635
 
# File 'lambda/cfn_microvm_image.rb', line 633

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



640
641
642
 
# File 'lambda/cfn_microvm_image.rb', line 640

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



433
434
435
436
 
# File 'lambda/cfn_microvm_image.rb', line 433

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


136
137
138
 
# File 'lambda/cfn_microvm_image.rb', line 136

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



651
652
653
654
 
# File 'lambda/cfn_microvm_image.rb', line 651

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


658
659
660
661
 
# File 'lambda/cfn_microvm_image.rb', line 658

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



668
669
670
671
672
 
# File 'lambda/cfn_microvm_image.rb', line 668

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#resources ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Lambda::CfnMicrovmImage::ResourcesProperty>

Returns:



384
385
386
 
# File 'lambda/cfn_microvm_image.rb', line 384

def resources()
  jsii_get_property("resources")
end

#resources=(value) ⇒ Object 



388
389
390
391
 
# File 'lambda/cfn_microvm_image.rb', line 388

def resources=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNmbk1pY3Jvdm1JbWFnZS5SZXNvdXJjZXNQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "resources")
  jsii_set_property("resources", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



677
678
679
 
# File 'lambda/cfn_microvm_image.rb', line 677

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



126
127
128
 
# File 'lambda/cfn_microvm_image.rb', line 126

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Key-value pairs to associate with the MicroVM image for organization and management.

Returns:



396
397
398
 
# File 'lambda/cfn_microvm_image.rb', line 396

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



400
401
402
403
404
 
# File 'lambda/cfn_microvm_image.rb', line 400

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



409
410
411
 
# File 'lambda/cfn_microvm_image.rb', line 409

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'lambda/cfn_microvm_image.rb', line 173

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'lambda/cfn_microvm_image.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


683
684
685
686
 
# File 'lambda/cfn_microvm_image.rb', line 683

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


422
423
424
425
426
427
 
# File 'lambda/cfn_microvm_image.rb', line 422

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