Package software.amazon.awscdk.services.iotsitewise

Class CfnPortal

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotsitewise.CfnPortal
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-04T00:39:33.778Z") @Stability(Stable) public class CfnPortal extends CfnResource implements IInspectable, ITaggable
Creates a portal, which can contain projects and dashboards.

AWS IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

Before you can sign in to a new portal, you must add at least one identity 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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnPortalProps props)
      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.
      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()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

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

    • getAlarms

      @Stability(Stable) @Nullable public Object getAlarms()
      Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.

    • setAlarms

      @Stability(Stable) public void setAlarms(@Nullable Object value)
      Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.

    • getNotificationSenderEmail

      @Stability(Stable) @Nullable public String getNotificationSenderEmail()
      The email address that sends alarm notifications.

    • setNotificationSenderEmail

      @Stability(Stable) public void setNotificationSenderEmail(@Nullable String value)
      The email address that sends alarm notifications.

    • getPortalAuthMode

      @Stability(Stable) @Nullable public String getPortalAuthMode()
      The service to use to authenticate users to the portal.

      Choose from the following options:.

    • setPortalAuthMode

      @Stability(Stable) public void setPortalAuthMode(@Nullable String value)
      The service to use to authenticate users to the portal.

      Choose from the following options:.

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of key-value pairs that contain metadata for the portal.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of key-value pairs that contain metadata for the portal.