Skip to content

CreatePortalRequest

Source code in docs_src/capo_apigatewayv2/types/create_portal_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class CreatePortalRequest(TypedDict, closed=True):
    authorization: NotRequired["capo_apigatewayv2.types.authorization.Authorization"]
    """<p>The authentication configuration for the portal.</p>"""
    endpoint_configuration: NotRequired[
        "capo_apigatewayv2.types.endpoint_configuration_request.EndpointConfigurationRequest"
    ]
    """<p>The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.</p>"""
    included_portal_product_arns: NotRequired[
        "capo_apigatewayv2.types.__list_of__string_min20_max2048.__listOf__stringMin20Max2048"
    ]
    """<p>The ARNs of the portal products included in the portal.</p>"""
    logo_uri: NotRequired[
        "capo_apigatewayv2.types.__string_min0_max1092.__stringMin0Max1092"
    ]
    """<p>The URI for the portal logo image that is displayed in the portal header.</p>"""
    portal_content: NotRequired["capo_apigatewayv2.types.portal_content.PortalContent"]
    """<p>The content of the portal.</p>"""
    rum_app_monitor_name: NotRequired[
        "capo_apigatewayv2.types.__string_min0_max255.__stringMin0Max255"
    ]
    """<p>The name of the Amazon CloudWatch RUM app monitor for the portal.</p>"""
    tags: NotRequired["capo_apigatewayv2.types.tags.Tags"]
    """<p>The collection of tags. Each tag element is associated with a given resource.</p>"""

authorization instance-attribute 

authorization: NotRequired[Authorization]

The authentication configuration for the portal.

endpoint_configuration instance-attribute 

endpoint_configuration: NotRequired[EndpointConfigurationRequest]

The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.

included_portal_product_arns instance-attribute 

included_portal_product_arns: NotRequired[__listOf__stringMin20Max2048]

The ARNs of the portal products included in the portal.

logo_uri instance-attribute 

logo_uri: NotRequired[__stringMin0Max1092]

The URI for the portal logo image that is displayed in the portal header.

portal_content instance-attribute 

portal_content: NotRequired[PortalContent]

The content of the portal.

rum_app_monitor_name instance-attribute 

rum_app_monitor_name: NotRequired[__stringMin0Max255]

The name of the Amazon CloudWatch RUM app monitor for the portal.

tags instance-attribute 

tags: NotRequired[Tags]

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