Package software.amazon.awscdk.services.iotsitewise

Class CfnPortalProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.iotsitewise.CfnPortalProps.Jsii$Proxy
All Implemented Interfaces:
CfnPortalProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnPortalProps
@Stability(Stable) @Internal public static final class CfnPortalProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnPortalProps
An implementation for CfnPortalProps

  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iotsitewise.CfnPortalProps

    CfnPortalProps.Builder, CfnPortalProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnPortalProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnPortalProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Object
    getAlarms()
    Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
    final String
    getNotificationSenderEmail()
    The email address that sends alarm notifications.
    final String
    getPortalAuthMode()
    The service to use to authenticate users to the portal.
    final String
    getPortalContactEmail()
    The AWS administrator's contact email address.
    final String
    getPortalDescription()
    A description for the portal.
    final String
    getPortalName()
    A friendly name for the portal.
    final String
    getRoleArn()
    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
    final List<CfnTag>
    getTags()
    A list of key-value pairs that contain metadata for the portal.
    final int
    hashCode()
     

    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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnPortalProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnPortalProps.Builder.

  • Method Details

    • getPortalContactEmail

      public final String getPortalContactEmail()
      Description copied from interface: CfnPortalProps
      The AWS administrator's contact email address.
      Specified by:
      getPortalContactEmail in interface CfnPortalProps

    • getPortalName

      public final String getPortalName()
      Description copied from interface: CfnPortalProps
      A friendly name for the portal.
      Specified by:
      getPortalName in interface CfnPortalProps

    • getRoleArn

      public final String getRoleArn()
      Description copied from interface: CfnPortalProps
      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 .
      Specified by:
      getRoleArn in interface CfnPortalProps

    • getAlarms

      public final Object getAlarms()
      Description copied from interface: CfnPortalProps
      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 .

      Specified by:
      getAlarms in interface CfnPortalProps

    • getNotificationSenderEmail

      public final String getNotificationSenderEmail()
      Description copied from interface: CfnPortalProps
      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 .

      Specified by:
      getNotificationSenderEmail in interface CfnPortalProps

    • getPortalAuthMode

      public final String getPortalAuthMode()
      Description copied from interface: CfnPortalProps
      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

      Specified by:
      getPortalAuthMode in interface CfnPortalProps

    • getPortalDescription

      public final String getPortalDescription()
      Description copied from interface: CfnPortalProps
      A description for the portal.
      Specified by:
      getPortalDescription in interface CfnPortalProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnPortalProps
      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 .

      Specified by:
      getTags in interface CfnPortalProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object