software.amazon.awscdk.services.iotsitewise

Class CfnPortal

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iotsitewise.CfnPortal

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.068Z")
public class CfnPortal
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTSiteWise::Portal`.

Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must enable IAM Identity Center . AWS IoT SiteWise Monitor uses IAM Identity Center to manage user permissions. For more information, see Enabling IAM Identity Center in the AWS IoT SiteWise User Guide .

Before you can sign in to a new portal, you must add at least one IAM Identity Center user or group to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide .

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;
 CfnPortal cfnPortal = CfnPortal.Builder.create(this, "MyCfnPortal")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnPortal.AlarmsProperty Example:
static class	CfnPortal.Builder A fluent builder for CfnPortal.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPortal(Construct scope, java.lang.String id, CfnPortalProps props) Create a new `AWS::IoTSiteWise::Portal`.
protected	CfnPortal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPortal(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAlarms() Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
java.lang.String	getAttrPortalArn() The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the portal, which has the following format.
java.lang.String	getAttrPortalClientId() The IAM Identity Center application generated client ID (used with IAM Identity Center APIs).
java.lang.String	getAttrPortalId() The ID of the created portal.
java.lang.String	getAttrPortalStartUrl() The public URL for the AWS IoT SiteWise Monitor portal.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getNotificationSenderEmail() The email address that sends alarm notifications.
java.lang.String	getPortalAuthMode() The service to use to authenticate users to the portal.
java.lang.String	getPortalContactEmail() The AWS administrator's contact email address.
java.lang.String	getPortalDescription() A description for the portal.
java.lang.String	getPortalName() A friendly name for the portal.
java.lang.String	getRoleArn() 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.
TagManager	getTags() A list of key-value pairs that contain metadata for the portal.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAlarms(java.lang.Object value) Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
void	setNotificationSenderEmail(java.lang.String value) The email address that sends alarm notifications.
void	setPortalAuthMode(java.lang.String value) The service to use to authenticate users to the portal.
void	setPortalContactEmail(java.lang.String value) The AWS administrator's contact email address.
void	setPortalDescription(java.lang.String value) A description for the portal.
void	setPortalName(java.lang.String value) A friendly name for the portal.
void	setRoleArn(java.lang.String value) 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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPortal

protected CfnPortal(software.amazon.jsii.JsiiObjectRef objRef)

CfnPortal

protected CfnPortal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPortal

public CfnPortal(Construct scope,
                 java.lang.String id,
                 CfnPortalProps props)

Create a new `AWS::IoTSiteWise::Portal`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrPortalArn

public java.lang.String getAttrPortalArn()

The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

getAttrPortalClientId

public java.lang.String getAttrPortalClientId()

The IAM Identity Center application generated client ID (used with IAM Identity Center APIs).

getAttrPortalId

public java.lang.String getAttrPortalId()

The ID of the created portal.

getAttrPortalStartUrl

public java.lang.String getAttrPortalStartUrl()

The public URL for the AWS IoT SiteWise Monitor portal.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager 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 .

getAlarms

public java.lang.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 .

setAlarms

public void setAlarms(java.lang.Object value)

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 .

getPortalContactEmail

public java.lang.String getPortalContactEmail()

The AWS administrator's contact email address.

setPortalContactEmail

public void setPortalContactEmail(java.lang.String value)

The AWS administrator's contact email address.

getPortalName

public java.lang.String getPortalName()

A friendly name for the portal.

setPortalName

public void setPortalName(java.lang.String value)

A friendly name for the portal.

getRoleArn

public java.lang.String getRoleArn()

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

setRoleArn

public void setRoleArn(java.lang.String value)

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

getNotificationSenderEmail

public java.lang.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 .

setNotificationSenderEmail

public void setNotificationSenderEmail(java.lang.String value)

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 .

getPortalAuthMode

public java.lang.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 (successor to AWS Single Sign-On) 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 ( IAM ) to authenticate users and manage user permissions.

You can't change this value after you create a portal.

Default: SSO

setPortalAuthMode

public void setPortalAuthMode(java.lang.String value)

The service to use to authenticate users to the portal. Choose from the following options:.

• SSO – The portal uses AWS IAM Identity Center (successor to AWS Single Sign-On) 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 ( IAM ) to authenticate users and manage user permissions.

You can't change this value after you create a portal.

Default: SSO

getPortalDescription

public java.lang.String getPortalDescription()

A description for the portal.

setPortalDescription

public void setPortalDescription(java.lang.String value)

A description for the portal.