-
Notifications
You must be signed in to change notification settings - Fork 17
/
CfnPortalProps.go
83 lines (80 loc) · 5.13 KB
/
CfnPortalProps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
package awsiotsitewise
import (
"github.com/aws/aws-cdk-go/awscdk/v2"
)
// Properties for defining a `CfnPortal`.
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import "github.com/aws/aws-cdk-go/awscdk"
//
// var alarms interface{}
//
// cfnPortalProps := &CfnPortalProps{
// PortalContactEmail: jsii.String("portalContactEmail"),
// PortalName: jsii.String("portalName"),
// RoleArn: jsii.String("roleArn"),
//
// // the properties below are optional
// Alarms: alarms,
// NotificationSenderEmail: jsii.String("notificationSenderEmail"),
// PortalAuthMode: jsii.String("portalAuthMode"),
// PortalDescription: jsii.String("portalDescription"),
// Tags: []cfnTag{
// &cfnTag{
// Key: jsii.String("key"),
// Value: jsii.String("value"),
// },
// },
// }
//
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html
//
type CfnPortalProps struct {
// The AWS administrator's contact email address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalcontactemail
//
PortalContactEmail *string `field:"required" json:"portalContactEmail" yaml:"portalContactEmail"`
// A friendly name for the portal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalname
//
PortalName *string `field:"required" json:"portalName" yaml:"portalName"`
// The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the *AWS IoT SiteWise User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-rolearn
//
RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
// 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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) 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
//
Alarms interface{} `field:"optional" json:"alarms" yaml:"alarms"`
// The email address that sends alarm notifications.
//
// > If you use the [AWS IoT Events managed Lambda function](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) to manage your emails, you must [verify the sender email address in Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-notificationsenderemail
//
NotificationSenderEmail *string `field:"optional" json:"notificationSenderEmail" yaml:"notificationSenderEmail"`
// The service to use to authenticate users to the portal. Choose from the following options:.
//
// - `SSO` – The portal uses AWS IAM Identity Center 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) 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`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portalauthmode
//
PortalAuthMode *string `field:"optional" json:"portalAuthMode" yaml:"portalAuthMode"`
// A description for the portal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-portaldescription
//
PortalDescription *string `field:"optional" json:"portalDescription" yaml:"portalDescription"`
// A list of key-value pairs that contain metadata for the portal.
//
// For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html#cfn-iotsitewise-portal-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}