1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. apigatewayv2
  6. PortalProduct

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi

    Represents a portal product in Amazon API Gateway V2, which is a logical grouping of APIs that can be published in a developer portal.

    Create PortalProduct Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PortalProduct(name: string, args: PortalProductArgs, opts?: CustomResourceOptions);
    @overload
    def PortalProduct(resource_name: str,
                      args: PortalProductArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def PortalProduct(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      display_name: Optional[str] = None,
                      description: Optional[str] = None,
                      tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewPortalProduct(ctx *Context, name string, args PortalProductArgs, opts ...ResourceOption) (*PortalProduct, error)
    public PortalProduct(string name, PortalProductArgs args, CustomResourceOptions? opts = null)
    public PortalProduct(String name, PortalProductArgs args)
    public PortalProduct(String name, PortalProductArgs args, CustomResourceOptions options)
    
    type: aws-native:apigatewayv2:PortalProduct
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_apigatewayv2_portal_product" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PortalProductArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PortalProductArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PortalProductArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalProductArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalProductArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    PortalProduct Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PortalProduct resource accepts the following input properties:

    DisplayName string
    The name of the portal product as it appears in a published portal.
    Description string
    A description of the portal product.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The collection of tags associated with the portal product.
    DisplayName string
    The name of the portal product as it appears in a published portal.
    Description string
    A description of the portal product.
    Tags TagArgs
    The collection of tags associated with the portal product.
    display_name string
    The name of the portal product as it appears in a published portal.
    description string
    A description of the portal product.
    tags list(object)
    The collection of tags associated with the portal product.
    displayName String
    The name of the portal product as it appears in a published portal.
    description String
    A description of the portal product.
    tags List<Tag>
    The collection of tags associated with the portal product.
    displayName string
    The name of the portal product as it appears in a published portal.
    description string
    A description of the portal product.
    tags Tag[]
    The collection of tags associated with the portal product.
    display_name str
    The name of the portal product as it appears in a published portal.
    description str
    A description of the portal product.
    tags Sequence[TagArgs]
    The collection of tags associated with the portal product.
    displayName String
    The name of the portal product as it appears in a published portal.
    description String
    A description of the portal product.
    tags List<Property Map>
    The collection of tags associated with the portal product.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PortalProduct resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LastModified string
    The timestamp when the portal product was last modified.
    PortalProductArn string
    The ARN of the portal product.
    PortalProductId string
    The portal product identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModified string
    The timestamp when the portal product was last modified.
    PortalProductArn string
    The ARN of the portal product.
    PortalProductId string
    The portal product identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    last_modified string
    The timestamp when the portal product was last modified.
    portal_product_arn string
    The ARN of the portal product.
    portal_product_id string
    The portal product identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModified String
    The timestamp when the portal product was last modified.
    portalProductArn String
    The ARN of the portal product.
    portalProductId String
    The portal product identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModified string
    The timestamp when the portal product was last modified.
    portalProductArn string
    The ARN of the portal product.
    portalProductId string
    The portal product identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified str
    The timestamp when the portal product was last modified.
    portal_product_arn str
    The ARN of the portal product.
    portal_product_id str
    The portal product identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModified String
    The timestamp when the portal product was last modified.
    portalProductArn String
    The ARN of the portal product.
    portalProductId String
    The portal product identifier.

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.76.0
    published on Monday, Aug 24, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial