Class: AWSCDK::ServiceCatalog::CfnCloudFormationProduct

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSServicecatalog::ICloudFormationProductRef
Defined in:
service_catalog/cfn_cloud_formation_product.rb

Overview

Specifies a product.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCloudFormationProduct

Create a new AWS::ServiceCatalog::CloudFormationProduct.

Parameters:



18
19
20
21
22
23
24
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 18

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


187
188
189
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 187

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

.is_cfn_cloud_formation_product(x) ⇒ Boolean

Checks whether the given object is a CfnCloudFormationProduct.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


89
90
91
92
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 89

def self.is_cfn_cloud_formation_product(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_servicecatalog.CfnCloudFormationProduct", "isCfnCloudFormationProduct", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 26

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_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_product_name => { kind: :property, name: "attrProductName", is_optional: false },
    :attr_provisioning_artifact_ids => { kind: :property, name: "attrProvisioningArtifactIds", is_optional: false },
    :attr_provisioning_artifact_names => { kind: :property, name: "attrProvisioningArtifactNames", is_optional: false },
    :cloud_formation_product_ref => { kind: :property, name: "cloudFormationProductRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :owner => { kind: :property, name: "owner", is_optional: false },
    :accept_language => { kind: :property, name: "acceptLanguage", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :distributor => { kind: :property, name: "distributor", is_optional: true },
    :product_type => { kind: :property, name: "productType", is_optional: true },
    :provisioning_artifact_parameters => { kind: :property, name: "provisioningArtifactParameters", is_optional: true },
    :replace_provisioning_artifacts => { kind: :property, name: "replaceProvisioningArtifacts", is_optional: true },
    :source_connection => { kind: :property, name: "sourceConnection", is_optional: true },
    :support_description => { kind: :property, name: "supportDescription", is_optional: true },
    :support_email => { kind: :property, name: "supportEmail", is_optional: true },
    :support_url => { kind: :property, name: "supportUrl", 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

#accept_language ⇒ String?

The language code.

Returns:

  • (String, nil) 


258
259
260
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 258

def accept_language()
  jsii_get_property("acceptLanguage")
end

#accept_language=(value) ⇒ Object 



262
263
264
265
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 262

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



425
426
427
428
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 425

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:



437
438
439
440
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 437

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:



447
448
449
450
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 447

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:



458
459
460
461
462
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 458

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.


515
516
517
518
519
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 515

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.



525
526
527
528
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 525

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.



537
538
539
540
541
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 537

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:



550
551
552
553
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 550

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:



572
573
574
575
576
577
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 572

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

Returns:

  • (String) 


192
193
194
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 192

def attr_id()
  jsii_get_property("attrId")
end

#attr_product_name ⇒ String

The name of the product.

Returns:

  • (String) 


199
200
201
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 199

def attr_product_name()
  jsii_get_property("attrProductName")
end

#attr_provisioning_artifact_ids ⇒ String

The IDs of the provisioning artifacts.

Returns:

  • (String) 


206
207
208
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 206

def attr_provisioning_artifact_ids()
  jsii_get_property("attrProvisioningArtifactIds")
end

#attr_provisioning_artifact_names ⇒ String

The names of the provisioning artifacts.

Returns:

  • (String) 


213
214
215
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 213

def attr_provisioning_artifact_names()
  jsii_get_property("attrProvisioningArtifactNames")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



140
141
142
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 140

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


145
146
147
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 145

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


581
582
583
584
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 581

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


150
151
152
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 150

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


157
158
159
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 157

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cloud_formation_product_ref ⇒ AWSCDK::Interfaces::AWSServicecatalog::CloudFormationProductReference

A reference to a CloudFormationProduct resource.

Returns:



220
221
222
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 220

def cloud_formation_product_ref()
  jsii_get_property("cloudFormationProductRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


102
103
104
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 102

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the product.

Returns:

  • (String, nil) 


270
271
272
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 270

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



274
275
276
277
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 274

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

#distributor ⇒ String?

The distributor of the product.

Returns:

  • (String, nil) 


282
283
284
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 282

def distributor()
  jsii_get_property("distributor")
end

#distributor=(value) ⇒ Object 



286
287
288
289
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 286

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



162
163
164
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 162

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:



594
595
596
597
598
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 594

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:



605
606
607
608
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 605

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:



675
676
677
678
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 675

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) 


114
115
116
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 114

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the product.

Returns:

  • (String) 


234
235
236
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 234

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



238
239
240
241
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 238

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) 


97
98
99
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 97

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:



616
617
618
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 616

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:



623
624
625
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 623

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.



416
417
418
419
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 416

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

#owner ⇒ String

The owner of the product.

Returns:

  • (String) 


246
247
248
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 246

def owner()
  jsii_get_property("owner")
end

#owner=(value) ⇒ Object 



250
251
252
253
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 250

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

#product_type ⇒ String?

The type of product.

Returns:

  • (String, nil) 


294
295
296
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 294

def product_type()
  jsii_get_property("productType")
end

#product_type=(value) ⇒ Object 



298
299
300
301
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 298

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

#provisioning_artifact_parameters ⇒ AWSCDK::IResolvable, ...

The configuration of the provisioning artifact (also known as a version).

Returns:



306
307
308
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 306

def provisioning_artifact_parameters()
  jsii_get_property("provisioningArtifactParameters")
end

#provisioning_artifact_parameters=(value) ⇒ Object 



310
311
312
313
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 310

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


133
134
135
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 133

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:



634
635
636
637
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 634

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


641
642
643
644
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 641

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:



651
652
653
654
655
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 651

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

#replace_provisioning_artifacts ⇒ Boolean, ...

This property is turned off by default.

Returns:



318
319
320
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 318

def replace_provisioning_artifacts()
  jsii_get_property("replaceProvisioningArtifacts")
end

#replace_provisioning_artifacts=(value) ⇒ Object 



322
323
324
325
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 322

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



660
661
662
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 660

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

#source_connection ⇒ AWSCDK::IResolvable, ...

A top level ProductViewDetail response containing details about the product’s connection.

Returns:



330
331
332
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 330

def source_connection()
  jsii_get_property("sourceConnection")
end

#source_connection=(value) ⇒ Object 



334
335
336
337
338
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 334

def source_connection=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ServiceCatalog::CfnCloudFormationProduct::SourceConnectionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXJ2aWNlY2F0YWxvZy5DZm5DbG91ZEZvcm1hdGlvblByb2R1Y3QuU291cmNlQ29ubmVjdGlvblByb3BlcnR5In1dfX0=")), "sourceConnection") unless value.nil?
  jsii_set_property("sourceConnection", 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:



123
124
125
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 123

def stack()
  jsii_get_property("stack")
end

#support_description ⇒ String?

The support information about the product.

Returns:

  • (String, nil) 


343
344
345
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 343

def support_description()
  jsii_get_property("supportDescription")
end

#support_description=(value) ⇒ Object 



347
348
349
350
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 347

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

#support_email ⇒ String?

The contact email for product support.

Returns:

  • (String, nil) 


355
356
357
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 355

def support_email()
  jsii_get_property("supportEmail")
end

#support_email=(value) ⇒ Object 



359
360
361
362
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 359

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

#support_url ⇒ String?

The contact URL for product support.

Returns:

  • (String, nil) 


367
368
369
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 367

def support_url()
  jsii_get_property("supportUrl")
end

#support_url=(value) ⇒ Object 



371
372
373
374
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 371

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



227
228
229
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 227

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

One or more tags.

Returns:



379
380
381
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 379

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



383
384
385
386
387
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 383

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



392
393
394
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 392

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


170
171
172
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 170

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


180
181
182
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 180

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


666
667
668
669
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 666

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) 


405
406
407
408
409
410
 
# File 'service_catalog/cfn_cloud_formation_product.rb', line 405

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