Class: AWSCDK::ServiceCatalog::CfnCloudFormationProvisionedProduct

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

Overview

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a AWS CloudFormation template launches a AWS CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord .

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[ N ]: Value ".

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnCloudFormationProvisionedProduct

Create a new AWS::ServiceCatalog::CloudFormationProvisionedProduct.

Parameters:



22
23
24
25
26
27
28
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 22

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ServiceCatalog::CfnCloudFormationProvisionedProductProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuQ2ZuQ2xvdWRGb3JtYXRpb25Qcm92aXNpb25lZFByb2R1Y3RQcm9wcyJ9")), "props") unless props.nil?
  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) 


190
191
192
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 190

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

.is_cfn_cloud_formation_provisioned_product(x) ⇒ Boolean

Checks whether the given object is a CfnCloudFormationProvisionedProduct.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 92

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

.jsii_overridable_methods ⇒ Object 



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

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_cloudformation_stack_arn => { kind: :property, name: "attrCloudformationStackArn", is_optional: false },
    :attr_outputs => { kind: :property, name: "attrOutputs", is_optional: false },
    :attr_provisioned_product_id => { kind: :property, name: "attrProvisionedProductId", is_optional: false },
    :attr_record_id => { kind: :property, name: "attrRecordId", is_optional: false },
    :cloud_formation_provisioned_product_ref => { kind: :property, name: "cloudFormationProvisionedProductRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :accept_language => { kind: :property, name: "acceptLanguage", is_optional: true },
    :notification_arns => { kind: :property, name: "notificationArns", is_optional: true },
    :path_id => { kind: :property, name: "pathId", is_optional: true },
    :path_name => { kind: :property, name: "pathName", is_optional: true },
    :product_id => { kind: :property, name: "productId", is_optional: true },
    :product_name => { kind: :property, name: "productName", is_optional: true },
    :provisioned_product_name => { kind: :property, name: "provisionedProductName", is_optional: true },
    :provisioning_artifact_id => { kind: :property, name: "provisioningArtifactId", is_optional: true },
    :provisioning_artifact_name => { kind: :property, name: "provisioningArtifactName", is_optional: true },
    :provisioning_parameters => { kind: :property, name: "provisioningParameters", is_optional: true },
    :provisioning_preferences => { kind: :property, name: "provisioningPreferences", 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) 


237
238
239
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 237

def accept_language()
  jsii_get_property("acceptLanguage")
end

#accept_language=(value) ⇒ Object 



241
242
243
244
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 241

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.



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

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:



428
429
430
431
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 428

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:



438
439
440
441
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 438

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:



449
450
451
452
453
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 449

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.


506
507
508
509
510
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 506

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.



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

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.



528
529
530
531
532
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 528

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:



541
542
543
544
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 541

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:



563
564
565
566
567
568
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 563

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

Returns:

  • (String) 


195
196
197
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 195

def attr_cloudformation_stack_arn()
  jsii_get_property("attrCloudformationStackArn")
end

#attr_outputs ⇒ AWSCDK::IResolvable

List of key-value pair outputs.

Returns:



202
203
204
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 202

def attr_outputs()
  jsii_get_property("attrOutputs")
end

#attr_provisioned_product_id ⇒ String

The ID of the provisioned product.

Returns:

  • (String) 


209
210
211
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 209

def attr_provisioned_product_id()
  jsii_get_property("attrProvisionedProductId")
end

#attr_record_id ⇒ String

The ID of the record, such as rec-rjeatvy434trk .

Returns:

  • (String) 


216
217
218
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 216

def attr_record_id()
  jsii_get_property("attrRecordId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



143
144
145
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


572
573
574
575
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 572

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


153
154
155
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cloud_formation_provisioned_product_ref ⇒ AWSCDK::Interfaces::AWSServicecatalog::CloudFormationProvisionedProductReference

A reference to a CloudFormationProvisionedProduct resource.

Returns:



223
224
225
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 223

def cloud_formation_provisioned_product_ref()
  jsii_get_property("cloudFormationProvisionedProductRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



165
166
167
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 165

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:



585
586
587
588
589
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 585

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:



596
597
598
599
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 596

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:



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

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) 


117
118
119
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 100

def node()
  jsii_get_property("node")
end

#notification_arns ⇒ Array<String>?

Passed to AWS CloudFormation .

Returns:

  • (Array<String>, nil) 


249
250
251
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 249

def notification_arns()
  jsii_get_property("notificationArns")
end

#notification_arns=(value) ⇒ Object 



253
254
255
256
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 253

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



607
608
609
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 607

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:



614
615
616
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 614

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.



407
408
409
410
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 407

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

#path_id ⇒ String?

The path identifier of the product.

Returns:

  • (String, nil) 


261
262
263
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 261

def path_id()
  jsii_get_property("pathId")
end

#path_id=(value) ⇒ Object 



265
266
267
268
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 265

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

#path_name ⇒ String?

The name of the path.

Returns:

  • (String, nil) 


273
274
275
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 273

def path_name()
  jsii_get_property("pathName")
end

#path_name=(value) ⇒ Object 



277
278
279
280
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 277

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

#product_id ⇒ String?

The product identifier.

Returns:

  • (String, nil) 


285
286
287
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 285

def product_id()
  jsii_get_property("productId")
end

#product_id=(value) ⇒ Object 



289
290
291
292
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 289

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

#product_name ⇒ String?

The name of the Service Catalog product.

Returns:

  • (String, nil) 


297
298
299
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 297

def product_name()
  jsii_get_property("productName")
end

#product_name=(value) ⇒ Object 



301
302
303
304
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 301

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

#provisioned_product_name ⇒ String?

A user-friendly name for the provisioned product.

Returns:

  • (String, nil) 


309
310
311
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 309

def provisioned_product_name()
  jsii_get_property("provisionedProductName")
end

#provisioned_product_name=(value) ⇒ Object 



313
314
315
316
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 313

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

#provisioning_artifact_id ⇒ String?

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

Returns:

  • (String, nil) 


321
322
323
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 321

def provisioning_artifact_id()
  jsii_get_property("provisioningArtifactId")
end

#provisioning_artifact_id=(value) ⇒ Object 



325
326
327
328
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 325

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

#provisioning_artifact_name ⇒ String?

The name of the provisioning artifact (also known as a version) for the product.

Returns:

  • (String, nil) 


333
334
335
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 333

def provisioning_artifact_name()
  jsii_get_property("provisioningArtifactName")
end

#provisioning_artifact_name=(value) ⇒ Object 



337
338
339
340
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 337

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

#provisioning_parameters ⇒ AWSCDK::IResolvable, ...

Parameters specified by the administrator that are required for provisioning the product.

Returns:



345
346
347
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 345

def provisioning_parameters()
  jsii_get_property("provisioningParameters")
end

#provisioning_parameters=(value) ⇒ Object 



349
350
351
352
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 349

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

#provisioning_preferences ⇒ AWSCDK::IResolvable, ...

StackSet preferences that are required for provisioning the product or updating a provisioned product.

Returns:



357
358
359
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 357

def provisioning_preferences()
  jsii_get_property("provisioningPreferences")
end

#provisioning_preferences=(value) ⇒ Object 



361
362
363
364
365
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 361

def provisioning_preferences=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ServiceCatalog::CfnCloudFormationProvisionedProduct::ProvisioningPreferencesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXJ2aWNlY2F0YWxvZy5DZm5DbG91ZEZvcm1hdGlvblByb3Zpc2lvbmVkUHJvZHVjdC5Qcm92aXNpb25pbmdQcmVmZXJlbmNlc1Byb3BlcnR5In1dfX0=")), "provisioningPreferences") unless value.nil?
  jsii_set_property("provisioningPreferences", 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) 


136
137
138
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 136

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:



625
626
627
628
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 625

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


632
633
634
635
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 632

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:



642
643
644
645
646
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 642

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

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



651
652
653
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 651

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:



126
127
128
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 126

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



230
231
232
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 230

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

One or more tags.

Returns:



370
371
372
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 370

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



374
375
376
377
378
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 374

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



383
384
385
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 383

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


173
174
175
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 173

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


183
184
185
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


657
658
659
660
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 657

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) 


396
397
398
399
400
401
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product.rb', line 396

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