Class: AWSCDK::ImageBuilder::CfnImage

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

Overview

Creates a new image.

This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnImage

Create a new AWS::ImageBuilder::Image.

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::CfnImageProps, nil) (defaults to: nil) —

    Resource properties.



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

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

Class Method Details

.arn_for_image(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_image(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pbWFnZWJ1aWxkZXIuSUltYWdlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnImage", "arnForImage", [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_image.rb', line 201

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

.is_cfn_image(x) ⇒ Boolean

Checks whether the given object is a CfnImage.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_image(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnImage", "isCfnImage", [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_image.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_image_id => { kind: :property, name: "attrImageId", is_optional: false },
    :attr_image_uri => { kind: :property, name: "attrImageUri", 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_ref => { kind: :property, name: "imageRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :container_recipe_arn => { kind: :property, name: "containerRecipeArn", is_optional: true },
    :deletion_settings => { kind: :property, name: "deletionSettings", is_optional: true },
    :distribution_configuration_arn => { kind: :property, name: "distributionConfigurationArn", is_optional: true },
    :enhanced_image_metadata_enabled => { kind: :property, name: "enhancedImageMetadataEnabled", is_optional: true },
    :execution_role => { kind: :property, name: "executionRole", is_optional: true },
    :image_pipeline_execution_settings => { kind: :property, name: "imagePipelineExecutionSettings", is_optional: true },
    :image_recipe_arn => { kind: :property, name: "imageRecipeArn", is_optional: true },
    :image_scanning_configuration => { kind: :property, name: "imageScanningConfiguration", is_optional: true },
    :image_tests_configuration => { kind: :property, name: "imageTestsConfiguration", is_optional: true },
    :infrastructure_configuration_arn => { kind: :property, name: "infrastructureConfigurationArn", is_optional: true },
    :logging_configuration => { kind: :property, name: "loggingConfiguration", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :workflows => { kind: :property, name: "workflows", 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.



485
486
487
488
 
# File 'image_builder/cfn_image.rb', line 485

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:



497
498
499
500
 
# File 'image_builder/cfn_image.rb', line 497

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:



507
508
509
510
 
# File 'image_builder/cfn_image.rb', line 507

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:



518
519
520
521
522
 
# File 'image_builder/cfn_image.rb', line 518

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.


575
576
577
578
579
 
# File 'image_builder/cfn_image.rb', line 575

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.



585
586
587
588
 
# File 'image_builder/cfn_image.rb', line 585

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.



597
598
599
600
601
 
# File 'image_builder/cfn_image.rb', line 597

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:



610
611
612
613
 
# File 'image_builder/cfn_image.rb', line 610

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:



632
633
634
635
636
637
 
# File 'image_builder/cfn_image.rb', line 632

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.

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

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_image_id ⇒ String

Returns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image Builder.

Values are returned only for AMIs, and not for container images.

Returns:

  • (String) 


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

def attr_image_id()
  jsii_get_property("attrImageId")
end

#attr_image_uri ⇒ String

Returns the URI for a container image created in the context Region.

Values are returned only for container images, and not for AMIs.

Returns:

  • (String) 


228
229
230
 
# File 'image_builder/cfn_image.rb', line 228

def attr_image_uri()
  jsii_get_property("attrImageUri")
end

#attr_latest_version ⇒ AWSCDK::IResolvable

The latest version references of the image.

Returns:



235
236
237
 
# File 'image_builder/cfn_image.rb', line 235

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) 


242
243
244
 
# File 'image_builder/cfn_image.rb', line 242

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) 


249
250
251
 
# File 'image_builder/cfn_image.rb', line 249

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) 


256
257
258
 
# File 'image_builder/cfn_image.rb', line 256

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) 


263
264
265
 
# File 'image_builder/cfn_image.rb', line 263

def attr_latest_version_patch()
  jsii_get_property("attrLatestVersionPatch")
end

#attr_name ⇒ String

Returns the name of the image.

Returns:

  • (String) 


270
271
272
 
# File 'image_builder/cfn_image.rb', line 270

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_image.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_image.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) 


641
642
643
644
 
# File 'image_builder/cfn_image.rb', line 641

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_image.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_image.rb', line 171

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#container_recipe_arn ⇒ String?

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

Returns:

  • (String, nil) 


291
292
293
 
# File 'image_builder/cfn_image.rb', line 291

def container_recipe_arn()
  jsii_get_property("containerRecipeArn")
end

#container_recipe_arn=(value) ⇒ Object 



295
296
297
298
 
# File 'image_builder/cfn_image.rb', line 295

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_settings ⇒ AWSCDK::IResolvable, ...

Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.

Returns:



303
304
305
 
# File 'image_builder/cfn_image.rb', line 303

def deletion_settings()
  jsii_get_property("deletionSettings")
end

#deletion_settings=(value) ⇒ Object 



307
308
309
310
311
 
# File 'image_builder/cfn_image.rb', line 307

def deletion_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnImage::DeletionSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW1hZ2UuRGVsZXRpb25TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "deletionSettings") unless value.nil?
  jsii_set_property("deletionSettings", value)
end

#distribution_configuration_arn ⇒ String?

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

Returns:

  • (String, nil) 


316
317
318
 
# File 'image_builder/cfn_image.rb', line 316

def distribution_configuration_arn()
  jsii_get_property("distributionConfigurationArn")
end

#distribution_configuration_arn=(value) ⇒ Object 



320
321
322
323
 
# File 'image_builder/cfn_image.rb', line 320

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

#enhanced_image_metadata_enabled ⇒ Boolean, ...

Collects additional information about the image being created, including the operating system (OS) version and package list.

Returns:



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

def enhanced_image_metadata_enabled()
  jsii_get_property("enhancedImageMetadataEnabled")
end

#enhanced_image_metadata_enabled=(value) ⇒ Object 



332
333
334
335
 
# File 'image_builder/cfn_image.rb', line 332

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

def env()
  jsii_get_property("env")
end

#execution_role ⇒ String?

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Returns:

  • (String, nil) 


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

def execution_role()
  jsii_get_property("executionRole")
end

#execution_role=(value) ⇒ Object 



344
345
346
347
 
# File 'image_builder/cfn_image.rb', line 344

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



654
655
656
657
658
 
# File 'image_builder/cfn_image.rb', line 654

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:



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

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

#image_pipeline_execution_settings ⇒ AWSCDK::IResolvable, ...

The image pipeline execution settings of the image.

Returns:



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

def image_pipeline_execution_settings()
  jsii_get_property("imagePipelineExecutionSettings")
end

#image_pipeline_execution_settings=(value) ⇒ Object 



356
357
358
359
360
 
# File 'image_builder/cfn_image.rb', line 356

def image_pipeline_execution_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnImage::ImagePipelineExecutionSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW1hZ2UuSW1hZ2VQaXBlbGluZUV4ZWN1dGlvblNldHRpbmdzUHJvcGVydHkifV19fQ==")), "imagePipelineExecutionSettings") unless value.nil?
  jsii_set_property("imagePipelineExecutionSettings", value)
end

#image_recipe_arn ⇒ String?

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

Returns:

  • (String, nil) 


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

def image_recipe_arn()
  jsii_get_property("imageRecipeArn")
end

#image_recipe_arn=(value) ⇒ Object 



369
370
371
372
 
# File 'image_builder/cfn_image.rb', line 369

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

#image_ref ⇒ AWSCDK::Interfaces::AWSImagebuilder::ImageReference

A reference to a Image resource.

Returns:



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

def image_ref()
  jsii_get_property("imageRef")
end

#image_scanning_configuration ⇒ AWSCDK::IResolvable, ...

Contains settings for vulnerability scans.

Returns:



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

def image_scanning_configuration()
  jsii_get_property("imageScanningConfiguration")
end

#image_scanning_configuration=(value) ⇒ Object 



381
382
383
384
385
 
# File 'image_builder/cfn_image.rb', line 381

def image_scanning_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnImage::ImageScanningConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW1hZ2UuSW1hZ2VTY2FubmluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "imageScanningConfiguration") unless value.nil?
  jsii_set_property("imageScanningConfiguration", value)
end

#image_tests_configuration ⇒ AWSCDK::IResolvable, ...

The image tests configuration of the image.

Returns:



390
391
392
 
# File 'image_builder/cfn_image.rb', line 390

def image_tests_configuration()
  jsii_get_property("imageTestsConfiguration")
end

#image_tests_configuration=(value) ⇒ Object 



394
395
396
397
398
 
# File 'image_builder/cfn_image.rb', line 394

def image_tests_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnImage::ImageTestsConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW1hZ2UuSW1hZ2VUZXN0c0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "imageTestsConfiguration") unless value.nil?
  jsii_set_property("imageTestsConfiguration", value)
end

#infrastructure_configuration_arn ⇒ String?

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Returns:

  • (String, nil) 


403
404
405
 
# File 'image_builder/cfn_image.rb', line 403

def infrastructure_configuration_arn()
  jsii_get_property("infrastructureConfigurationArn")
end

#infrastructure_configuration_arn=(value) ⇒ Object 



407
408
409
410
 
# File 'image_builder/cfn_image.rb', line 407

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



735
736
737
738
 
# File 'image_builder/cfn_image.rb', line 735

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

#logging_configuration ⇒ AWSCDK::IResolvable, ...

The logging configuration that's defined for the image.

Returns:



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

def logging_configuration()
  jsii_get_property("loggingConfiguration")
end

#logging_configuration=(value) ⇒ Object 



419
420
421
422
423
 
# File 'image_builder/cfn_image.rb', line 419

def logging_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnImage::ImageLoggingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW1hZ2UuSW1hZ2VMb2dnaW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "loggingConfiguration") unless value.nil?
  jsii_set_property("loggingConfiguration", 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_image.rb', line 128

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


111
112
113
 
# File 'image_builder/cfn_image.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:



676
677
678
 
# File 'image_builder/cfn_image.rb', line 676

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:



683
684
685
 
# File 'image_builder/cfn_image.rb', line 683

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.



476
477
478
479
 
# File 'image_builder/cfn_image.rb', line 476

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) 


147
148
149
 
# File 'image_builder/cfn_image.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:



694
695
696
697
 
# File 'image_builder/cfn_image.rb', line 694

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


701
702
703
704
 
# File 'image_builder/cfn_image.rb', line 701

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:



711
712
713
714
715
 
# File 'image_builder/cfn_image.rb', line 711

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.



720
721
722
 
# File 'image_builder/cfn_image.rb', line 720

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_image.rb', line 137

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

The tags of the image.

Returns:

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


428
429
430
 
# File 'image_builder/cfn_image.rb', line 428

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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



452
453
454
 
# File 'image_builder/cfn_image.rb', line 452

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_image.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_image.rb', line 194

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


726
727
728
729
 
# File 'image_builder/cfn_image.rb', line 726

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) 


465
466
467
468
469
470
 
# File 'image_builder/cfn_image.rb', line 465

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

#workflows ⇒ AWSCDK::IResolvable, ...

Contains an array of workflow configuration objects.

Returns:



440
441
442
 
# File 'image_builder/cfn_image.rb', line 440

def workflows()
  jsii_get_property("workflows")
end

#workflows=(value) ⇒ Object 



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

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