Class: AWSCDK::Panorama::CfnApplicationInstance

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSPanorama::IApplicationInstanceRef
Defined in:
panorama/cfn_application_instance.rb

Overview

End of support notice: On May 31, 2026, AWS will end support for AWS Panorama .

After May 31, 2026,

you will no longer be able to access the AWS Panorama console or AWS Panorama resources. For more information, see AWS Panorama end of support .

Creates an application instance and deploys it to a device.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnApplicationInstance

Create a new AWS::Panorama::ApplicationInstance.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Panorama::CfnApplicationInstanceProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'panorama/cfn_application_instance.rb', line 24

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

Class Method Details

.arn_for_application_instance(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'panorama/cfn_application_instance.rb', line 92

def self.arn_for_application_instance(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19wYW5vcmFtYS5JQXBwbGljYXRpb25JbnN0YW5jZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_panorama.CfnApplicationInstance", "arnForApplicationInstance", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


225
226
227
 
# File 'panorama/cfn_application_instance.rb', line 225

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

.from_application_instance_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSPanorama::IApplicationInstanceRef

Creates a new IApplicationInstanceRef from an ARN.

Parameters:

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

Returns:



103
104
105
106
107
108
 
# File 'panorama/cfn_application_instance.rb', line 103

def self.from_application_instance_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_panorama.CfnApplicationInstance", "fromApplicationInstanceArn", [scope, id, arn])
end

.from_application_instance_id(scope, id, application_instance_id) ⇒ AWSCDK::Interfaces::AWSPanorama::IApplicationInstanceRef

Creates a new IApplicationInstanceRef from a applicationInstanceId.

Parameters:

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

Returns:



116
117
118
119
120
121
 
# File 'panorama/cfn_application_instance.rb', line 116

def self.from_application_instance_id(scope, id, application_instance_id)
  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(application_instance_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationInstanceId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_panorama.CfnApplicationInstance", "fromApplicationInstanceId", [scope, id, application_instance_id])
end

.is_cfn_application_instance(x) ⇒ Boolean

Checks whether the given object is a CfnApplicationInstance.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


127
128
129
130
 
# File 'panorama/cfn_application_instance.rb', line 127

def self.is_cfn_application_instance(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_panorama.CfnApplicationInstance", "isCfnApplicationInstance", [x])
end

.jsii_overridable_methods ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'panorama/cfn_application_instance.rb', line 32

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 },
    :application_instance_ref => { kind: :property, name: "applicationInstanceRef", is_optional: false },
    :attr_application_instance_id => { kind: :property, name: "attrApplicationInstanceId", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_created_time => { kind: :property, name: "attrCreatedTime", is_optional: false },
    :attr_default_runtime_context_device_name => { kind: :property, name: "attrDefaultRuntimeContextDeviceName", is_optional: false },
    :attr_health_status => { kind: :property, name: "attrHealthStatus", is_optional: false },
    :attr_last_updated_time => { kind: :property, name: "attrLastUpdatedTime", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_description => { kind: :property, name: "attrStatusDescription", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :default_runtime_context_device => { kind: :property, name: "defaultRuntimeContextDevice", is_optional: false },
    :manifest_payload => { kind: :property, name: "manifestPayload", is_optional: false },
    :application_instance_id_to_replace => { kind: :property, name: "applicationInstanceIdToReplace", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :manifest_overrides_payload => { kind: :property, name: "manifestOverridesPayload", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :runtime_role_arn => { kind: :property, name: "runtimeRoleArn", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



434
435
436
437
 
# File 'panorama/cfn_application_instance.rb', line 434

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:



446
447
448
449
 
# File 'panorama/cfn_application_instance.rb', line 446

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:



456
457
458
459
 
# File 'panorama/cfn_application_instance.rb', line 456

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:



467
468
469
470
471
 
# File 'panorama/cfn_application_instance.rb', line 467

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.


524
525
526
527
528
 
# File 'panorama/cfn_application_instance.rb', line 524

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.



534
535
536
537
 
# File 'panorama/cfn_application_instance.rb', line 534

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.



546
547
548
549
550
 
# File 'panorama/cfn_application_instance.rb', line 546

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

#application_instance_id_to_replace ⇒ String?

The ID of an application instance to replace with the new instance.

Returns:

  • (String, nil) 


327
328
329
 
# File 'panorama/cfn_application_instance.rb', line 327

def application_instance_id_to_replace()
  jsii_get_property("applicationInstanceIdToReplace")
end

#application_instance_id_to_replace=(value) ⇒ Object 



331
332
333
334
 
# File 'panorama/cfn_application_instance.rb', line 331

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

#application_instance_ref ⇒ AWSCDK::Interfaces::AWSPanorama::ApplicationInstanceReference

A reference to a ApplicationInstance resource.

Returns:



232
233
234
 
# File 'panorama/cfn_application_instance.rb', line 232

def application_instance_ref()
  jsii_get_property("applicationInstanceRef")
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:



559
560
561
562
 
# File 'panorama/cfn_application_instance.rb', line 559

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:



581
582
583
584
585
586
 
# File 'panorama/cfn_application_instance.rb', line 581

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_application_instance_id ⇒ String

The application instance's ID.

Returns:

  • (String) 


239
240
241
 
# File 'panorama/cfn_application_instance.rb', line 239

def attr_application_instance_id()
  jsii_get_property("attrApplicationInstanceId")
end

#attr_arn ⇒ String

The application instance's ARN.

Returns:

  • (String) 


246
247
248
 
# File 'panorama/cfn_application_instance.rb', line 246

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_time ⇒ Numeric

The application instance's created time.

Returns:

  • (Numeric) 


253
254
255
 
# File 'panorama/cfn_application_instance.rb', line 253

def attr_created_time()
  jsii_get_property("attrCreatedTime")
end

#attr_default_runtime_context_device_name ⇒ String

The application instance's default runtime context device name.

Returns:

  • (String) 


260
261
262
 
# File 'panorama/cfn_application_instance.rb', line 260

def attr_default_runtime_context_device_name()
  jsii_get_property("attrDefaultRuntimeContextDeviceName")
end

#attr_health_status ⇒ String

The application instance's health status.

Returns:

  • (String) 


267
268
269
 
# File 'panorama/cfn_application_instance.rb', line 267

def attr_health_status()
  jsii_get_property("attrHealthStatus")
end

#attr_last_updated_time ⇒ Numeric

The application instance's last updated time.

Returns:

  • (Numeric) 


274
275
276
 
# File 'panorama/cfn_application_instance.rb', line 274

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_status ⇒ String

The application instance's status.

Returns:

  • (String) 


281
282
283
 
# File 'panorama/cfn_application_instance.rb', line 281

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_description ⇒ String

The application instance's status description.

Returns:

  • (String) 


288
289
290
 
# File 'panorama/cfn_application_instance.rb', line 288

def attr_status_description()
  jsii_get_property("attrStatusDescription")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



178
179
180
 
# File 'panorama/cfn_application_instance.rb', line 178

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'panorama/cfn_application_instance.rb', line 183

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


590
591
592
593
 
# File 'panorama/cfn_application_instance.rb', line 590

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


188
189
190
 
# File 'panorama/cfn_application_instance.rb', line 188

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


195
196
197
 
# File 'panorama/cfn_application_instance.rb', line 195

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


140
141
142
 
# File 'panorama/cfn_application_instance.rb', line 140

def creation_stack()
  jsii_get_property("creationStack")
end

#default_runtime_context_device ⇒ String

The device's ID.

Returns:

  • (String) 


302
303
304
 
# File 'panorama/cfn_application_instance.rb', line 302

def default_runtime_context_device()
  jsii_get_property("defaultRuntimeContextDevice")
end

#default_runtime_context_device=(value) ⇒ Object 



306
307
308
309
 
# File 'panorama/cfn_application_instance.rb', line 306

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

#description ⇒ String?

A description for the application instance.

Returns:

  • (String, nil) 


339
340
341
 
# File 'panorama/cfn_application_instance.rb', line 339

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



343
344
345
346
 
# File 'panorama/cfn_application_instance.rb', line 343

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:



200
201
202
 
# File 'panorama/cfn_application_instance.rb', line 200

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:



603
604
605
606
607
 
# File 'panorama/cfn_application_instance.rb', line 603

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:



614
615
616
617
 
# File 'panorama/cfn_application_instance.rb', line 614

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



684
685
686
687
 
# File 'panorama/cfn_application_instance.rb', line 684

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


152
153
154
 
# File 'panorama/cfn_application_instance.rb', line 152

def logical_id()
  jsii_get_property("logicalId")
end

#manifest_overrides_payload ⇒ AWSCDK::IResolvable, ...

Setting overrides for the application manifest.

Returns:



351
352
353
 
# File 'panorama/cfn_application_instance.rb', line 351

def manifest_overrides_payload()
  jsii_get_property("manifestOverridesPayload")
end

#manifest_overrides_payload=(value) ⇒ Object 



355
356
357
358
359
 
# File 'panorama/cfn_application_instance.rb', line 355

def manifest_overrides_payload=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Panorama::CfnApplicationInstance::ManifestOverridesPayloadProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19wYW5vcmFtYS5DZm5BcHBsaWNhdGlvbkluc3RhbmNlLk1hbmlmZXN0T3ZlcnJpZGVzUGF5bG9hZFByb3BlcnR5In1dfX0=")), "manifestOverridesPayload") unless value.nil?
  jsii_set_property("manifestOverridesPayload", value)
end

#manifest_payload ⇒ AWSCDK::IResolvable, AWSCDK::Panorama::CfnApplicationInstance::ManifestPayloadProperty

The application's manifest document.

Returns:



314
315
316
 
# File 'panorama/cfn_application_instance.rb', line 314

def manifest_payload()
  jsii_get_property("manifestPayload")
end

#manifest_payload=(value) ⇒ Object 



318
319
320
321
322
 
# File 'panorama/cfn_application_instance.rb', line 318

def manifest_payload=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Panorama::CfnApplicationInstance::ManifestPayloadProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19wYW5vcmFtYS5DZm5BcHBsaWNhdGlvbkluc3RhbmNlLk1hbmlmZXN0UGF5bG9hZFByb3BlcnR5In1dfX0=")), "manifestPayload")
  jsii_set_property("manifestPayload", value)
end

#name ⇒ String?

A name for the application instance.

Returns:

  • (String, nil) 


364
365
366
 
# File 'panorama/cfn_application_instance.rb', line 364

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



368
369
370
371
 
# File 'panorama/cfn_application_instance.rb', line 368

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


135
136
137
 
# File 'panorama/cfn_application_instance.rb', line 135

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:



625
626
627
 
# File 'panorama/cfn_application_instance.rb', line 625

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:



632
633
634
 
# File 'panorama/cfn_application_instance.rb', line 632

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.



425
426
427
428
 
# File 'panorama/cfn_application_instance.rb', line 425

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) 


171
172
173
 
# File 'panorama/cfn_application_instance.rb', line 171

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:



643
644
645
646
 
# File 'panorama/cfn_application_instance.rb', line 643

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


650
651
652
653
 
# File 'panorama/cfn_application_instance.rb', line 650

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:



660
661
662
663
664
 
# File 'panorama/cfn_application_instance.rb', line 660

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

#runtime_role_arn ⇒ String?

The ARN of a runtime role for the application instance.

Returns:

  • (String, nil) 


376
377
378
 
# File 'panorama/cfn_application_instance.rb', line 376

def runtime_role_arn()
  jsii_get_property("runtimeRoleArn")
end

#runtime_role_arn=(value) ⇒ Object 



380
381
382
383
 
# File 'panorama/cfn_application_instance.rb', line 380

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



669
670
671
 
# File 'panorama/cfn_application_instance.rb', line 669

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:



161
162
163
 
# File 'panorama/cfn_application_instance.rb', line 161

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



295
296
297
 
# File 'panorama/cfn_application_instance.rb', line 295

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Tags for the application instance.

Returns:



388
389
390
 
# File 'panorama/cfn_application_instance.rb', line 388

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



392
393
394
395
396
 
# File 'panorama/cfn_application_instance.rb', line 392

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



401
402
403
 
# File 'panorama/cfn_application_instance.rb', line 401

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


208
209
210
 
# File 'panorama/cfn_application_instance.rb', line 208

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


218
219
220
 
# File 'panorama/cfn_application_instance.rb', line 218

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


675
676
677
678
 
# File 'panorama/cfn_application_instance.rb', line 675

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) 


414
415
416
417
418
419
 
# File 'panorama/cfn_application_instance.rb', line 414

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