Creates a portal¶

Description¶

Creates a portal.

Usage¶

apigatewayv2_create_portal(Authorization, EndpointConfiguration,
  IncludedPortalProductArns, LogoUri, PortalContent, RumAppMonitorName,
  Tags)

Arguments¶

Authorization

[required] The authentication configuration for the portal.
EndpointConfiguration

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

The ARNs of the portal products included in the portal.
LogoUri

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

[required] The content of the portal.
RumAppMonitorName

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

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

Value¶

A list with the following syntax:

list(
  Authorization = list(
    CognitoConfig = list(
      AppClientId = "string",
      UserPoolArn = "string",
      UserPoolDomain = "string"
    ),
    None = list()
  ),
  EndpointConfiguration = list(
    CertificateArn = "string",
    DomainName = "string",
    PortalDefaultDomainName = "string",
    PortalDomainHostedZoneId = "string"
  ),
  IncludedPortalProductArns = list(
    "string"
  ),
  LastModified = as.POSIXct(
    "2015-01-01"
  ),
  LastPublished = as.POSIXct(
    "2015-01-01"
  ),
  LastPublishedDescription = "string",
  PortalArn = "string",
  PortalContent = list(
    Description = "string",
    DisplayName = "string",
    Theme = list(
      CustomColors = list(
        AccentColor = "string",
        BackgroundColor = "string",
        ErrorValidationColor = "string",
        HeaderColor = "string",
        NavigationColor = "string",
        TextColor = "string"
      ),
      LogoLastUploaded = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  PortalId = "string",
  PublishStatus = "PUBLISHED"|"PUBLISH_IN_PROGRESS"|"PUBLISH_FAILED"|"DISABLE_IN_PROGRESS"|"DISABLE_FAILED"|"DISABLED",
  RumAppMonitorName = "string",
  StatusException = list(
    Exception = "string",
    Message = "string"
  ),
  Tags = list(
    "string"
  )
)

Request syntax¶

svc$create_portal(
  Authorization = list(
    CognitoConfig = list(
      AppClientId = "string",
      UserPoolArn = "string",
      UserPoolDomain = "string"
    ),
    None = list()
  ),
  EndpointConfiguration = list(
    AcmManaged = list(
      CertificateArn = "string",
      DomainName = "string"
    ),
    None = list()
  ),
  IncludedPortalProductArns = list(
    "string"
  ),
  LogoUri = "string",
  PortalContent = list(
    Description = "string",
    DisplayName = "string",
    Theme = list(
      CustomColors = list(
        AccentColor = "string",
        BackgroundColor = "string",
        ErrorValidationColor = "string",
        HeaderColor = "string",
        NavigationColor = "string",
        TextColor = "string"
      ),
      LogoLastUploaded = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  RumAppMonitorName = "string",
  Tags = list(
    "string"
  )
)