Class: AWSCDK::ImageBuilder::CfnImagePipeline

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

Overview

An image pipeline is the automation configuration for building secure OS images on AWS .

The Image Builder image pipeline is associated with an image recipe that defines the build, validation, and test phases for an image build lifecycle. An image pipeline can be associated with an infrastructure configuration that defines where your image is built. You can define attributes, such as instance types, a subnet for your VPC, security groups, logging, and other infrastructure-related configurations. You can also associate your image pipeline with a distribution configuration to define how you would like to deploy your image.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnImagePipeline

Create a new AWS::ImageBuilder::ImagePipeline.

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

    Resource properties.



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

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

Class Method Details

.arn_for_image_pipeline(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'image_builder/cfn_image_pipeline.rb', line 90

def self.arn_for_image_pipeline(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pbWFnZWJ1aWxkZXIuSUltYWdlUGlwZWxpbmVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnImagePipeline", "arnForImagePipeline", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


197
198
199
 
# File 'image_builder/cfn_image_pipeline.rb', line 197

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

.is_cfn_image_pipeline(x) ⇒ Boolean

Checks whether the given object is a CfnImagePipeline.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


99
100
101
102
 
# File 'image_builder/cfn_image_pipeline.rb', line 99

def self.is_cfn_image_pipeline(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnImagePipeline", "isCfnImagePipeline", [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
 
# File 'image_builder/cfn_image_pipeline.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_deployment_id => { kind: :property, name: "attrDeploymentId", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :image_pipeline_ref => { kind: :property, name: "imagePipelineRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :infrastructure_configuration_arn => { kind: :property, name: "infrastructureConfigurationArn", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :container_recipe_arn => { kind: :property, name: "containerRecipeArn", is_optional: true },
    :description => { kind: :property, name: "description", 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_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 },
    :logging_configuration => { kind: :property, name: "loggingConfiguration", is_optional: true },
    :schedule => { kind: :property, name: "schedule", is_optional: true },
    :status => { kind: :property, name: "status", 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.



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

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:



470
471
472
473
 
# File 'image_builder/cfn_image_pipeline.rb', line 470

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:



480
481
482
483
 
# File 'image_builder/cfn_image_pipeline.rb', line 480

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:



491
492
493
494
495
 
# File 'image_builder/cfn_image_pipeline.rb', line 491

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.


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

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.



558
559
560
561
 
# File 'image_builder/cfn_image_pipeline.rb', line 558

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.



570
571
572
573
574
 
# File 'image_builder/cfn_image_pipeline.rb', line 570

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:



583
584
585
586
 
# File 'image_builder/cfn_image_pipeline.rb', line 583

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:



605
606
607
608
609
610
 
# File 'image_builder/cfn_image_pipeline.rb', line 605

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

For example, arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline .

Returns:

  • (String) 


206
207
208
 
# File 'image_builder/cfn_image_pipeline.rb', line 206

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_deployment_id ⇒ String

Returns the deployment ID of the pipeline, used for resource create/update triggers.

Returns:

  • (String) 


213
214
215
 
# File 'image_builder/cfn_image_pipeline.rb', line 213

def attr_deployment_id()
  jsii_get_property("attrDeploymentId")
end

#attr_name ⇒ String

Returns the name of the image pipeline.

Returns:

  • (String) 


220
221
222
 
# File 'image_builder/cfn_image_pipeline.rb', line 220

def attr_name()
  jsii_get_property("attrName")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



150
151
152
 
# File 'image_builder/cfn_image_pipeline.rb', line 150

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


155
156
157
 
# File 'image_builder/cfn_image_pipeline.rb', line 155

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


160
161
162
 
# File 'image_builder/cfn_image_pipeline.rb', line 160

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


167
168
169
 
# File 'image_builder/cfn_image_pipeline.rb', line 167

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#container_recipe_arn ⇒ String?

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

Returns:

  • (String, nil) 


265
266
267
 
# File 'image_builder/cfn_image_pipeline.rb', line 265

def container_recipe_arn()
  jsii_get_property("containerRecipeArn")
end

#container_recipe_arn=(value) ⇒ Object 



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

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


112
113
114
 
# File 'image_builder/cfn_image_pipeline.rb', line 112

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of this image pipeline.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



281
282
283
284
 
# File 'image_builder/cfn_image_pipeline.rb', line 281

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

#distribution_configuration_arn ⇒ String?

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

Returns:

  • (String, nil) 


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

def distribution_configuration_arn()
  jsii_get_property("distributionConfigurationArn")
end

#distribution_configuration_arn=(value) ⇒ Object 



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

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:



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

def enhanced_image_metadata_enabled()
  jsii_get_property("enhancedImageMetadataEnabled")
end

#enhanced_image_metadata_enabled=(value) ⇒ Object 



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

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:



172
173
174
 
# File 'image_builder/cfn_image_pipeline.rb', line 172

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) 


313
314
315
 
# File 'image_builder/cfn_image_pipeline.rb', line 313

def execution_role()
  jsii_get_property("executionRole")
end

#execution_role=(value) ⇒ Object 



317
318
319
320
 
# File 'image_builder/cfn_image_pipeline.rb', line 317

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:



627
628
629
630
631
 
# File 'image_builder/cfn_image_pipeline.rb', line 627

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:



638
639
640
641
 
# File 'image_builder/cfn_image_pipeline.rb', line 638

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

#image_pipeline_ref ⇒ AWSCDK::Interfaces::AWSImagebuilder::ImagePipelineReference

A reference to a ImagePipeline resource.

Returns:



227
228
229
 
# File 'image_builder/cfn_image_pipeline.rb', line 227

def image_pipeline_ref()
  jsii_get_property("imagePipelineRef")
end

#image_recipe_arn ⇒ String?

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

Returns:

  • (String, nil) 


325
326
327
 
# File 'image_builder/cfn_image_pipeline.rb', line 325

def image_recipe_arn()
  jsii_get_property("imageRecipeArn")
end

#image_recipe_arn=(value) ⇒ Object 



329
330
331
332
 
# File 'image_builder/cfn_image_pipeline.rb', line 329

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

Contains settings for vulnerability scans.

Returns:



337
338
339
 
# File 'image_builder/cfn_image_pipeline.rb', line 337

def image_scanning_configuration()
  jsii_get_property("imageScanningConfiguration")
end

#image_scanning_configuration=(value) ⇒ Object 



341
342
343
344
345
 
# File 'image_builder/cfn_image_pipeline.rb', line 341

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

#image_tests_configuration ⇒ AWSCDK::IResolvable, ...

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

Returns:



350
351
352
 
# File 'image_builder/cfn_image_pipeline.rb', line 350

def image_tests_configuration()
  jsii_get_property("imageTestsConfiguration")
end

#image_tests_configuration=(value) ⇒ Object 



354
355
356
357
358
 
# File 'image_builder/cfn_image_pipeline.rb', line 354

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

#infrastructure_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

Returns:

  • (String) 


241
242
243
 
# File 'image_builder/cfn_image_pipeline.rb', line 241

def infrastructure_configuration_arn()
  jsii_get_property("infrastructureConfigurationArn")
end

#infrastructure_configuration_arn=(value) ⇒ Object 



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



708
709
710
711
 
# File 'image_builder/cfn_image_pipeline.rb', line 708

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

Defines logging configuration for the output image.

Returns:



363
364
365
 
# File 'image_builder/cfn_image_pipeline.rb', line 363

def logging_configuration()
  jsii_get_property("loggingConfiguration")
end

#logging_configuration=(value) ⇒ Object 



367
368
369
370
371
 
# File 'image_builder/cfn_image_pipeline.rb', line 367

def logging_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnImagePipeline::PipelineLoggingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW1hZ2VQaXBlbGluZS5QaXBlbGluZUxvZ2dpbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "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) 


124
125
126
 
# File 'image_builder/cfn_image_pipeline.rb', line 124

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the image pipeline.

Returns:

  • (String) 


253
254
255
 
# File 'image_builder/cfn_image_pipeline.rb', line 253

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



257
258
259
260
 
# File 'image_builder/cfn_image_pipeline.rb', line 257

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) 


107
108
109
 
# File 'image_builder/cfn_image_pipeline.rb', line 107

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:



649
650
651
 
# File 'image_builder/cfn_image_pipeline.rb', line 649

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:



656
657
658
 
# File 'image_builder/cfn_image_pipeline.rb', line 656

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.



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

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) 


143
144
145
 
# File 'image_builder/cfn_image_pipeline.rb', line 143

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:



667
668
669
670
 
# File 'image_builder/cfn_image_pipeline.rb', line 667

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


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

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:



684
685
686
687
688
 
# File 'image_builder/cfn_image_pipeline.rb', line 684

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

#schedule ⇒ AWSCDK::IResolvable, ...

The schedule of the image pipeline.

Returns:



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

def schedule()
  jsii_get_property("schedule")
end

#schedule=(value) ⇒ Object 



380
381
382
383
384
 
# File 'image_builder/cfn_image_pipeline.rb', line 380

def schedule=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnImagePipeline::ScheduleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW1hZ2VQaXBlbGluZS5TY2hlZHVsZVByb3BlcnR5In1dfX0=")), "schedule") unless value.nil?
  jsii_set_property("schedule", value)
end

#should_synthesize ⇒ Boolean

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

Returns:

  • (Boolean) —

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



693
694
695
 
# File 'image_builder/cfn_image_pipeline.rb', line 693

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:



133
134
135
 
# File 'image_builder/cfn_image_pipeline.rb', line 133

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The status of the image pipeline.

Returns:

  • (String, nil) 


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

def status()
  jsii_get_property("status")
end

#status=(value) ⇒ Object 



393
394
395
396
 
# File 'image_builder/cfn_image_pipeline.rb', line 393

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



234
235
236
 
# File 'image_builder/cfn_image_pipeline.rb', line 234

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

The tags of this image pipeline.

Returns:

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


401
402
403
 
# File 'image_builder/cfn_image_pipeline.rb', line 401

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



405
406
407
408
 
# File 'image_builder/cfn_image_pipeline.rb', line 405

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



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

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


180
181
182
 
# File 'image_builder/cfn_image_pipeline.rb', line 180

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


190
191
192
 
# File 'image_builder/cfn_image_pipeline.rb', line 190

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


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

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) 


438
439
440
441
442
443
 
# File 'image_builder/cfn_image_pipeline.rb', line 438

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 the workflows that run for the image pipeline.

Returns:



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

def workflows()
  jsii_get_property("workflows")
end

#workflows=(value) ⇒ Object 



417
418
419
420
 
# File 'image_builder/cfn_image_pipeline.rb', line 417

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