Package software.amazon.awscdk.services.servicecatalog

Class Product

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.servicecatalog.Product

All Implemented Interfaces:

IConstruct, IDependable, IResource, IProduct, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

CloudFormationProduct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.798Z")
@Stability(Stable)
public abstract class Product
extends Resource
implements IProduct

Abstract class for Service Catalog Product.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.servicecatalog.*;
 IProduct product = Product.fromProductArn(this, "MyProduct", "productArn");
 

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.servicecatalog.IProduct

IProduct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Product(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Product(software.amazon.jsii.JsiiObjectRef objRef)
protected	Product(software.constructs.Construct scope, String id)
protected	Product(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
void	associateTagOptions(TagOptions tagOptions)	Associate Tag Options.
static IProduct	fromProductArn(software.constructs.Construct scope, String id, String productArn)	Creates a Product construct that represents an external product.
abstract String	getProductArn()	The ARN of the product.
abstract String	getProductId()	The id of the product.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Product

protected Product(software.amazon.jsii.JsiiObjectRef objRef)

Product

protected Product(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Product

@Stability(Stable)
protected Product(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Product

@Stability(Stable)
protected Product(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromProductArn

@Stability(Stable)
@NotNull
public static IProduct fromProductArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String productArn)

Creates a Product construct that represents an external product.

Parameters:

scope - The parent creating construct (usually this). This parameter is required.

id - The construct's name. This parameter is required.

productArn - Product Arn. This parameter is required.

associateTagOptions

@Stability(Stable)
public void associateTagOptions(@NotNull
 TagOptions tagOptions)

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.

Specified by:

associateTagOptions in interface IProduct

Parameters:

tagOptions - This parameter is required.

getProductArn

@Stability(Stable)
@NotNull
public abstract String getProductArn()

The ARN of the product.

Specified by:

getProductArn in interface IProduct

getProductId

@Stability(Stable)
@NotNull
public abstract String getProductId()

The id of the product.

Specified by:

getProductId in interface IProduct