@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:37.068Z") public class CfnPortal extends CfnResource implements IInspectable
Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must enable IAM Identity Center . AWS IoT SiteWise Monitor uses IAM Identity Center to manage user permissions. For more information, see Enabling IAM Identity Center in the AWS IoT SiteWise User Guide .
Before you can sign in to a new portal, you must add at least one IAM Identity Center user or group to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iotsitewise.*; Object alarms; CfnPortal cfnPortal = CfnPortal.Builder.create(this, "MyCfnPortal") .portalContactEmail("portalContactEmail") .portalName("portalName") .roleArn("roleArn") // the properties below are optional .alarms(alarms) .notificationSenderEmail("notificationSenderEmail") .portalAuthMode("portalAuthMode") .portalDescription("portalDescription") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnPortal.AlarmsProperty
Example:
|
static class |
CfnPortal.Builder
A fluent builder for
CfnPortal . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnPortal(Construct scope,
java.lang.String id,
CfnPortalProps props)
Create a new `AWS::IoTSiteWise::Portal`.
|
protected |
CfnPortal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnPortal(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAlarms()
Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
|
java.lang.String |
getAttrPortalArn()
The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the portal, which has the following format.
|
java.lang.String |
getAttrPortalClientId()
The IAM Identity Center application generated client ID (used with IAM Identity Center APIs).
|
java.lang.String |
getAttrPortalId()
The ID of the created portal.
|
java.lang.String |
getAttrPortalStartUrl()
The public URL for the AWS IoT SiteWise Monitor portal.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getNotificationSenderEmail()
The email address that sends alarm notifications.
|
java.lang.String |
getPortalAuthMode()
The service to use to authenticate users to the portal.
|
java.lang.String |
getPortalContactEmail()
The AWS administrator's contact email address.
|
java.lang.String |
getPortalDescription()
A description for the portal.
|
java.lang.String |
getPortalName()
A friendly name for the portal.
|
java.lang.String |
getRoleArn()
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.
|
TagManager |
getTags()
A list of key-value pairs that contain metadata for the portal.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAlarms(java.lang.Object value)
Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
|
void |
setNotificationSenderEmail(java.lang.String value)
The email address that sends alarm notifications.
|
void |
setPortalAuthMode(java.lang.String value)
The service to use to authenticate users to the portal.
|
void |
setPortalContactEmail(java.lang.String value)
The AWS administrator's contact email address.
|
void |
setPortalDescription(java.lang.String value)
A description for the portal.
|
void |
setPortalName(java.lang.String value)
A friendly name for the portal.
|
void |
setRoleArn(java.lang.String value)
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnPortal(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPortal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnPortal(Construct scope, java.lang.String id, CfnPortalProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrPortalArn()
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
public java.lang.String getAttrPortalClientId()
public java.lang.String getAttrPortalId()
public java.lang.String getAttrPortalStartUrl()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .
public java.lang.Object getAlarms()
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 .
public void setAlarms(java.lang.Object value)
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 .
public java.lang.String getPortalContactEmail()
public void setPortalContactEmail(java.lang.String value)
public java.lang.String getPortalName()
public void setPortalName(java.lang.String value)
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)
public java.lang.String getNotificationSenderEmail()
If you use the AWS IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES .
public void setNotificationSenderEmail(java.lang.String value)
If you use the AWS IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES .
public java.lang.String getPortalAuthMode()
SSO
– The portal uses AWS IAM Identity Center (successor to AWS Single Sign-On) 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 ( IAM ) to authenticate users and manage user permissions.You can't change this value after you create a portal.
Default: SSO
public void setPortalAuthMode(java.lang.String value)
SSO
– The portal uses AWS IAM Identity Center (successor to AWS Single Sign-On) 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 ( IAM ) to authenticate users and manage user permissions.You can't change this value after you create a portal.
Default: SSO
public java.lang.String getPortalDescription()
public void setPortalDescription(java.lang.String value)