We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- Display
Name string - The name of the portal product as it appears in a published portal.
- Description string
- A description of the portal product.
-
List<Pulumi.
Aws Native. Inputs. Tag> - 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.
-
Tag
Args - 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.
- list(object)
- 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.
- List<Tag>
- 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.
- 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.
-
Sequence[Tag
Args] - 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.
- 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.
- Last
Modified string - The timestamp when the portal product was last modified.
- Portal
Product stringArn - The ARN of the portal product.
- Portal
Product stringId - 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 stringArn - The ARN of the portal product.
- Portal
Product stringId - 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_ stringarn - The ARN of the portal product.
- portal_
product_ stringid - 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 StringArn - The ARN of the portal product.
- portal
Product StringId - 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 stringArn - The ARN of the portal product.
- portal
Product stringId - 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_ strarn - The ARN of the portal product.
- portal_
product_ strid - 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 StringArn - The ARN of the portal product.
- portal
Product StringId - The portal product identifier.
Supporting Types
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi