software.amazon.awscdk.services.iotsitewise

Interface CfnPortalProps

All Known Implementing Classes:

CfnPortalProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:58.247Z")
public interface CfnPortalProps

Properties for defining a `CfnPortal`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 Object alarms;
 CfnPortalProps cfnPortalProps = CfnPortalProps.builder()
         .portalContactEmail("portalContactEmail")
         .portalName("portalName")
         .roleArn("roleArn")
         // the properties below are optional
         .alarms(alarms)
         .notificationSenderEmail("notificationSenderEmail")
         .portalAuthMode("portalAuthMode")
         .portalDescription("portalDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnPortalProps.Builder	builder()
default java.lang.Object	getAlarms() Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
default java.lang.String	getNotificationSenderEmail() The email address that sends alarm notifications.
default java.lang.String	getPortalAuthMode() The service to use to authenticate users to the portal.
java.lang.String	getPortalContactEmail() The AWS administrator's contact email address.
default java.lang.String	getPortalDescription() A description for the portal.
java.lang.String	getPortalName() A friendly name for the portal.
java.lang.String	getRoleArn() The [ARN](https://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.
default java.util.List<CfnTag>	getTags() A list of key-value pairs that contain metadata for the portal.

Method Detail

getPortalContactEmail

java.lang.String getPortalContactEmail()

The AWS administrator's contact email address.

getPortalName

java.lang.String getPortalName()

A friendly name for the portal.

getRoleArn

java.lang.String getRoleArn()

The [ARN](https://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://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the *AWS IoT SiteWise User Guide* .

getAlarms

default java.lang.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 .

getNotificationSenderEmail

default java.lang.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 .

getPortalAuthMode

default java.lang.String getPortalAuthMode()

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

• SSO – The portal uses AWS IAM Identity Center (successor to AWS Single Sign-On) 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 ( IAM ) to authenticate users and manage user permissions.

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

Default: SSO

getPortalDescription

default java.lang.String getPortalDescription()

A description for the portal.

getTags

default java.util.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 .

builder

static CfnPortalProps.Builder builder()

Returns:

a CfnPortalProps.Builder of CfnPortalProps