aws_iotsitewise_portal

account_id

Type: STRING

alarms

Type: STRUCT
Provider name: alarms
Description: Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

• alarm_role_arn
  Type: STRING
  Provider name: alarmRoleArn
  Description: The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
  
• notification_lambda_arn
  Type: STRING
  Provider name: notificationLambdaArn
  Description: The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.
  

notification_sender_email

Type: STRING
Provider name: notificationSenderEmail
Description: The email address that sends alarm notifications.

portal_arn

Type: STRING
Provider name: portalArn
Description: The ARN of the portal, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

portal_auth_mode

Type: STRING
Provider name: portalAuthMode
Description: The service to use to authenticate users to the portal.

portal_client_id

Type: STRING
Provider name: portalClientId
Description: The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.

portal_contact_email

Type: STRING
Provider name: portalContactEmail
Description: The Amazon Web Services administrator’s contact email address.

portal_creation_date

Type: TIMESTAMP
Provider name: portalCreationDate
Description: The date the portal was created, in Unix epoch time.

portal_description

Type: STRING
Provider name: portalDescription
Description: The portal’s description.

portal_id

Type: STRING
Provider name: portalId
Description: The ID of the portal.

portal_last_update_date

Type: TIMESTAMP
Provider name: portalLastUpdateDate
Description: The date the portal was last updated, in Unix epoch time.

portal_logo_image_location

Type: STRUCT
Provider name: portalLogoImageLocation
Description: The portal’s logo image, which is available at a URL.

• id
  Type: STRING
  Provider name: id
  Description: The ID of the image.
  
• url
  Type: STRING
  Provider name: url
  Description: The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image
  

portal_name

Type: STRING
Provider name: portalName
Description: The name of the portal.

portal_start_url

Type: STRING
Provider name: portalStartUrl
Description: The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

portal_status

Type: STRUCT
Provider name: portalStatus
Description: The current status of the portal, which contains a state and any error message.

• error
  Type: STRUCT
  Provider name: error
  Description: Contains associated error information, if any.
  
  • code
    Type: STRING
    Provider name: code
    Description: The error code.
    
  • message
    Type: STRING
    Provider name: message
    Description: The error message.
    
• state
  Type: STRING
  Provider name: state
  Description: The current state of the portal.
  

portal_type

Type: STRING
Provider name: portalType
Description: Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

portal_type_configuration

Type: STRING
Provider name: portalTypeConfiguration
Description: The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

role_arn

Type: STRING
Provider name: roleArn
Description: The ARN of the service role that allows the portal’s users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

tags

Type: UNORDERED_LIST_STRING