interface CfnPortalProductProps

Language	Type name
.NET	`Amazon.CDK.AWS.Apigatewayv2.CfnPortalProductProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnPortalProductProps`
Java	`software.amazon.awscdk.services.apigatewayv2.CfnPortalProductProps`
Python	`aws_cdk.aws_apigatewayv2.CfnPortalProductProps`
TypeScript	`aws-cdk-lib` » `aws_apigatewayv2` » `CfnPortalProductProps`

Properties for defining a CfnPortalProduct.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-portalproduct.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const cfnPortalProductProps: apigatewayv2.CfnPortalProductProps = {
  displayName: 'displayName',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
displayName	`string`	The name of the portal product as it appears in a published portal.
description?	`string`	A description of the portal product.
tags?	`CfnTag[]`	The collection of tags associated with the portal product.

displayName

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-portalproduct.html#cfn-apigatewayv2-portalproduct-displayname

description?

Type: string (optional)

A description of the portal product.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-portalproduct.html#cfn-apigatewayv2-portalproduct-description

tags?

Type: CfnTag[] (optional)

The collection of tags associated with the portal product.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-portalproduct.html#cfn-apigatewayv2-portalproduct-tags

AWS CDK