Package software.amazon.awscdk.services.apigatewayv2

Class CfnPortalProduct

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnPortalProduct
All Implemented Interfaces:
IInspectable, IPortalProductRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:02.412Z") @Stability(Stable) public class CfnPortalProduct extends CfnResource implements IInspectable, IPortalProductRef, ITaggableV2
Represents a portal product in Amazon API Gateway V2, which is a logical grouping of APIs that can be published in a developer portal.

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.apigatewayv2.*;
 CfnPortalProduct cfnPortalProduct = CfnPortalProduct.Builder.create(this, "MyCfnPortalProduct")
         .displayName("displayName")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPortalProduct

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

    • CfnPortalProduct

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

    • CfnPortalProduct

      @Stability(Stable) public CfnPortalProduct(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPortalProductProps props)
      Create a new AWS::ApiGatewayV2::PortalProduct.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForPortalProduct

      @Stability(Stable) @NotNull public static String arnForPortalProduct(@NotNull IPortalProductRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPortalProduct

      @Stability(Stable) @NotNull public static Boolean isCfnPortalProduct(@NotNull Object x)
      Checks whether the given object is a CfnPortalProduct.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrLastModified

      @Stability(Stable) @NotNull public String getAttrLastModified()
      The timestamp when the portal product was last modified.

    • getAttrPortalProductArn

      @Stability(Stable) @NotNull public String getAttrPortalProductArn()
      The ARN of the portal product.

    • getAttrPortalProductId

      @Stability(Stable) @NotNull public String getAttrPortalProductId()
      The portal product identifier.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getPortalProductRef

      @Stability(Stable) @NotNull public PortalProductReference getPortalProductRef()
      A reference to a PortalProduct resource.
      Specified by:
      getPortalProductRef in interface IPortalProductRef

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The name of the portal product as it appears in a published portal.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The name of the portal product as it appears in a published portal.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the portal product.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the portal product.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The collection of tags associated with the portal product.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The collection of tags associated with the portal product.