Class: AWSCDK::IoTSiteWise::CfnPortalProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_site_wise/cfn_portal_props.rb

Overview

Properties for defining a CfnPortal.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(portal_contact_email:, portal_name:, role_arn:, alarms: nil, notification_sender_email: nil, portal_auth_mode: nil, portal_description: nil, portal_type: nil, portal_type_configuration: nil, tags: nil) ⇒ CfnPortalProps

Returns a new instance of CfnPortalProps.

Parameters:

  • portal_contact_email (String) —

    The AWS administrator's contact email address.

  • portal_name (String) —

    A friendly name for the portal.

  • role_arn (String) —

    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 .

  • alarms (Object, nil) (defaults to: nil) —

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

  • notification_sender_email (String, nil) (defaults to: nil) —

    The email address that sends alarm notifications.

  • portal_auth_mode (String, nil) (defaults to: nil) —

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

  • portal_description (String, nil) (defaults to: nil) —

    A description for the portal.

  • portal_type (String, nil) (defaults to: nil) —

    Define the type of portal.

  • portal_type_configuration (AWSCDK::IResolvable, Hash{String => AWSCDK::IResolvable, AWSCDK::IoTSiteWise::CfnPortal::PortalTypeEntryProperty}, nil) (defaults to: nil) —

    Map to associate detail of configuration related with a PortalType.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of key-value pairs that contain metadata for the portal.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 19

def initialize(portal_contact_email:, portal_name:, role_arn:, alarms: nil, notification_sender_email: nil, portal_auth_mode: nil, portal_description: nil, portal_type: nil, portal_type_configuration: nil, tags: nil)
  @portal_contact_email = portal_contact_email
  Jsii::Type.check_type(@portal_contact_email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "portalContactEmail")
  @portal_name = portal_name
  Jsii::Type.check_type(@portal_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "portalName")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @alarms = alarms
  Jsii::Type.check_type(@alarms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "alarms") unless @alarms.nil?
  @notification_sender_email = notification_sender_email
  Jsii::Type.check_type(@notification_sender_email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notificationSenderEmail") unless @notification_sender_email.nil?
  @portal_auth_mode = portal_auth_mode
  Jsii::Type.check_type(@portal_auth_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "portalAuthMode") unless @portal_auth_mode.nil?
  @portal_description = portal_description
  Jsii::Type.check_type(@portal_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "portalDescription") unless @portal_description.nil?
  @portal_type = portal_type
  Jsii::Type.check_type(@portal_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "portalType") unless @portal_type.nil?
  @portal_type_configuration = portal_type_configuration
  Jsii::Type.check_type(@portal_type_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90c2l0ZXdpc2UuQ2ZuUG9ydGFsLlBvcnRhbFR5cGVFbnRyeVByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "portalTypeConfiguration") unless @portal_type_configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#alarms ⇒ Object? (readonly)

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 .

Returns:

  • (Object, nil)

See Also:



63
64
65
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 63

def alarms
  @alarms
end

#notification_sender_email ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 70

def notification_sender_email
  @notification_sender_email
end

#portal_auth_mode ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



82
83
84
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 82

def portal_auth_mode
  @portal_auth_mode
end

#portal_contact_email ⇒ String (readonly)

The AWS administrator's contact email address.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 46

def portal_contact_email
  @portal_contact_email
end

#portal_description ⇒ String? (readonly)

A description for the portal.

Returns:

  • (String, nil)

See Also:



87
88
89
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 87

def portal_description
  @portal_description
end

#portal_name ⇒ String (readonly)

A friendly name for the portal.

Returns:

  • (String)

See Also:



51
52
53
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 51

def portal_name
  @portal_name
end

#portal_type ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



94
95
96
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 94

def portal_type
  @portal_type
end

#portal_type_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Map to associate detail of configuration related with a PortalType.

Returns:

See Also:



99
100
101
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 99

def portal_type_configuration
  @portal_type_configuration
end

#role_arn ⇒ String (readonly)

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 .

Returns:

  • (String)

See Also:



56
57
58
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 56

def role_arn
  @role_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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 .

Returns:

See Also:



106
107
108
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 106

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 108

def self.jsii_properties
  {
    :portal_contact_email => "portalContactEmail",
    :portal_name => "portalName",
    :role_arn => "roleArn",
    :alarms => "alarms",
    :notification_sender_email => "notificationSenderEmail",
    :portal_auth_mode => "portalAuthMode",
    :portal_description => "portalDescription",
    :portal_type => "portalType",
    :portal_type_configuration => "portalTypeConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'io_t_site_wise/cfn_portal_props.rb', line 123

def to_jsii
  result = {}
  result.merge!({
    "portalContactEmail" => @portal_contact_email,
    "portalName" => @portal_name,
    "roleArn" => @role_arn,
    "alarms" => @alarms,
    "notificationSenderEmail" => @notification_sender_email,
    "portalAuthMode" => @portal_auth_mode,
    "portalDescription" => @portal_description,
    "portalType" => @portal_type,
    "portalTypeConfiguration" => @portal_type_configuration,
    "tags" => @tags,
  })
  result.compact
end