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

Class CfnPortalPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.iotsitewise.CfnPortalPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-14T18:32:13.795Z") @Stability(Stable) public class CfnPortalPropsMixin extends Mixin implements software.constructs.IMixin

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

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.cfnpropertymixins.services.iotsitewise.*;
 import software.amazon.awscdk.*;
 Object alarms;
 IMergeStrategy mergeStrategy;
 CfnPortalPropsMixin cfnPortalPropsMixin = CfnPortalPropsMixin.Builder.create(CfnPortalMixinProps.builder()
         .alarms(alarms)
         .notificationSenderEmail("notificationSenderEmail")
         .portalAuthMode("portalAuthMode")
         .portalContactEmail("portalContactEmail")
         .portalDescription("portalDescription")
         .portalName("portalName")
         .portalType("portalType")
         .portalTypeConfiguration(Map.of(
                 "portalTypeConfigurationKey", PortalTypeEntryProperty.builder()
                         .portalTools(List.of("portalTools"))
                         .build()))
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    CfnPortalPropsMixin.AlarmsProperty
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
    static final class 
    CfnPortalPropsMixin.Builder
    A fluent builder for CfnPortalPropsMixin.
    static interface 
    CfnPortalPropsMixin.PortalTypeEntryProperty
    Container associated a certain PortalType.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IMixin

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnPortalPropsMixin(CfnPortalMixinProps props)
    Create a mixin to apply properties to AWS::IoTSiteWise::Portal.
     
    CfnPortalPropsMixin(CfnPortalMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::IoTSiteWise::Portal.
    protected
    CfnPortalPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnPortalPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnPortalMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnPortalPropsMixin

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

    • CfnPortalPropsMixin

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

    • CfnPortalPropsMixin

      @Stability(Stable) public CfnPortalPropsMixin(@NotNull CfnPortalMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::IoTSiteWise::Portal.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnPortalPropsMixin

      @Stability(Stable) public CfnPortalPropsMixin(@NotNull CfnPortalMixinProps props)
      Create a mixin to apply properties to AWS::IoTSiteWise::Portal.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnPortalMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()