Class: AWSCDK::AppStream::CfnImageBuilder

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSAppstream::IImageBuilderRef
Defined in:
app_stream/cfn_image_builder.rb

Overview

The AWS::AppStream::ImageBuilder resource creates an image builder for Amazon AppStream 2.0. An image builder is a virtual machine that is used to create an image.

The initial state of the image builder is PENDING . When it is ready, the state is RUNNING .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnImageBuilder

Create a new AWS::AppStream::ImageBuilder.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::AppStream::CfnImageBuilderProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'app_stream/cfn_image_builder.rb', line 20

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

Class Method Details

.arn_for_image_builder(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'app_stream/cfn_image_builder.rb', line 89

def self.arn_for_image_builder(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBzdHJlYW0uSUltYWdlQnVpbGRlclJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appstream.CfnImageBuilder", "arnForImageBuilder", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


209
210
211
 
# File 'app_stream/cfn_image_builder.rb', line 209

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

.from_image_builder_name(scope, id, image_builder_name) ⇒ AWSCDK::Interfaces::AWSAppstream::IImageBuilderRef

Creates a new IImageBuilderRef from a imageBuilderName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • image_builder_name (String)

Returns:



100
101
102
103
104
105
 
# File 'app_stream/cfn_image_builder.rb', line 100

def self.from_image_builder_name(scope, id, image_builder_name)
  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(image_builder_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageBuilderName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appstream.CfnImageBuilder", "fromImageBuilderName", [scope, id, image_builder_name])
end

.is_cfn_image_builder(x) ⇒ Boolean

Checks whether the given object is a CfnImageBuilder.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


111
112
113
114
 
# File 'app_stream/cfn_image_builder.rb', line 111

def self.is_cfn_image_builder(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appstream.CfnImageBuilder", "isCfnImageBuilder", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'app_stream/cfn_image_builder.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_streaming_url => { kind: :property, name: "attrStreamingUrl", is_optional: false },
    :image_builder_ref => { kind: :property, name: "imageBuilderRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :instance_type => { kind: :property, name: "instanceType", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :access_endpoints => { kind: :property, name: "accessEndpoints", is_optional: true },
    :appstream_agent_version => { kind: :property, name: "appstreamAgentVersion", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :display_name => { kind: :property, name: "displayName", is_optional: true },
    :domain_join_info => { kind: :property, name: "domainJoinInfo", is_optional: true },
    :enable_default_internet_access => { kind: :property, name: "enableDefaultInternetAccess", is_optional: true },
    :iam_role_arn => { kind: :property, name: "iamRoleArn", is_optional: true },
    :image_arn => { kind: :property, name: "imageArn", is_optional: true },
    :image_name => { kind: :property, name: "imageName", is_optional: true },
    :root_volume_config => { kind: :property, name: "rootVolumeConfig", is_optional: true },
    :softwares_to_install => { kind: :property, name: "softwaresToInstall", is_optional: true },
    :softwares_to_uninstall => { kind: :property, name: "softwaresToUninstall", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_config => { kind: :property, name: "vpcConfig", 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

#access_endpoints ⇒ AWSCDK::IResolvable, ...

The list of virtual private cloud (VPC) interface endpoint objects.

Returns:



263
264
265
 
# File 'app_stream/cfn_image_builder.rb', line 263

def access_endpoints()
  jsii_get_property("accessEndpoints")
end

#access_endpoints=(value) ⇒ Object 



267
268
269
270
 
# File 'app_stream/cfn_image_builder.rb', line 267

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

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



462
463
464
465
 
# File 'app_stream/cfn_image_builder.rb', line 462

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:



474
475
476
477
 
# File 'app_stream/cfn_image_builder.rb', line 474

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:



484
485
486
487
 
# File 'app_stream/cfn_image_builder.rb', line 484

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:



495
496
497
498
499
 
# File 'app_stream/cfn_image_builder.rb', line 495

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.


552
553
554
555
556
 
# File 'app_stream/cfn_image_builder.rb', line 552

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.



562
563
564
565
 
# File 'app_stream/cfn_image_builder.rb', line 562

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.



574
575
576
577
578
 
# File 'app_stream/cfn_image_builder.rb', line 574

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:



587
588
589
590
 
# File 'app_stream/cfn_image_builder.rb', line 587

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:



609
610
611
612
613
614
 
# File 'app_stream/cfn_image_builder.rb', line 609

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

#appstream_agent_version ⇒ String?

The version of the WorkSpaces Applications agent to use for this image builder.

Returns:

  • (String, nil) 


275
276
277
 
# File 'app_stream/cfn_image_builder.rb', line 275

def appstream_agent_version()
  jsii_get_property("appstreamAgentVersion")
end

#appstream_agent_version=(value) ⇒ Object 



279
280
281
282
 
# File 'app_stream/cfn_image_builder.rb', line 279

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

#attr_streaming_url ⇒ String

The URL to start an image builder streaming session, returned as a string.

Returns:

  • (String) 


216
217
218
 
# File 'app_stream/cfn_image_builder.rb', line 216

def attr_streaming_url()
  jsii_get_property("attrStreamingUrl")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



162
163
164
 
# File 'app_stream/cfn_image_builder.rb', line 162

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


167
168
169
 
# File 'app_stream/cfn_image_builder.rb', line 167

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


618
619
620
621
 
# File 'app_stream/cfn_image_builder.rb', line 618

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


172
173
174
 
# File 'app_stream/cfn_image_builder.rb', line 172

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


179
180
181
 
# File 'app_stream/cfn_image_builder.rb', line 179

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


124
125
126
 
# File 'app_stream/cfn_image_builder.rb', line 124

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description to display.

Returns:

  • (String, nil) 


287
288
289
 
# File 'app_stream/cfn_image_builder.rb', line 287

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



291
292
293
294
 
# File 'app_stream/cfn_image_builder.rb', line 291

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

#display_name ⇒ String?

The image builder name to display.

Returns:

  • (String, nil) 


299
300
301
 
# File 'app_stream/cfn_image_builder.rb', line 299

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



303
304
305
306
 
# File 'app_stream/cfn_image_builder.rb', line 303

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

#domain_join_info ⇒ AWSCDK::IResolvable, ...

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

Returns:



311
312
313
 
# File 'app_stream/cfn_image_builder.rb', line 311

def domain_join_info()
  jsii_get_property("domainJoinInfo")
end

#domain_join_info=(value) ⇒ Object 



315
316
317
318
319
 
# File 'app_stream/cfn_image_builder.rb', line 315

def domain_join_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnImageBuilder::DomainJoinInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuSW1hZ2VCdWlsZGVyLkRvbWFpbkpvaW5JbmZvUHJvcGVydHkifV19fQ==")), "domainJoinInfo") unless value.nil?
  jsii_set_property("domainJoinInfo", value)
end

#enable_default_internet_access ⇒ Boolean, ...

Enables or disables default internet access for the image builder.

Returns:



324
325
326
 
# File 'app_stream/cfn_image_builder.rb', line 324

def enable_default_internet_access()
  jsii_get_property("enableDefaultInternetAccess")
end

#enable_default_internet_access=(value) ⇒ Object 



328
329
330
331
 
# File 'app_stream/cfn_image_builder.rb', line 328

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



184
185
186
 
# File 'app_stream/cfn_image_builder.rb', line 184

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:



631
632
633
634
635
 
# File 'app_stream/cfn_image_builder.rb', line 631

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:



642
643
644
645
 
# File 'app_stream/cfn_image_builder.rb', line 642

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

#iam_role_arn ⇒ String?

The ARN of the IAM role that is applied to the image builder.

Returns:

  • (String, nil) 


336
337
338
 
# File 'app_stream/cfn_image_builder.rb', line 336

def iam_role_arn()
  jsii_get_property("iamRoleArn")
end

#iam_role_arn=(value) ⇒ Object 



340
341
342
343
 
# File 'app_stream/cfn_image_builder.rb', line 340

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

#image_arn ⇒ String?

The ARN of the public, private, or shared image to use.

Returns:

  • (String, nil) 


348
349
350
 
# File 'app_stream/cfn_image_builder.rb', line 348

def image_arn()
  jsii_get_property("imageArn")
end

#image_arn=(value) ⇒ Object 



352
353
354
355
 
# File 'app_stream/cfn_image_builder.rb', line 352

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

#image_builder_ref ⇒ AWSCDK::Interfaces::AWSAppstream::ImageBuilderReference

A reference to a ImageBuilder resource.

Returns:



223
224
225
 
# File 'app_stream/cfn_image_builder.rb', line 223

def image_builder_ref()
  jsii_get_property("imageBuilderRef")
end

#image_name ⇒ String?

The name of the image used to create the image builder.

Returns:

  • (String, nil) 


360
361
362
 
# File 'app_stream/cfn_image_builder.rb', line 360

def image_name()
  jsii_get_property("imageName")
end

#image_name=(value) ⇒ Object 



364
365
366
367
 
# File 'app_stream/cfn_image_builder.rb', line 364

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



712
713
714
715
 
# File 'app_stream/cfn_image_builder.rb', line 712

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

#instance_type ⇒ String

The instance type to use when launching the image builder.

The following instance types are available:.

Returns:

  • (String) 


239
240
241
 
# File 'app_stream/cfn_image_builder.rb', line 239

def instance_type()
  jsii_get_property("instanceType")
end

#instance_type=(value) ⇒ Object 



243
244
245
246
 
# File 'app_stream/cfn_image_builder.rb', line 243

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


136
137
138
 
# File 'app_stream/cfn_image_builder.rb', line 136

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A unique name for the image builder.

Returns:

  • (String) 


251
252
253
 
# File 'app_stream/cfn_image_builder.rb', line 251

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



255
256
257
258
 
# File 'app_stream/cfn_image_builder.rb', line 255

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) 


119
120
121
 
# File 'app_stream/cfn_image_builder.rb', line 119

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:



653
654
655
 
# File 'app_stream/cfn_image_builder.rb', line 653

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:



660
661
662
 
# File 'app_stream/cfn_image_builder.rb', line 660

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.



453
454
455
456
 
# File 'app_stream/cfn_image_builder.rb', line 453

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) 


155
156
157
 
# File 'app_stream/cfn_image_builder.rb', line 155

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:



671
672
673
674
 
# File 'app_stream/cfn_image_builder.rb', line 671

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


678
679
680
681
 
# File 'app_stream/cfn_image_builder.rb', line 678

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:



688
689
690
691
692
 
# File 'app_stream/cfn_image_builder.rb', line 688

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

#root_volume_config ⇒ AWSCDK::IResolvable, ...

Returns:



370
371
372
 
# File 'app_stream/cfn_image_builder.rb', line 370

def root_volume_config()
  jsii_get_property("rootVolumeConfig")
end

#root_volume_config=(value) ⇒ Object 



374
375
376
377
378
 
# File 'app_stream/cfn_image_builder.rb', line 374

def root_volume_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnImageBuilder::VolumeConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuSW1hZ2VCdWlsZGVyLlZvbHVtZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "rootVolumeConfig") unless value.nil?
  jsii_set_property("rootVolumeConfig", 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.



697
698
699
 
# File 'app_stream/cfn_image_builder.rb', line 697

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

#softwares_to_install ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


381
382
383
 
# File 'app_stream/cfn_image_builder.rb', line 381

def softwares_to_install()
  jsii_get_property("softwaresToInstall")
end

#softwares_to_install=(value) ⇒ Object 



385
386
387
388
 
# File 'app_stream/cfn_image_builder.rb', line 385

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

#softwares_to_uninstall ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


391
392
393
 
# File 'app_stream/cfn_image_builder.rb', line 391

def softwares_to_uninstall()
  jsii_get_property("softwaresToUninstall")
end

#softwares_to_uninstall=(value) ⇒ Object 



395
396
397
398
 
# File 'app_stream/cfn_image_builder.rb', line 395

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



145
146
147
 
# File 'app_stream/cfn_image_builder.rb', line 145

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



230
231
232
 
# File 'app_stream/cfn_image_builder.rb', line 230

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs.

Returns:



403
404
405
 
# File 'app_stream/cfn_image_builder.rb', line 403

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



407
408
409
410
411
 
# File 'app_stream/cfn_image_builder.rb', line 407

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "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



429
430
431
 
# File 'app_stream/cfn_image_builder.rb', line 429

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


192
193
194
 
# File 'app_stream/cfn_image_builder.rb', line 192

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


202
203
204
 
# File 'app_stream/cfn_image_builder.rb', line 202

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


703
704
705
706
 
# File 'app_stream/cfn_image_builder.rb', line 703

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

#vpc_config ⇒ AWSCDK::IResolvable, ...

The VPC configuration for the image builder.

Returns:



416
417
418
 
# File 'app_stream/cfn_image_builder.rb', line 416

def vpc_config()
  jsii_get_property("vpcConfig")
end

#vpc_config=(value) ⇒ Object 



420
421
422
423
424
 
# File 'app_stream/cfn_image_builder.rb', line 420

def vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnImageBuilder::VPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuSW1hZ2VCdWlsZGVyLlZwY0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "vpcConfig") unless value.nil?
  jsii_set_property("vpcConfig", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


442
443
444
445
446
447
 
# File 'app_stream/cfn_image_builder.rb', line 442

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