Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. iotsitewise
  5. Portal

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotsitewise.Portal

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::IoTSiteWise::Portal

    Create Portal Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Portal(name: string, args: PortalArgs, opts?: CustomResourceOptions);
    @overload
def Portal(resource_name: str,
           args: PortalArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Portal(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           portal_contact_email: Optional[str] = None,
           role_arn: Optional[str] = None,
           alarms: Optional[AlarmsPropertiesArgs] = None,
           notification_sender_email: Optional[str] = None,
           portal_auth_mode: Optional[str] = None,
           portal_description: Optional[str] = None,
           portal_name: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewPortal(ctx *Context, name string, args PortalArgs, opts ...ResourceOption) (*Portal, error)
    public Portal(string name, PortalArgs args, CustomResourceOptions? opts = null)
    public Portal(String name, PortalArgs args)
public Portal(String name, PortalArgs args, CustomResourceOptions options)

    type: aws-native:iotsitewise:Portal
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Portal Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Portal resource accepts the following input properties:

    PortalContactEmail string
    The AWS administrator's contact email address.
    RoleArn string
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    Alarms Pulumi.AwsNative.IoTSiteWise.Inputs.AlarmsProperties
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    NotificationSenderEmail string
    The email address that sends alarm notifications.
    PortalAuthMode string
    The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
    PortalDescription string
    A description for the portal.
    PortalName string
    A friendly name for the portal.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that contain metadata for the portal.
    PortalContactEmail string
    The AWS administrator's contact email address.
    RoleArn string
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    Alarms AlarmsPropertiesArgs
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    NotificationSenderEmail string
    The email address that sends alarm notifications.
    PortalAuthMode string
    The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
    PortalDescription string
    A description for the portal.
    PortalName string
    A friendly name for the portal.
    Tags TagArgs
    A list of key-value pairs that contain metadata for the portal.
    portalContactEmail String
    The AWS administrator's contact email address.
    roleArn String
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    alarms AlarmsProperties
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    notificationSenderEmail String
    The email address that sends alarm notifications.
    portalAuthMode String
    The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
    portalDescription String
    A description for the portal.
    portalName String
    A friendly name for the portal.
    tags List<Tag>
    A list of key-value pairs that contain metadata for the portal.
    portalContactEmail string
    The AWS administrator's contact email address.
    roleArn string
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    alarms AlarmsProperties
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    notificationSenderEmail string
    The email address that sends alarm notifications.
    portalAuthMode string
    The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
    portalDescription string
    A description for the portal.
    portalName string
    A friendly name for the portal.
    tags Tag[]
    A list of key-value pairs that contain metadata for the portal.
    portal_contact_email str
    The AWS administrator's contact email address.
    role_arn str
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    alarms AlarmsPropertiesArgs
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    notification_sender_email str
    The email address that sends alarm notifications.
    portal_auth_mode str
    The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
    portal_description str
    A description for the portal.
    portal_name str
    A friendly name for the portal.
    tags Sequence[TagArgs]
    A list of key-value pairs that contain metadata for the portal.
    portalContactEmail String
    The AWS administrator's contact email address.
    roleArn String
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    alarms Property Map
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
    notificationSenderEmail String
    The email address that sends alarm notifications.
    portalAuthMode String
    The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
    portalDescription String
    A description for the portal.
    portalName String
    A friendly name for the portal.
    tags List<Property Map>
    A list of key-value pairs that contain metadata for the portal.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Portal resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PortalArn string
    The ARN of the portal, which has the following format.
    PortalClientId string
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    PortalId string
    The ID of the portal.
    PortalStartUrl string
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    Id string
    The provider-assigned unique ID for this managed resource.
    PortalArn string
    The ARN of the portal, which has the following format.
    PortalClientId string
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    PortalId string
    The ID of the portal.
    PortalStartUrl string
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    id String
    The provider-assigned unique ID for this managed resource.
    portalArn String
    The ARN of the portal, which has the following format.
    portalClientId String
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    portalId String
    The ID of the portal.
    portalStartUrl String
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    id string
    The provider-assigned unique ID for this managed resource.
    portalArn string
    The ARN of the portal, which has the following format.
    portalClientId string
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    portalId string
    The ID of the portal.
    portalStartUrl string
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    id str
    The provider-assigned unique ID for this managed resource.
    portal_arn str
    The ARN of the portal, which has the following format.
    portal_client_id str
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    portal_id str
    The ID of the portal.
    portal_start_url str
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
    id String
    The provider-assigned unique ID for this managed resource.
    portalArn String
    The ARN of the portal, which has the following format.
    portalClientId String
    The AWS SSO application generated client ID (used with AWS SSO APIs).
    portalId String
    The ID of the portal.
    portalStartUrl String
    The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

    Supporting Types

    AlarmsProperties, AlarmsPropertiesArgs

    AlarmRoleArn string
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    NotificationLambdaArn string
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    AlarmRoleArn string
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    NotificationLambdaArn string
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    alarmRoleArn String
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    notificationLambdaArn String
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    alarmRoleArn string
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    notificationLambdaArn string
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    alarm_role_arn str
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    notification_lambda_arn str
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
    alarmRoleArn String
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.
    notificationLambdaArn String
    The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native