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

Class CfnPortalMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.iotsitewise.CfnPortalMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnPortalMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnPortalMixinProps

@Stability(Stable)
@Internal
public static final class CfnPortalMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnPortalMixinProps

An implementation for CfnPortalMixinProps

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.cfnpropertymixins.services.iotsitewise.CfnPortalMixinProps

CfnPortalMixinProps.Builder, CfnPortalMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnPortalMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnPortalMixinProps.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	getPortalType()	Define the type of portal.
final Object	getPortalTypeConfiguration()	Map to associate detail of configuration related with a PortalType.
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(CfnPortalMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnPortalMixinProps.Builder.

Method Details

getAlarms

public final Object getAlarms()

Description copied from interface: CfnPortalMixinProps

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 CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-alarms

getNotificationSenderEmail

public final String getNotificationSenderEmail()

Description copied from interface: CfnPortalMixinProps

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 CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-notificationsenderemail

getPortalAuthMode

public final String getPortalAuthMode()

Description copied from interface: CfnPortalMixinProps

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

• SSO – The portal uses SSOlong 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 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 CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalauthmode

getPortalContactEmail

public final String getPortalContactEmail()

Description copied from interface: CfnPortalMixinProps

The AWS administrator's contact email address.

Specified by:

getPortalContactEmail in interface CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalcontactemail

getPortalDescription

public final String getPortalDescription()

Description copied from interface: CfnPortalMixinProps

A description for the portal.

Specified by:

getPortalDescription in interface CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaldescription

getPortalName

public final String getPortalName()

Description copied from interface: CfnPortalMixinProps

A friendly name for the portal.

Specified by:

getPortalName in interface CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalname

getPortalType

public final String getPortalType()

Description copied from interface: CfnPortalMixinProps

Define the type of portal.

The value for AWS IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1 . The value for AWS IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2 .

Specified by:

getPortalType in interface CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaltype

getPortalTypeConfiguration

public final Object getPortalTypeConfiguration()

Description copied from interface: CfnPortalMixinProps

Map to associate detail of configuration related with a PortalType.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnPortalPropsMixin.PortalTypeEntryProperty>

Specified by:

getPortalTypeConfiguration in interface CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaltypeconfiguration

getRoleArn

public final String getRoleArn()

Description copied from interface: CfnPortalMixinProps

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 CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-rolearn

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnPortalMixinProps

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 CfnPortalMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-tags

$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