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

Class CfnPortalMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iotsitewise.CfnPortalMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPortalMixinProps>

Enclosing interface:

CfnPortalMixinProps

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

A builder for CfnPortalMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnPortalMixinProps.Builder	alarms(Object alarms)	Sets the value of CfnPortalMixinProps.getAlarms()
CfnPortalMixinProps	build()	Builds the configured instance.
CfnPortalMixinProps.Builder	notificationSenderEmail(String notificationSenderEmail)	Sets the value of CfnPortalMixinProps.getNotificationSenderEmail()
CfnPortalMixinProps.Builder	portalAuthMode(String portalAuthMode)	Sets the value of CfnPortalMixinProps.getPortalAuthMode()
CfnPortalMixinProps.Builder	portalContactEmail(String portalContactEmail)	Sets the value of CfnPortalMixinProps.getPortalContactEmail()
CfnPortalMixinProps.Builder	portalDescription(String portalDescription)	Sets the value of CfnPortalMixinProps.getPortalDescription()
CfnPortalMixinProps.Builder	portalName(String portalName)	Sets the value of CfnPortalMixinProps.getPortalName()
CfnPortalMixinProps.Builder	portalType(String portalType)	Sets the value of CfnPortalMixinProps.getPortalType()
CfnPortalMixinProps.Builder	portalTypeConfiguration(Map<String,? extends Object> portalTypeConfiguration)	Sets the value of CfnPortalMixinProps.getPortalTypeConfiguration()
CfnPortalMixinProps.Builder	portalTypeConfiguration(IResolvable portalTypeConfiguration)	Sets the value of CfnPortalMixinProps.getPortalTypeConfiguration()
CfnPortalMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnPortalMixinProps.getRoleArn()
CfnPortalMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnPortalMixinProps.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

alarms

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

Sets the value of CfnPortalMixinProps.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 CfnPortalMixinProps.Builder notificationSenderEmail(String notificationSenderEmail)

Sets the value of CfnPortalMixinProps.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 CfnPortalMixinProps.Builder portalAuthMode(String portalAuthMode)

Sets the value of CfnPortalMixinProps.getPortalAuthMode()

Parameters:

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

Returns:

this

portalContactEmail

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

Sets the value of CfnPortalMixinProps.getPortalContactEmail()

Parameters:

portalContactEmail - The AWS administrator's contact email address.

Returns:

this

portalDescription

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

Sets the value of CfnPortalMixinProps.getPortalDescription()

Parameters:

portalDescription - A description for the portal.

Returns:

this

portalName

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

Sets the value of CfnPortalMixinProps.getPortalName()

Parameters:

portalName - A friendly name for the portal.

Returns:

this

portalType

@Stability(Stable)
public CfnPortalMixinProps.Builder portalType(String portalType)

Sets the value of CfnPortalMixinProps.getPortalType()

Parameters:

portalType - 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 .

Returns:

this

portalTypeConfiguration

@Stability(Stable)
public CfnPortalMixinProps.Builder portalTypeConfiguration(IResolvable portalTypeConfiguration)

Sets the value of CfnPortalMixinProps.getPortalTypeConfiguration()

Parameters:

portalTypeConfiguration - Map to associate detail of configuration related with a PortalType.

Returns:

this

portalTypeConfiguration

@Stability(Stable)
public CfnPortalMixinProps.Builder portalTypeConfiguration(Map<String,? extends Object> portalTypeConfiguration)

Sets the value of CfnPortalMixinProps.getPortalTypeConfiguration()

Parameters:

portalTypeConfiguration - Map to associate detail of configuration related with a PortalType.

Returns:

this

roleArn

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

Sets the value of CfnPortalMixinProps.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 .

Returns:

this

tags

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

Sets the value of CfnPortalMixinProps.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 CfnPortalMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnPortalMixinProps

Throws:

NullPointerException - if any required attribute was not provided