CfnPortalPropsMixin

class aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnPortalPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions. .. epigraph:

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see `Adding or removing portal administrators <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins>`_ in the *AWS IoT SiteWise User Guide* .

see:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html
cloudformationResource:: AWS::IoTSiteWise::Portal
mixin:: true
exampleMetadata:: fixture=_generated

Example:

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

# alarms: Any

cfn_portal_props_mixin = iotsitewise_mixins.CfnPortalPropsMixin(iotsitewise_mixins.CfnPortalMixinProps(
    alarms=alarms,
    notification_sender_email="notificationSenderEmail",
    portal_auth_mode="portalAuthMode",
    portal_contact_email="portalContactEmail",
    portal_description="portalDescription",
    portal_name="portalName",
    portal_type="portalType",
    portal_type_configuration={
        "portal_type_configuration_key": iotsitewise_mixins.CfnPortalPropsMixin.PortalTypeEntryProperty(
            portal_tools=["portalTools"]
        )
    },
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTSiteWise::Portal.

Parameters:

props (Union[CfnPortalMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['alarms', 'notificationSenderEmail', 'portalAuthMode', 'portalContactEmail', 'portalDescription', 'portalName', 'portalType', 'portalTypeConfiguration', 'roleArn', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AlarmsProperty

class CfnPortalPropsMixin.AlarmsProperty(*, alarm_role_arn=None, notification_lambda_arn=None)

Bases: object

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 .

Parameters:

alarm_role_arn (Optional[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 (Optional[str]) –
The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

alarms_property = iotsitewise_mixins.CfnPortalPropsMixin.AlarmsProperty(
    alarm_role_arn="alarmRoleArn",
    notification_lambda_arn="notificationLambdaArn"
)

Attributes

alarm_role_arn

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events .

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

notification_lambda_arn

The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide .

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

PortalTypeEntryProperty

class CfnPortalPropsMixin.PortalTypeEntryProperty(*, portal_tools=None)

Bases: object

Container associated a certain PortalType.

Parameters:: portal_tools (Optional[Sequence[str]]) – The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-portaltypeentry.html
ExampleMetadata:: fixture=_generated

Example:

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

portal_type_entry_property = iotsitewise_mixins.CfnPortalPropsMixin.PortalTypeEntryProperty(
    portal_tools=["portalTools"]
)

Attributes

portal_tools

The array of tools associated with the specified portal type.

The possible values are ASSISTANT and DASHBOARD .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-portaltypeentry.html#cfn-iotsitewise-portal-portaltypeentry-portaltools