Package software.amazon.awscdk.services.iotsitewise

Interface CfnPortalProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPortalProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:03.268Z")
@Stability(Stable)
public interface CfnPortalProps
extends software.amazon.jsii.JsiiSerializable

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();
 

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	CfnPortalProps.Builder	A builder for CfnPortalProps
static final class	CfnPortalProps.Jsii$Proxy	An implementation for CfnPortalProps

Method Summary

Modifier and Type	Method	Description
static CfnPortalProps.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.
String	getPortalContactEmail()	The AWS administrator's contact email address.
default String	getPortalDescription()	A description for the portal.
String	getPortalName()	A friendly name for the portal.
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

getPortalContactEmail

@Stability(Stable)
@NotNull
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

getPortalName

@Stability(Stable)
@NotNull
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

getRoleArn

@Stability(Stable)
@NotNull
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

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 AWS IAM Identity Center 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

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

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 CfnPortalProps.Builder builder()

Returns:

a CfnPortalProps.Builder of CfnPortalProps