Interface ICfnPortalProps

Properties for defining a CfnPortal.

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnPortalProps

Syntax (vb)

Public Interface ICfnPortalProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTSiteWise;

             var alarms;

             var cfnPortalProps = new CfnPortalProps {
                 PortalContactEmail = "portalContactEmail",
                 PortalName = "portalName",
                 RoleArn = "roleArn",

                 // the properties below are optional
                 Alarms = alarms,
                 NotificationSenderEmail = "notificationSenderEmail",
                 PortalAuthMode = "portalAuthMode",
                 PortalDescription = "portalDescription",
                 PortalType = "portalType",
                 PortalTypeConfiguration = new Dictionary<string, object> {
                     { "portalTypeConfigurationKey", new PortalTypeEntryProperty {
                         PortalTools = new [] { "portalTools" }
                     } }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

Alarms	Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
NotificationSenderEmail	The email address that sends alarm notifications.
PortalAuthMode	The service to use to authenticate users to the portal. Choose from the following options:.
PortalContactEmail	The AWS administrator's contact email address.
PortalDescription	A description for the portal.
PortalName	A friendly name for the portal.
PortalType	Define the type of portal.
PortalTypeConfiguration	Map to associate detail of configuration related with a PortalType.
RoleArn	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 .
Tags	A list of key-value pairs that contain metadata for the portal.

Properties

Alarms

Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.

object? Alarms { get; }

Property Value

object

Remarks

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 .

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

NotificationSenderEmail

The email address that sends alarm notifications.

string? NotificationSenderEmail { get; }

Property Value

string

Remarks

If you use the <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">AWS IoT Events managed Lambda function</a> to manage your emails, you must <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html">verify the sender email address in Amazon SES</a> .

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

PortalAuthMode

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

string? PortalAuthMode { get; }

Property Value

string

Remarks

You can't change this value after you create a portal.

Default: SSO

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

PortalContactEmail

The AWS administrator's contact email address.

string PortalContactEmail { get; }

Property Value

string

Remarks

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

PortalDescription

A description for the portal.

string? PortalDescription { get; }

Property Value

string

Remarks

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

PortalName

A friendly name for the portal.

string PortalName { get; }

Property Value

string

Remarks

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

PortalType

Define the type of portal.

string? PortalType { get; }

Property Value

string

Remarks

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 .

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

PortalTypeConfiguration

Map to associate detail of configuration related with a PortalType.

object? PortalTypeConfiguration { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnPortal.IPortalTypeEntryProperty>

RoleArn

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 .

string RoleArn { get; }

Property Value

string

Remarks

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