View a markdown version of this page

AWS::ApiGatewayV2::PortalProduct - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ApiGatewayV2::PortalProduct

Creates a new portal product.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ApiGatewayV2::PortalProduct",
  "Properties" : {
      "Description" : String,
      "DisplayName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::ApiGatewayV2::PortalProduct
Properties:
  Description: String
  DisplayName: String
  Tags: 
    - Tag

Properties

Description

A description of the portal product.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

DisplayName

The name of the portal product as it appears in a published portal.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Tags

The collection of tags. Each tag element is associated with a given resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

LastModified

The timestamp when the portal product was last modified.

PortalProductArn

The ARN of the portal product.

PortalProductId

The portal product identifier.