Package software.amazon.awscdk.cfnpropertymixins.services.iotsitewise

Interface CfnPortalMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPortalMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-14T18:32:13.794Z")
@Stability(Stable)
public interface CfnPortalMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnPortalPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iotsitewise.*;
 Object alarms;
 CfnPortalMixinProps cfnPortalMixinProps = CfnPortalMixinProps.builder()
         .alarms(alarms)
         .notificationSenderEmail("notificationSenderEmail")
         .portalAuthMode("portalAuthMode")
         .portalContactEmail("portalContactEmail")
         .portalDescription("portalDescription")
         .portalName("portalName")
         .portalType("portalType")
         .portalTypeConfiguration(Map.of(
                 "portalTypeConfigurationKey", PortalTypeEntryProperty.builder()
                         .portalTools(List.of("portalTools"))
                         .build()))
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPortalMixinProps.Builder	A builder for CfnPortalMixinProps
static final class	CfnPortalMixinProps.Jsii$Proxy	An implementation for CfnPortalMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnPortalMixinProps.Builder	builder()
default Object	getAlarms()	Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
default String	getNotificationSenderEmail()	The email address that sends alarm notifications.
default String	getPortalAuthMode()	The service to use to authenticate users to the portal.
default String	getPortalContactEmail()	The AWS administrator's contact email address.
default String	getPortalDescription()	A description for the portal.
default String	getPortalName()	A friendly name for the portal.
default String	getPortalType()	Define the type of portal.
default Object	getPortalTypeConfiguration()	Map to associate detail of configuration related with a PortalType.
default String	getRoleArn()	The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
default List<CfnTag>	getTags()	A list of key-value pairs that contain metadata for the portal.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarms

@Stability(Stable)
@Nullable
default Object getAlarms()

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 .

See Also:

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

getNotificationSenderEmail

@Stability(Stable)
@Nullable
default String getNotificationSenderEmail()

The email address that sends alarm notifications.

If you use the AWS IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES .

See Also:

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

getPortalAuthMode

@Stability(Stable)
@Nullable
default String getPortalAuthMode()

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

• SSO – The portal uses SSOlong to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center 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 to authenticate users and manage user permissions.

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

Default: SSO

See Also:

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

getPortalContactEmail

@Stability(Stable)
@Nullable
default String getPortalContactEmail()

The AWS administrator's contact email address.

See Also:

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

getPortalDescription

@Stability(Stable)
@Nullable
default String getPortalDescription()

A description for the portal.

See Also:

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

getPortalName

@Stability(Stable)
@Nullable
default String getPortalName()

A friendly name for the portal.

See Also:

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

getPortalType

@Stability(Stable)
@Nullable
default String getPortalType()

Define the type of portal.

The value for AWS IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1 . The value for AWS IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2 .

See Also:

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

getPortalTypeConfiguration

@Stability(Stable)
@Nullable
default Object getPortalTypeConfiguration()

Map to associate detail of configuration related with a PortalType.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnPortalPropsMixin.PortalTypeEntryProperty>

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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 .

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnPortalMixinProps.Builder builder()

Returns:

a CfnPortalMixinProps.Builder of CfnPortalMixinProps