Class: AWSCDK::ImageBuilder::CfnContainerRecipe

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

Overview

Creates a new container recipe.

Container 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) ⇒ CfnContainerRecipe

Create a new AWS::ImageBuilder::ContainerRecipe.

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::CfnContainerRecipeProps) —

    Resource properties.



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

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

Class Method Details

.arn_for_container_recipe(resource) ⇒ String

Parameters:

Returns:

  • (String) 


94
95
96
97
 
# File 'image_builder/cfn_container_recipe.rb', line 94

def self.arn_for_container_recipe(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pbWFnZWJ1aWxkZXIuSUNvbnRhaW5lclJlY2lwZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnContainerRecipe", "arnForContainerRecipe", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


201
202
203
 
# File 'image_builder/cfn_container_recipe.rb', line 201

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

.is_cfn_container_recipe(x) ⇒ Boolean

Checks whether the given object is a CfnContainerRecipe.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


103
104
105
106
 
# File 'image_builder/cfn_container_recipe.rb', line 103

def self.is_cfn_container_recipe(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnContainerRecipe", "isCfnContainerRecipe", [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
86
87
88
89
90
 
# File 'image_builder/cfn_container_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 },
    :container_recipe_ref => { kind: :property, name: "containerRecipeRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :container_type => { kind: :property, name: "containerType", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :parent_image => { kind: :property, name: "parentImage", is_optional: false },
    :target_repository => { kind: :property, name: "targetRepository", is_optional: false },
    :version => { kind: :property, name: "version", is_optional: false },
    :components => { kind: :property, name: "components", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :dockerfile_template_data => { kind: :property, name: "dockerfileTemplateData", is_optional: true },
    :dockerfile_template_uri => { kind: :property, name: "dockerfileTemplateUri", is_optional: true },
    :image_os_version_override => { kind: :property, name: "imageOsVersionOverride", is_optional: true },
    :instance_configuration => { kind: :property, name: "instanceConfiguration", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :platform_override => { kind: :property, name: "platformOverride", 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.



490
491
492
493
 
# File 'image_builder/cfn_container_recipe.rb', line 490

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:



502
503
504
505
 
# File 'image_builder/cfn_container_recipe.rb', line 502

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:



512
513
514
515
 
# File 'image_builder/cfn_container_recipe.rb', line 512

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:



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

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.


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

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.



590
591
592
593
 
# File 'image_builder/cfn_container_recipe.rb', line 590

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.



602
603
604
605
606
 
# File 'image_builder/cfn_container_recipe.rb', line 602

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

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



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

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:



637
638
639
640
641
642
 
# File 'image_builder/cfn_container_recipe.rb', line 637

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 container recipe.

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

Returns:

  • (String) 


210
211
212
 
# File 'image_builder/cfn_container_recipe.rb', line 210

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_latest_version ⇒ AWSCDK::IResolvable

The latest version references of the container recipe.

Returns:



217
218
219
 
# File 'image_builder/cfn_container_recipe.rb', line 217

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) 


224
225
226
 
# File 'image_builder/cfn_container_recipe.rb', line 224

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) 


231
232
233
 
# File 'image_builder/cfn_container_recipe.rb', line 231

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) 


238
239
240
 
# File 'image_builder/cfn_container_recipe.rb', line 238

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) 


245
246
247
 
# File 'image_builder/cfn_container_recipe.rb', line 245

def attr_latest_version_patch()
  jsii_get_property("attrLatestVersionPatch")
end

#attr_name ⇒ String

Returns the name of the container recipe.

Returns:

  • (String) 


252
253
254
 
# File 'image_builder/cfn_container_recipe.rb', line 252

def attr_name()
  jsii_get_property("attrName")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


646
647
648
649
 
# File 'image_builder/cfn_container_recipe.rb', line 646

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


164
165
166
 
# File 'image_builder/cfn_container_recipe.rb', line 164

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#components ⇒ AWSCDK::IResolvable, ...

Build and test components that are included in the container recipe.

Returns:



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

def components()
  jsii_get_property("components")
end

#components=(value) ⇒ Object 



340
341
342
343
 
# File 'image_builder/cfn_container_recipe.rb', line 340

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

#container_recipe_ref ⇒ AWSCDK::Interfaces::AWSImagebuilder::ContainerRecipeReference

A reference to a ContainerRecipe resource.

Returns:



259
260
261
 
# File 'image_builder/cfn_container_recipe.rb', line 259

def container_recipe_ref()
  jsii_get_property("containerRecipeRef")
end

#container_type ⇒ String

Specifies the type of container, such as Docker.

Returns:

  • (String) 


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

def container_type()
  jsii_get_property("containerType")
end

#container_type=(value) ⇒ Object 



277
278
279
280
 
# File 'image_builder/cfn_container_recipe.rb', line 277

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


116
117
118
 
# File 'image_builder/cfn_container_recipe.rb', line 116

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the container recipe.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



352
353
354
355
 
# File 'image_builder/cfn_container_recipe.rb', line 352

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

#dockerfile_template_data ⇒ String?

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.

Returns:

  • (String, nil) 


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

def dockerfile_template_data()
  jsii_get_property("dockerfileTemplateData")
end

#dockerfile_template_data=(value) ⇒ Object 



364
365
366
367
 
# File 'image_builder/cfn_container_recipe.rb', line 364

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

#dockerfile_template_uri ⇒ String?

The S3 URI for the Dockerfile that will be used to build your container image.

Returns:

  • (String, nil) 


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

def dockerfile_template_uri()
  jsii_get_property("dockerfileTemplateUri")
end

#dockerfile_template_uri=(value) ⇒ Object 



376
377
378
379
 
# File 'image_builder/cfn_container_recipe.rb', line 376

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



176
177
178
 
# File 'image_builder/cfn_container_recipe.rb', line 176

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:



659
660
661
662
663
 
# File 'image_builder/cfn_container_recipe.rb', line 659

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:



670
671
672
673
 
# File 'image_builder/cfn_container_recipe.rb', line 670

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

#image_os_version_override ⇒ String?

Specifies the operating system version for the base image.

Returns:

  • (String, nil) 


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

def image_os_version_override()
  jsii_get_property("imageOsVersionOverride")
end

#image_os_version_override=(value) ⇒ Object 



388
389
390
391
 
# File 'image_builder/cfn_container_recipe.rb', line 388

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



740
741
742
743
 
# File 'image_builder/cfn_container_recipe.rb', line 740

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

#instance_configuration ⇒ AWSCDK::IResolvable, ...

A group of options that can be used to configure an instance for building and testing container images.

Returns:



396
397
398
 
# File 'image_builder/cfn_container_recipe.rb', line 396

def instance_configuration()
  jsii_get_property("instanceConfiguration")
end

#instance_configuration=(value) ⇒ Object 



400
401
402
403
404
 
# File 'image_builder/cfn_container_recipe.rb', line 400

def instance_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnContainerRecipe::InstanceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuQ29udGFpbmVyUmVjaXBlLkluc3RhbmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "instanceConfiguration") unless value.nil?
  jsii_set_property("instanceConfiguration", value)
end

#kms_key_id ⇒ String?

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image for distribution to the target Region.

Returns:

  • (String, nil) 


409
410
411
 
# File 'image_builder/cfn_container_recipe.rb', line 409

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



413
414
415
416
 
# File 'image_builder/cfn_container_recipe.rb', line 413

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


128
129
130
 
# File 'image_builder/cfn_container_recipe.rb', line 128

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the container recipe.

Returns:

  • (String) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



289
290
291
292
 
# File 'image_builder/cfn_container_recipe.rb', line 289

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) 


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

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:



681
682
683
 
# File 'image_builder/cfn_container_recipe.rb', line 681

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:



688
689
690
 
# File 'image_builder/cfn_container_recipe.rb', line 688

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.



481
482
483
484
 
# File 'image_builder/cfn_container_recipe.rb', line 481

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 container recipe.

Returns:

  • (String) 


297
298
299
 
# File 'image_builder/cfn_container_recipe.rb', line 297

def parent_image()
  jsii_get_property("parentImage")
end

#parent_image=(value) ⇒ Object 



301
302
303
304
 
# File 'image_builder/cfn_container_recipe.rb', line 301

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

#platform_override ⇒ String?

Specifies the operating system platform when you use a custom base image.

Returns:

  • (String, nil) 


421
422
423
 
# File 'image_builder/cfn_container_recipe.rb', line 421

def platform_override()
  jsii_get_property("platformOverride")
end

#platform_override=(value) ⇒ Object 



425
426
427
428
 
# File 'image_builder/cfn_container_recipe.rb', line 425

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


147
148
149
 
# File 'image_builder/cfn_container_recipe.rb', line 147

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:



699
700
701
702
 
# File 'image_builder/cfn_container_recipe.rb', line 699

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


706
707
708
709
 
# File 'image_builder/cfn_container_recipe.rb', line 706

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:



716
717
718
719
720
 
# File 'image_builder/cfn_container_recipe.rb', line 716

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.



725
726
727
 
# File 'image_builder/cfn_container_recipe.rb', line 725

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:



137
138
139
 
# File 'image_builder/cfn_container_recipe.rb', line 137

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



266
267
268
 
# File 'image_builder/cfn_container_recipe.rb', line 266

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

Tags that are attached to the container recipe.

Returns:

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


433
434
435
 
# File 'image_builder/cfn_container_recipe.rb', line 433

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



437
438
439
440
 
# File 'image_builder/cfn_container_recipe.rb', line 437

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

#target_repository ⇒ AWSCDK::IResolvable, AWSCDK::ImageBuilder::CfnContainerRecipe::TargetContainerRepositoryProperty

The destination repository for the container image.

Returns:



309
310
311
 
# File 'image_builder/cfn_container_recipe.rb', line 309

def target_repository()
  jsii_get_property("targetRepository")
end

#target_repository=(value) ⇒ Object 



313
314
315
316
317
 
# File 'image_builder/cfn_container_recipe.rb', line 313

def target_repository=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnContainerRecipe::TargetContainerRepositoryProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuQ29udGFpbmVyUmVjaXBlLlRhcmdldENvbnRhaW5lclJlcG9zaXRvcnlQcm9wZXJ0eSJ9XX19")), "targetRepository")
  jsii_set_property("targetRepository", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



457
458
459
 
# File 'image_builder/cfn_container_recipe.rb', line 457

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


184
185
186
 
# File 'image_builder/cfn_container_recipe.rb', line 184

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


194
195
196
 
# File 'image_builder/cfn_container_recipe.rb', line 194

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


731
732
733
734
 
# File 'image_builder/cfn_container_recipe.rb', line 731

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 container recipe.

This version follows the semantic version syntax.

Returns:

  • (String) 


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

def version()
  jsii_get_property("version")
end

#version=(value) ⇒ Object 



328
329
330
331
 
# File 'image_builder/cfn_container_recipe.rb', line 328

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) 


470
471
472
473
474
475
 
# File 'image_builder/cfn_container_recipe.rb', line 470

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 for use during build and test workflows.

Returns:

  • (String, nil) 


445
446
447
 
# File 'image_builder/cfn_container_recipe.rb', line 445

def working_directory()
  jsii_get_property("workingDirectory")
end

#working_directory=(value) ⇒ Object 



449
450
451
452
 
# File 'image_builder/cfn_container_recipe.rb', line 449

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