CfnPortalProductProps

class aws_cdk.aws_apigatewayv2.CfnPortalProductProps(*, display_name, description=None, tags=None)

Bases: object

Properties for defining a CfnPortalProduct.

Parameters:

• display_name (str) – The name of the portal product as it appears in a published portal.

• description (Optional[str]) – A description of the portal product.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The collection of tags associated with the portal product.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

cfn_portal_product_props = apigatewayv2.CfnPortalProductProps(
    display_name="displayName",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of the portal product.

See:

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

display_name

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

See:

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

tags

The collection of tags associated with the portal product.

See:

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