Package software.amazon.awscdk.services.iotsitewise

Class CfnPortal

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.925Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPortal

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

    • CfnPortal

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

    • CfnPortal

      @Stability(Stable) public CfnPortal(@NotNull Construct scope, @NotNull String id, @NotNull 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrPortalArn

      @Stability(Stable) @NotNull public String getAttrPortalArn()
      The ARN of the portal, which has the following format.

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

    • getAttrPortalClientId

      @Stability(Stable) @NotNull public String getAttrPortalClientId()
      The IAM Identity Center application generated client ID (used with IAM Identity Center APIs).

    • getAttrPortalId

      @Stability(Stable) @NotNull public String getAttrPortalId()
      The ID of the created portal.

    • getAttrPortalStartUrl

      @Stability(Stable) @NotNull public String getAttrPortalStartUrl()
      The public URL for the AWS IoT SiteWise Monitor portal.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) public void setAlarms(@NotNull 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

      @Stability(Stable) @NotNull public String getPortalContactEmail()
      The AWS administrator's contact email address.

    • setPortalContactEmail

      @Stability(Stable) public void setPortalContactEmail(@NotNull String value)
      The AWS administrator's contact email address.

    • getPortalName

      @Stability(Stable) @NotNull public String getPortalName()
      A friendly name for the portal.

    • setPortalName

      @Stability(Stable) public void setPortalName(@NotNull String value)
      A friendly name for the portal.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      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 .

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      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 .

    • getNotificationSenderEmail

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setNotificationSenderEmail(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setPortalAuthMode(@Nullable 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

      @Stability(Stable) @Nullable public String getPortalDescription()
      A description for the portal.

    • setPortalDescription

      @Stability(Stable) public void setPortalDescription(@Nullable String value)
      A description for the portal.