portals

Creates, updates, deletes, gets or lists a portals resource.

Overview

Name	portals
Type	Resource
Id	aws.apigatewayv2.portals

Fields

The following fields are returned by SELECT queries:

get_portal

Name	Datatype	Description
authorization	object	Represents an authorization configuration for a portal.
endpoint_configuration	object	The endpoint configuration.
included_portal_product_arns	array	The ARNs of the portal products included in the portal.
last_modified	string (date-time)	The timestamp when the portal was last modified.
last_published	string (date-time)	The timestamp when the portal was last published.
last_published_description	string	The publish description used when the portal was last published.
portal_arn	string	The ARN of the portal.
portal_content	object	Contains the content that is visible to portal consumers including the themes, display names, and description.
portal_id	string	The portal identifier. (pattern: <code>^[a-z0-9]+$</code>)
preview	object	Represents the preview endpoint and the any possible error messages during preview generation.
publish_status	string	The publish status of a portal. (PUBLISHED, PUBLISH_IN_PROGRESS, PUBLISH_FAILED, DISABLE_IN_PROGRESS, DISABLE_FAILED, DISABLED)
rum_app_monitor_name	string	The CloudWatch RUM app monitor name.
status_exception	object	The status exception information.
tags	object	The collection of tags. Each tag element is associated with a given resource.

list_portals

Name	Datatype	Description
authorization	object	Represents an authorization configuration for a portal.
endpoint_configuration	object	The endpoint configuration of the portal.
included_portal_product_arns	array	The ARNs of the portal products included in the portal.
last_modified	string (date-time)	The timestamp when the portal was last modified.
last_published	string (date-time)	The timestamp when the portal was last published.
last_published_description	string	The description of the portal the last time it was published.
portal_arn	string	The ARN of the portal.
portal_content	object	Contains the content that is visible to portal consumers including the themes, display names, and description.
portal_id	string	The portal identifier. (pattern: <code>^[a-z0-9]+$</code>)
preview	object	Represents the preview endpoint and the any possible error messages during preview generation.
publish_status	string	The publish status. (PUBLISHED, PUBLISH_IN_PROGRESS, PUBLISH_FAILED, DISABLE_IN_PROGRESS, DISABLE_FAILED, DISABLED)
rum_app_monitor_name	string	The CloudWatch RUM app monitor name.
status_exception	object	The status exception information.
tags	object	The collection of tags. Each tag element is associated with a given resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_portal	select	portal_id, region		Gets a portal.
list_portals	select	region	maxResults, nextToken	Lists portals.
create_portal	insert	region, EndpointConfiguration, PortalContent		Creates a portal.
update_portal	update	portal_id, region		Updates a portal.
delete_portal	delete	portal_id, region		Deletes a portal.
disable_portal	exec	portal_id, region		Deletes the publication of a portal portal.
publish_portal	exec	portal_id, region		Publishes a portal.
preview_portal	exec	portal_id, region		Creates a portal preview.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
portal_id	string	The portal identifier.
region	string	AWS region (default: us-east-1)
maxResults	string	The maximum number of elements to be returned for this resource.
nextToken	string	The next page of elements from this collection. Not valid for the last element of the collection.

SELECT examples

get_portal

Gets a portal.

SELECT
authorization,
endpoint_configuration,
included_portal_product_arns,
last_modified,
last_published,
last_published_description,
portal_arn,
portal_content,
portal_id,
preview,
publish_status,
rum_app_monitor_name,
status_exception,
tags
FROM aws.apigatewayv2.portals
WHERE portal_id = '{{ portal_id }}' -- required
AND region = '{{ region }}' -- required
;

list_portals

Lists portals.

SELECT
authorization,
endpoint_configuration,
included_portal_product_arns,
last_modified,
last_published,
last_published_description,
portal_arn,
portal_content,
portal_id,
preview,
publish_status,
rum_app_monitor_name,
status_exception,
tags
FROM aws.apigatewayv2.portals
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_portal

Creates a portal.

INSERT INTO aws.apigatewayv2.portals (
Authorization,
EndpointConfiguration,
IncludedPortalProductArns,
LogoUri,
PortalContent,
RumAppMonitorName,
Tags,
region
)
SELECT 
'{{ Authorization }}',
'{{ EndpointConfiguration }}' /* required */,
'{{ IncludedPortalProductArns }}',
'{{ LogoUri }}',
'{{ PortalContent }}' /* required */,
'{{ RumAppMonitorName }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
authorization,
endpoint_configuration,
included_portal_product_arns,
last_modified,
last_published,
last_published_description,
portal_arn,
portal_content,
portal_id,
publish_status,
rum_app_monitor_name,
status_exception,
tags
;

Manifest

# Description fields are for documentation purposes
- name: portals
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the portals resource.
  - name: Authorization
    description: |
      Represents an authorization configuration for a portal.
    value:
      CognitoConfig:
        AppClientId: "{{ AppClientId }}"
        UserPoolArn: "{{ UserPoolArn }}"
        UserPoolDomain: "{{ UserPoolDomain }}"
      None: "{{ None }}"
  - name: EndpointConfiguration
    description: |
      Represents an endpoint configuration.
    value:
      AcmManaged:
        CertificateArn: "{{ CertificateArn }}"
        DomainName: "{{ DomainName }}"
      None: "{{ None }}"
  - name: IncludedPortalProductArns
    value:
      - "{{ IncludedPortalProductArns }}"
  - name: LogoUri
    value: "{{ LogoUri }}"
  - name: PortalContent
    description: |
      Contains the content that is visible to portal consumers including the themes, display names, and description.
    value:
      Description: "{{ Description }}"
      DisplayName: "{{ DisplayName }}"
      Theme:
        CustomColors:
          AccentColor: "{{ AccentColor }}"
          BackgroundColor: "{{ BackgroundColor }}"
          ErrorValidationColor: "{{ ErrorValidationColor }}"
          HeaderColor: "{{ HeaderColor }}"
          NavigationColor: "{{ NavigationColor }}"
          TextColor: "{{ TextColor }}"
        LogoLastUploaded: "{{ LogoLastUploaded }}"
  - name: RumAppMonitorName
    value: "{{ RumAppMonitorName }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Represents a collection of tags associated with the resource.

UPDATE examples

update_portal

Updates a portal.

UPDATE aws.apigatewayv2.portals
SET 
Authorization = '{{ Authorization }}',
EndpointConfiguration = '{{ EndpointConfiguration }}',
IncludedPortalProductArns = '{{ IncludedPortalProductArns }}',
LogoUri = '{{ LogoUri }}',
PortalContent = '{{ PortalContent }}',
RumAppMonitorName = '{{ RumAppMonitorName }}'
WHERE 
portal_id = '{{ portal_id }}' --required
AND region = '{{ region }}' --required
RETURNING
authorization,
endpoint_configuration,
included_portal_product_arns,
last_modified,
last_published,
last_published_description,
portal_arn,
portal_content,
portal_id,
preview,
publish_status,
rum_app_monitor_name,
status_exception,
tags;

DELETE examples

delete_portal

Deletes a portal.

DELETE FROM aws.apigatewayv2.portals
WHERE portal_id = '{{ portal_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

disable_portal

Deletes the publication of a portal portal.

EXEC aws.apigatewayv2.portals.disable_portal 
@portal_id='{{ portal_id }}' --required, 
@region='{{ region }}' --required
;

publish_portal

Publishes a portal.

EXEC aws.apigatewayv2.portals.publish_portal 
@portal_id='{{ portal_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Description": "{{ Description }}"
}'
;

preview_portal

Creates a portal preview.

EXEC aws.apigatewayv2.portals.preview_portal 
@portal_id='{{ portal_id }}' --required, 
@region='{{ region }}' --required
;