CfnPortalProps

class aws_cdk.aws_iotsitewise.CfnPortalProps(*, portal_contact_email, portal_name, role_arn, alarms=None, notification_sender_email=None, portal_auth_mode=None, portal_description=None, tags=None)

Bases: object

Properties for defining a CfnPortal.

Parameters
  • portal_contact_email (str) – The AWS administrator’s contact email address.

  • portal_name (str) – A friendly name for the portal.

  • 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. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide .

  • alarms (Optional[Any]) – 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. For more information, see Monitoring with alarms in the AWS IoT SiteWise Application Guide .

  • notification_sender_email (Optional[str]) – The email address that sends alarm notifications. .. epigraph:: If you use the AWS IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES .

  • portal_auth_mode (Optional[str]) – The service to use to authenticate users to the portal. Choose from the following options:. - SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO , you must enable AWS SSO . For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide . This option is only available in AWS Regions other than the China Regions. - IAM – The portal uses AWS Identity and Access Management ( IAM ) to authenticate users and manage user permissions. You can’t change this value after you create a portal. Default: SSO

  • portal_description (Optional[str]) – A description for the portal.

  • tags (Optional[Sequence[CfnTag]]) – A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotsitewise as iotsitewise

# alarms: Any

cfn_portal_props = iotsitewise.CfnPortalProps(
    portal_contact_email="portalContactEmail",
    portal_name="portalName",
    role_arn="roleArn",

    # the properties below are optional
    alarms=alarms,
    notification_sender_email="notificationSenderEmail",
    portal_auth_mode="portalAuthMode",
    portal_description="portalDescription",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

alarms

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. For more information, see Monitoring with alarms in the AWS IoT SiteWise Application Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-alarms

Return type

Any

notification_sender_email

The email address that sends alarm notifications.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-notificationsenderemail

Return type

Optional[str]

portal_auth_mode

.

  • SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO , you must enable AWS SSO . For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide . This option is only available in AWS Regions other than the China Regions.

  • IAM – The portal uses AWS Identity and Access Management ( IAM ) to authenticate users and manage user permissions.

You can’t change this value after you create a portal.

Default: SSO

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalauthmode

Type

The service to use to authenticate users to the portal. Choose from the following options

Return type

Optional[str]

portal_contact_email

The AWS administrator’s contact email address.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalcontactemail

Return type

str

portal_description

A description for the portal.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaldescription

Return type

Optional[str]

portal_name

A friendly name for the portal.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalname

Return type

str

role_arn

//docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html>`_ in the AWS IoT SiteWise User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-rolearn

Type

The `ARN <https

Type

//docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of a service role that allows the portal’s users to access your AWS IoT SiteWise resources on your behalf. For more information, see `Using service roles for AWS IoT SiteWise Monitor <https

Return type

str

tags

A list of key-value pairs that contain metadata for the portal.

For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-tags

Return type

Optional[List[CfnTag]]