Module: AWSCDK::ServiceCatalog::IProduct

Includes:
IResource, Interfaces::AWSServicecatalog::ICloudFormationProductRef
Included in:
Product
Defined in:
service_catalog/i_product.rb

Overview

A Service Catalog product, currently only supports type CloudFormationProduct.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'service_catalog/i_product.rb', line 109

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :cloud_formation_product_ref => { kind: :property, name: "cloudFormationProductRef", is_optional: false },
    :asset_buckets => { kind: :property, name: "assetBuckets", is_optional: false },
    :product_arn => { kind: :property, name: "productArn", is_optional: false },
    :product_id => { kind: :property, name: "productId", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :associate_tag_options => { kind: :method, name: "associateTagOptions", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



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

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#asset_buckets ⇒ Array<AWSCDK::S3::IBucket>

The asset buckets of a product created via product stack.

Returns:



48
49
50
 
# File 'service_catalog/i_product.rb', line 48

def asset_buckets()
  jsii_get_property("assetBuckets")
end

#associate_tag_options(tag_options) ⇒ void

This method returns an undefined value.

Associate Tag Options.

A TagOption is a key-value pair managed in AWS Service Catalog. It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption.

Parameters:



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

def associate_tag_options(tag_options)
  Jsii::Type.check_type(tag_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuVGFnT3B0aW9ucyJ9")), "tagOptions")
  jsii_call_method("associateTagOptions", [tag_options])
end

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

A reference to a CloudFormationProduct resource.

Returns:



41
42
43
 
# File 'service_catalog/i_product.rb', line 41

def cloud_formation_product_ref()
  jsii_get_property("cloudFormationProductRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



27
28
29
 
# File 'service_catalog/i_product.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'service_catalog/i_product.rb', line 12

def node()
  jsii_get_property("node")
end

#product_arn ⇒ String

The ARN of the product.

Returns:

  • (String) 


55
56
57
 
# File 'service_catalog/i_product.rb', line 55

def product_arn()
  jsii_get_property("productArn")
end

#product_id ⇒ String

The id of the product.

Returns:

  • (String) 


62
63
64
 
# File 'service_catalog/i_product.rb', line 62

def product_id()
  jsii_get_property("productId")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'service_catalog/i_product.rb', line 34

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



73
74
75
76
77
78
 
# File 'service_catalog/i_product.rb', line 73

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