Package software.amazon.awscdk.services.iotsitewise

Class CfnPortal.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnPortal.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPortal>

Enclosing class:

CfnPortal

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

A fluent builder for CfnPortal.

Method Summary

Modifier and Type	Method	Description
CfnPortal.Builder	alarms(Object alarms)	Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
CfnPortal	build()
static CfnPortal.Builder	create(software.constructs.Construct scope, String id)
CfnPortal.Builder	notificationSenderEmail(String notificationSenderEmail)	The email address that sends alarm notifications.
CfnPortal.Builder	portalAuthMode(String portalAuthMode)	The service to use to authenticate users to the portal.
CfnPortal.Builder	portalContactEmail(String portalContactEmail)	The AWS administrator's contact email address.
CfnPortal.Builder	portalDescription(String portalDescription)	A description for the portal.
CfnPortal.Builder	portalName(String portalName)	A friendly name for the portal.
CfnPortal.Builder	roleArn(String roleArn)	The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
CfnPortal.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that contain metadata for the portal.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnPortal.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnPortal.Builder.

portalContactEmail

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

The AWS administrator's contact email address.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalcontactemail

portalName

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

A friendly name for the portal.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalname

roleArn

@Stability(Stable)
public CfnPortal.Builder roleArn(String 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 .

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-rolearn

alarms

@Stability(Stable)
public CfnPortal.Builder alarms(Object 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 .

Parameters:

alarms - Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-alarms

notificationSenderEmail

@Stability(Stable)
public CfnPortal.Builder notificationSenderEmail(String 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 .

Parameters:

notificationSenderEmail - The email address that sends alarm notifications. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-notificationsenderemail

portalAuthMode

@Stability(Stable)
public CfnPortal.Builder portalAuthMode(String 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

Parameters:

portalAuthMode - The service to use to authenticate users to the portal. Choose from the following options:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalauthmode

portalDescription

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

A description for the portal.

Parameters:

portalDescription - A description for the portal. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaldescription

tags

@Stability(Stable)
public CfnPortal.Builder tags(List<? extends CfnTag> 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 .

Parameters:

tags - A list of key-value pairs that contain metadata for the portal. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-tags

build

@Stability(Stable)
public CfnPortal build()

Specified by:

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

Returns:

a newly built instance of CfnPortal.