Package software.amazon.awscdk.services.iotsitewise

Class CfnPortalProps.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnPortalProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPortalProps>

Enclosing interface:

CfnPortalProps

@Stability(Stable)
public static final class CfnPortalProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPortalProps>

A builder for CfnPortalProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnPortalProps.Builder	alarms(Object alarms)	Sets the value of CfnPortalProps.getAlarms()
CfnPortalProps	build()	Builds the configured instance.
CfnPortalProps.Builder	notificationSenderEmail(String notificationSenderEmail)	Sets the value of CfnPortalProps.getNotificationSenderEmail()
CfnPortalProps.Builder	portalAuthMode(String portalAuthMode)	Sets the value of CfnPortalProps.getPortalAuthMode()
CfnPortalProps.Builder	portalContactEmail(String portalContactEmail)	Sets the value of CfnPortalProps.getPortalContactEmail()
CfnPortalProps.Builder	portalDescription(String portalDescription)	Sets the value of CfnPortalProps.getPortalDescription()
CfnPortalProps.Builder	portalName(String portalName)	Sets the value of CfnPortalProps.getPortalName()
CfnPortalProps.Builder	roleArn(String roleArn)	Sets the value of CfnPortalProps.getRoleArn()
CfnPortalProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnPortalProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

portalContactEmail

@Stability(Stable)
public CfnPortalProps.Builder portalContactEmail(String portalContactEmail)

Sets the value of CfnPortalProps.getPortalContactEmail()

Parameters:

portalContactEmail - The AWS administrator's contact email address. This parameter is required.

Returns:

this

portalName

@Stability(Stable)
public CfnPortalProps.Builder portalName(String portalName)

Sets the value of CfnPortalProps.getPortalName()

Parameters:

portalName - A friendly name for the portal. This parameter is required.

Returns:

this

roleArn

@Stability(Stable)
public CfnPortalProps.Builder roleArn(String roleArn)

Sets the value of CfnPortalProps.getRoleArn()

Parameters:

roleArn - 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 . This parameter is required.

Returns:

this

alarms

@Stability(Stable)
public CfnPortalProps.Builder alarms(Object alarms)

Sets the value of CfnPortalProps.getAlarms()

Parameters:

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 .

Returns:

this

notificationSenderEmail

@Stability(Stable)
public CfnPortalProps.Builder notificationSenderEmail(String notificationSenderEmail)

Sets the value of CfnPortalProps.getNotificationSenderEmail()

Parameters:

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 .

Returns:

this

portalAuthMode

@Stability(Stable)
public CfnPortalProps.Builder portalAuthMode(String portalAuthMode)

Sets the value of CfnPortalProps.getPortalAuthMode()

Parameters:

portalAuthMode - 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

Returns:

this

portalDescription

@Stability(Stable)
public CfnPortalProps.Builder portalDescription(String portalDescription)

Sets the value of CfnPortalProps.getPortalDescription()

Parameters:

portalDescription - A description for the portal.

Returns:

this

tags

@Stability(Stable)
public CfnPortalProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnPortalProps.getTags()

Parameters:

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 .

Returns:

this

build

@Stability(Stable)
public CfnPortalProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnPortalProps>

Returns:

a new instance of CfnPortalProps

Throws:

NullPointerException - if any required attribute was not provided