Interface ICfnPortalProps
Properties for defining a CfnPortal
.
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.AWS.IoTSiteWise.dll
Syntax (csharp)
public interface ICfnPortalProps
Syntax (vb)
Public Interface ICfnPortalProps
Remarks
Link: 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",
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. |
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.
virtual object Alarms { get; }
Property Value
System.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 .
NotificationSenderEmail
The email address that sends alarm notifications.
virtual string NotificationSenderEmail { get; }
Property Value
System.String
Remarks
If you use the AWS IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES .
PortalAuthMode
The service to use to authenticate users to the portal. Choose from the following options:.
virtual string PortalAuthMode { get; }
Property Value
System.String
Remarks
You can't change this value after you create a portal.
Default: SSO
PortalContactEmail
The AWS administrator's contact email address.
string PortalContactEmail { get; }
Property Value
System.String
Remarks
PortalDescription
A description for the portal.
virtual string PortalDescription { get; }
Property Value
System.String
Remarks
PortalName
A friendly name for the portal.
string PortalName { get; }
Property Value
System.String
Remarks
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
System.String
Remarks
Tags
A list of key-value pairs that contain metadata for the portal.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .