Class: AWSCDK::ImageBuilder::CfnImageRecipe

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSImagebuilder::IImageRecipeRef
Defined in:
image_builder/cfn_image_recipe.rb

Overview

Creates a new image recipe.

Image recipes define how images are configured, tested, and assessed.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnImageRecipe

Create a new AWS::ImageBuilder::ImageRecipe.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::ImageBuilder::CfnImageRecipeProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'image_builder/cfn_image_recipe.rb', line 20

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

Class Method Details

.arn_for_image_recipe(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'image_builder/cfn_image_recipe.rb', line 89

def self.arn_for_image_recipe(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pbWFnZWJ1aWxkZXIuSUltYWdlUmVjaXBlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnImageRecipe", "arnForImageRecipe", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'image_builder/cfn_image_recipe.rb', line 196

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

.is_cfn_image_recipe(x) ⇒ Boolean

Checks whether the given object is a CfnImageRecipe.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'image_builder/cfn_image_recipe.rb', line 98

def self.is_cfn_image_recipe(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnImageRecipe", "isCfnImageRecipe", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'image_builder/cfn_image_recipe.rb', line 28

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_latest_version => { kind: :property, name: "attrLatestVersion", is_optional: false },
    :attr_latest_version_arn => { kind: :property, name: "attrLatestVersionArn", is_optional: false },
    :attr_latest_version_major => { kind: :property, name: "attrLatestVersionMajor", is_optional: false },
    :attr_latest_version_minor => { kind: :property, name: "attrLatestVersionMinor", is_optional: false },
    :attr_latest_version_patch => { kind: :property, name: "attrLatestVersionPatch", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :image_recipe_ref => { kind: :property, name: "imageRecipeRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :parent_image => { kind: :property, name: "parentImage", is_optional: false },
    :version => { kind: :property, name: "version", is_optional: false },
    :additional_instance_configuration => { kind: :property, name: "additionalInstanceConfiguration", is_optional: true },
    :ami_tags => { kind: :property, name: "amiTags", is_optional: true },
    :block_device_mappings => { kind: :property, name: "blockDeviceMappings", is_optional: true },
    :components => { kind: :property, name: "components", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :working_directory => { kind: :property, name: "workingDirectory", 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.



424
425
426
427
 
# File 'image_builder/cfn_image_recipe.rb', line 424

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:



436
437
438
439
 
# File 'image_builder/cfn_image_recipe.rb', line 436

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:



446
447
448
449
 
# File 'image_builder/cfn_image_recipe.rb', line 446

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:



457
458
459
460
461
 
# File 'image_builder/cfn_image_recipe.rb', line 457

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.


514
515
516
517
518
 
# File 'image_builder/cfn_image_recipe.rb', line 514

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.



524
525
526
527
 
# File 'image_builder/cfn_image_recipe.rb', line 524

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.



536
537
538
539
540
 
# File 'image_builder/cfn_image_recipe.rb', line 536

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_instance_configuration ⇒ AWSCDK::IResolvable, ...

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.

Returns:



306
307
308
 
# File 'image_builder/cfn_image_recipe.rb', line 306

def additional_instance_configuration()
  jsii_get_property("additionalInstanceConfiguration")
end

#additional_instance_configuration=(value) ⇒ Object 



310
311
312
313
314
 
# File 'image_builder/cfn_image_recipe.rb', line 310

def additional_instance_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnImageRecipe::AdditionalInstanceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW1hZ2VSZWNpcGUuQWRkaXRpb25hbEluc3RhbmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "additionalInstanceConfiguration") unless value.nil?
  jsii_set_property("additionalInstanceConfiguration", value)
end

#ami_tags ⇒ AWSCDK::IResolvable, ...

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

Returns:



319
320
321
 
# File 'image_builder/cfn_image_recipe.rb', line 319

def ami_tags()
  jsii_get_property("amiTags")
end

#ami_tags=(value) ⇒ Object 



323
324
325
326
 
# File 'image_builder/cfn_image_recipe.rb', line 323

def ami_tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "amiTags") unless value.nil?
  jsii_set_property("amiTags", 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:



549
550
551
552
 
# File 'image_builder/cfn_image_recipe.rb', line 549

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:



571
572
573
574
575
576
 
# File 'image_builder/cfn_image_recipe.rb', line 571

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_arn ⇒ String

Returns the Amazon Resource Name (ARN) of the image recipe.

For example, arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03 .

Returns:

  • (String) 


205
206
207
 
# File 'image_builder/cfn_image_recipe.rb', line 205

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_latest_version ⇒ AWSCDK::IResolvable

The latest version references of the image recipe.

Returns:



212
213
214
 
# File 'image_builder/cfn_image_recipe.rb', line 212

def attr_latest_version()
  jsii_get_property("attrLatestVersion")
end

#attr_latest_version_arn ⇒ String

The latest version Amazon Resource Name (ARN) of the Image Builder resource.

Returns:

  • (String) 


219
220
221
 
# File 'image_builder/cfn_image_recipe.rb', line 219

def attr_latest_version_arn()
  jsii_get_property("attrLatestVersionArn")
end

#attr_latest_version_major ⇒ String

The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

Returns:

  • (String) 


226
227
228
 
# File 'image_builder/cfn_image_recipe.rb', line 226

def attr_latest_version_major()
  jsii_get_property("attrLatestVersionMajor")
end

#attr_latest_version_minor ⇒ String

The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

Returns:

  • (String) 


233
234
235
 
# File 'image_builder/cfn_image_recipe.rb', line 233

def attr_latest_version_minor()
  jsii_get_property("attrLatestVersionMinor")
end

#attr_latest_version_patch ⇒ String

The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

Returns:

  • (String) 


240
241
242
 
# File 'image_builder/cfn_image_recipe.rb', line 240

def attr_latest_version_patch()
  jsii_get_property("attrLatestVersionPatch")
end

#attr_name ⇒ String

The name of the image recipe.

Returns:

  • (String) 


247
248
249
 
# File 'image_builder/cfn_image_recipe.rb', line 247

def attr_name()
  jsii_get_property("attrName")
end

#block_device_mappings ⇒ AWSCDK::IResolvable, ...

The block device mappings to apply when creating images from this recipe.

Returns:



331
332
333
 
# File 'image_builder/cfn_image_recipe.rb', line 331

def block_device_mappings()
  jsii_get_property("blockDeviceMappings")
end

#block_device_mappings=(value) ⇒ Object 



335
336
337
338
 
# File 'image_builder/cfn_image_recipe.rb', line 335

def block_device_mappings=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW1hZ2VidWlsZGVyLkNmbkltYWdlUmVjaXBlLkluc3RhbmNlQmxvY2tEZXZpY2VNYXBwaW5nUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "blockDeviceMappings") unless value.nil?
  jsii_set_property("blockDeviceMappings", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



149
150
151
 
# File 'image_builder/cfn_image_recipe.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'image_builder/cfn_image_recipe.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


580
581
582
583
 
# File 'image_builder/cfn_image_recipe.rb', line 580

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}) 


159
160
161
 
# File 'image_builder/cfn_image_recipe.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'image_builder/cfn_image_recipe.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#components ⇒ AWSCDK::IResolvable, ...

The components that are included in the image recipe.

Returns:



343
344
345
 
# File 'image_builder/cfn_image_recipe.rb', line 343

def components()
  jsii_get_property("components")
end

#components=(value) ⇒ Object 



347
348
349
350
 
# File 'image_builder/cfn_image_recipe.rb', line 347

def components=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW1hZ2VidWlsZGVyLkNmbkltYWdlUmVjaXBlLkNvbXBvbmVudENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "components") unless value.nil?
  jsii_set_property("components", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'image_builder/cfn_image_recipe.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the image recipe.

Returns:

  • (String, nil) 


355
356
357
 
# File 'image_builder/cfn_image_recipe.rb', line 355

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



359
360
361
362
 
# File 'image_builder/cfn_image_recipe.rb', line 359

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'image_builder/cfn_image_recipe.rb', line 171

def env()
  jsii_get_property("env")
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:



593
594
595
596
597
 
# File 'image_builder/cfn_image_recipe.rb', line 593

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:



604
605
606
607
 
# File 'image_builder/cfn_image_recipe.rb', line 604

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

#image_recipe_ref ⇒ AWSCDK::Interfaces::AWSImagebuilder::ImageRecipeReference

A reference to a ImageRecipe resource.

Returns:



254
255
256
 
# File 'image_builder/cfn_image_recipe.rb', line 254

def image_recipe_ref()
  jsii_get_property("imageRecipeRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



674
675
676
677
 
# File 'image_builder/cfn_image_recipe.rb', line 674

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


123
124
125
 
# File 'image_builder/cfn_image_recipe.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the image recipe.

Returns:

  • (String) 


268
269
270
 
# File 'image_builder/cfn_image_recipe.rb', line 268

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



272
273
274
275
 
# File 'image_builder/cfn_image_recipe.rb', line 272

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) 


106
107
108
 
# File 'image_builder/cfn_image_recipe.rb', line 106

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:



615
616
617
 
# File 'image_builder/cfn_image_recipe.rb', line 615

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:



622
623
624
 
# File 'image_builder/cfn_image_recipe.rb', line 622

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.



415
416
417
418
 
# File 'image_builder/cfn_image_recipe.rb', line 415

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

#parent_image ⇒ String

The base image for customizations specified in the image recipe.

Returns:

  • (String) 


280
281
282
 
# File 'image_builder/cfn_image_recipe.rb', line 280

def parent_image()
  jsii_get_property("parentImage")
end

#parent_image=(value) ⇒ Object 



284
285
286
287
 
# File 'image_builder/cfn_image_recipe.rb', line 284

def parent_image=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parentImage")
  jsii_set_property("parentImage", value)
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) 


142
143
144
 
# File 'image_builder/cfn_image_recipe.rb', line 142

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:



633
634
635
636
 
# File 'image_builder/cfn_image_recipe.rb', line 633

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}) 


640
641
642
643
 
# File 'image_builder/cfn_image_recipe.rb', line 640

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:



650
651
652
653
654
 
# File 'image_builder/cfn_image_recipe.rb', line 650

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

#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.



659
660
661
 
# File 'image_builder/cfn_image_recipe.rb', line 659

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:



132
133
134
 
# File 'image_builder/cfn_image_recipe.rb', line 132

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



261
262
263
 
# File 'image_builder/cfn_image_recipe.rb', line 261

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

The tags of the image recipe.

Returns:

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


367
368
369
 
# File 'image_builder/cfn_image_recipe.rb', line 367

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



371
372
373
374
 
# File 'image_builder/cfn_image_recipe.rb', line 371

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



391
392
393
 
# File 'image_builder/cfn_image_recipe.rb', line 391

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}) 


179
180
181
 
# File 'image_builder/cfn_image_recipe.rb', line 179

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}) 


189
190
191
 
# File 'image_builder/cfn_image_recipe.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


665
666
667
668
 
# File 'image_builder/cfn_image_recipe.rb', line 665

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#version ⇒ String

The semantic version of the image recipe.

This version follows the semantic version syntax.

Returns:

  • (String) 


294
295
296
 
# File 'image_builder/cfn_image_recipe.rb', line 294

def version()
  jsii_get_property("version")
end

#version=(value) ⇒ Object 



298
299
300
301
 
# File 'image_builder/cfn_image_recipe.rb', line 298

def version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version")
  jsii_set_property("version", value)
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) 


404
405
406
407
408
409
 
# File 'image_builder/cfn_image_recipe.rb', line 404

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

#working_directory ⇒ String?

The working directory to be used during build and test workflows.

Returns:

  • (String, nil) 


379
380
381
 
# File 'image_builder/cfn_image_recipe.rb', line 379

def working_directory()
  jsii_get_property("workingDirectory")
end

#working_directory=(value) ⇒ Object 



383
384
385
386
 
# File 'image_builder/cfn_image_recipe.rb', line 383

def working_directory=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workingDirectory") unless value.nil?
  jsii_set_property("workingDirectory", value)
end