Class: AWSCDK::ImageBuilder::CfnInfrastructureConfiguration

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

Overview

Creates a new infrastructure configuration.

An infrastructure configuration defines the environment in which your image will be built and tested.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnInfrastructureConfiguration

Create a new AWS::ImageBuilder::InfrastructureConfiguration.

Parameters:



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

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

Class Method Details

.arn_for_infrastructure_configuration(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 88

def self.arn_for_infrastructure_configuration(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pbWFnZWJ1aWxkZXIuSUluZnJhc3RydWN0dXJlQ29uZmlndXJhdGlvblJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnInfrastructureConfiguration", "arnForInfrastructureConfiguration", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 195

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

.is_cfn_infrastructure_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnInfrastructureConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 97

def self.is_cfn_infrastructure_configuration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_imagebuilder.CfnInfrastructureConfiguration", "isCfnInfrastructureConfiguration", [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
 
# File 'image_builder/cfn_infrastructure_configuration.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_name => { kind: :property, name: "attrName", is_optional: false },
    :infrastructure_configuration_ref => { kind: :property, name: "infrastructureConfigurationRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :instance_profile_name => { kind: :property, name: "instanceProfileName", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :instance_metadata_options => { kind: :property, name: "instanceMetadataOptions", is_optional: true },
    :instance_types => { kind: :property, name: "instanceTypes", is_optional: true },
    :key_pair => { kind: :property, name: "keyPair", is_optional: true },
    :logging => { kind: :property, name: "logging", is_optional: true },
    :placement => { kind: :property, name: "placement", is_optional: true },
    :resource_tags => { kind: :property, name: "resourceTags", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :sns_topic_arn => { kind: :property, name: "snsTopicArn", is_optional: true },
    :subnet_id => { kind: :property, name: "subnetId", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :terminate_instance_on_failure => { kind: :property, name: "terminateInstanceOnFailure", 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.



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

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:



448
449
450
451
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 448

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:



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

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:



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

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.


526
527
528
529
530
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 526

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.



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

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.



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

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:



561
562
563
564
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 561

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:



583
584
585
586
587
588
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 583

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 infrastructure configuration.

The following pattern is applied: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+)\.(?:x|\d+)\.(?:x|\d+))(?:/\d+)?)?$ .

Returns:

  • (String) 


204
205
206
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 204

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_name ⇒ String

The name of the infrastructure configuration.

Returns:

  • (String) 


211
212
213
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 211

def attr_name()
  jsii_get_property("attrName")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



148
149
150
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


592
593
594
595
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 592

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


158
159
160
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the infrastructure configuration.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 170

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:



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

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:



616
617
618
619
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 616

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

#infrastructure_configuration_ref ⇒ AWSCDK::Interfaces::AWSImagebuilder::InfrastructureConfigurationReference

A reference to a InfrastructureConfiguration resource.

Returns:



218
219
220
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 218

def infrastructure_configuration_ref()
  jsii_get_property("infrastructureConfigurationRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



686
687
688
689
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 686

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

#instance_metadata_options ⇒ AWSCDK::IResolvable, ...

The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

Returns:



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

def instance_metadata_options()
  jsii_get_property("instanceMetadataOptions")
end

#instance_metadata_options=(value) ⇒ Object 



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

def instance_metadata_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnInfrastructureConfiguration::InstanceMetadataOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW5mcmFzdHJ1Y3R1cmVDb25maWd1cmF0aW9uLkluc3RhbmNlTWV0YWRhdGFPcHRpb25zUHJvcGVydHkifV19fQ==")), "instanceMetadataOptions") unless value.nil?
  jsii_set_property("instanceMetadataOptions", value)
end

#instance_profile_name ⇒ String

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

Returns:

  • (String) 


232
233
234
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 232

def instance_profile_name()
  jsii_get_property("instanceProfileName")
end

#instance_profile_name=(value) ⇒ Object 



236
237
238
239
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 236

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

#instance_types ⇒ Array<String>?

The instance types of the infrastructure configuration.

Returns:

  • (Array<String>, nil) 


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

def instance_types()
  jsii_get_property("instanceTypes")
end

#instance_types=(value) ⇒ Object 



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

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

#key_pair ⇒ String?

The key pair of the infrastructure configuration.

Returns:

  • (String, nil) 


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

def key_pair()
  jsii_get_property("keyPair")
end

#key_pair=(value) ⇒ Object 



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

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

#logging ⇒ AWSCDK::IResolvable, ...

The logging configuration of the infrastructure configuration.

Returns:



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

def logging()
  jsii_get_property("logging")
end

#logging=(value) ⇒ Object 



309
310
311
312
313
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 309

def logging=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnInfrastructureConfiguration::LoggingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW5mcmFzdHJ1Y3R1cmVDb25maWd1cmF0aW9uLkxvZ2dpbmdQcm9wZXJ0eSJ9XX19")), "logging") unless value.nil?
  jsii_set_property("logging", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

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

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


122
123
124
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the infrastructure configuration.

Returns:

  • (String) 


244
245
246
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 244

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


105
106
107
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 105

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:



627
628
629
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 627

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:



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

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.



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

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

#placement ⇒ AWSCDK::IResolvable, ...

The instance placement settings that define where the instances that are launched from your image will run.

Returns:



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

def placement()
  jsii_get_property("placement")
end

#placement=(value) ⇒ Object 



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

def placement=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ImageBuilder::CfnInfrastructureConfiguration::PlacementProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pbWFnZWJ1aWxkZXIuQ2ZuSW5mcmFzdHJ1Y3R1cmVDb25maWd1cmF0aW9uLlBsYWNlbWVudFByb3BlcnR5In1dfX0=")), "placement") unless value.nil?
  jsii_set_property("placement", 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) 


141
142
143
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 141

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:



645
646
647
648
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 645

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


652
653
654
655
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 652

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:



662
663
664
665
666
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 662

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

#resource_tags ⇒ AWSCDK::IResolvable, ...

The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.

Returns:



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

def resource_tags()
  jsii_get_property("resourceTags")
end

#resource_tags=(value) ⇒ Object 



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

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

#security_group_ids ⇒ Array<String>?

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

Returns:

  • (Array<String>, nil) 


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

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



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

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



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

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

#sns_topic_arn ⇒ String?

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

Returns:

  • (String, nil) 


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

def sns_topic_arn()
  jsii_get_property("snsTopicArn")
end

#sns_topic_arn=(value) ⇒ Object 



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

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



131
132
133
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 131

def stack()
  jsii_get_property("stack")
end

#subnet_id ⇒ String?

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

Returns:

  • (String, nil) 


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

def subnet_id()
  jsii_get_property("subnetId")
end

#subnet_id=(value) ⇒ Object 



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

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



225
226
227
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 225

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.

Returns:

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


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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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

#terminate_instance_on_failure ⇒ Boolean, ...

The terminate instance on failure setting of the infrastructure configuration.

Returns:



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

def terminate_instance_on_failure()
  jsii_get_property("terminateInstanceOnFailure")
end

#terminate_instance_on_failure=(value) ⇒ Object 



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

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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


178
179
180
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 178

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


188
189
190
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


677
678
679
680
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 677

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) 


416
417
418
419
420
421
 
# File 'image_builder/cfn_infrastructure_configuration.rb', line 416

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