@Stability(value=Stable) public static final class CfnPortalProps.Builder extends Object implements software.amazon.jsii.Builder<CfnPortalProps>
CfnPortalProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnPortalProps.Builder portalContactEmail(String portalContactEmail)
CfnPortalProps.getPortalContactEmail()portalContactEmail - The AWS administrator's contact email address. This parameter is required.this@Stability(value=Stable) public CfnPortalProps.Builder portalName(String portalName)
CfnPortalProps.getPortalName()portalName - A friendly name for the portal. This parameter is required.this@Stability(value=Stable) public CfnPortalProps.Builder roleArn(String roleArn)
CfnPortalProps.getRoleArn()roleArn - 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* . This parameter is required.this@Stability(value=Stable) public CfnPortalProps.Builder alarms(Object alarms)
CfnPortalProps.getAlarms()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 .this@Stability(value=Stable) public CfnPortalProps.Builder notificationSenderEmail(String notificationSenderEmail)
CfnPortalProps.getNotificationSenderEmail()notificationSenderEmail - 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 .
this@Stability(value=Stable) public CfnPortalProps.Builder portalAuthMode(String portalAuthMode)
CfnPortalProps.getPortalAuthMode()portalAuthMode - 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
this@Stability(value=Stable) public CfnPortalProps.Builder portalDescription(String portalDescription)
CfnPortalProps.getPortalDescription()portalDescription - A description for the portal.this@Stability(value=Stable) public CfnPortalProps.Builder tags(List<? extends CfnTag> tags)
CfnPortalProps.getTags()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 .this@Stability(value=Stable) public CfnPortalProps build()
build in interface software.amazon.jsii.Builder<CfnPortalProps>CfnPortalPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.