AWS::ApiGatewayV2::PortalProduct

ApiGatewayV2 PortalProduct

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

Properties

3 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
DisplayName
string
Required
Description
string
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
LastModifiedstringThe timestamp when the portal product was last modified.
PortalProductArnstringThe ARN of the portal product.
PortalProductIdstringThe portal product identifier.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGatewayV2::PortalProduct

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::PortalProduct
    Properties:
      DisplayName: "my-displayname"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:CreatePortalProductapigateway:TagResourceapigateway:POST

read

apigateway:GetPortalProductapigateway:GetTagsapigateway:GET

update

apigateway:UpdatePortalProductapigateway:GetPortalProductapigateway:TagResourceapigateway:UntagResourceapigateway:GetTagsapigateway:GETapigateway:POSTapigateway:PATCHapigateway:DELETE

delete

apigateway:GetPortalProductapigateway:DeletePortalProductapigateway:GET

list

apigateway:ListPortalProductsapigateway:GET

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceApiGatewayV2
Properties6
Required1
TaggingSupported
Primary IDPortalProductArn

Supported Operations

CreateReadUpdateDeleteList

Related Resources

External Links