CfnPortal L1 construct
The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .
If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .
Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.
Before you can sign in to a new portal, you must add at least one identity 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 { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
declare const alarms: any;
const cfnPortal = new iotsitewise.CfnPortal(this, 'MyCfnPortal', {
portalContactEmail: 'portalContactEmail',
portalName: 'portalName',
roleArn: 'roleArn',
// the properties below are optional
alarms: alarms,
notificationSenderEmail: 'notificationSenderEmail',
portalAuthMode: 'portalAuthMode',
portalDescription: 'portalDescription',
portalType: 'portalType',
portalTypeConfiguration: {
portalTypeConfigurationKey: {
portalTools: ['portalTools'],
},
},
tags: [{
key: 'key',
value: 'value',
}],
});
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotsitewise as iotsitewise
# alarms: Any
cfn_portal = iotsitewise.CfnPortal(self, "MyCfnPortal",
portal_contact_email="portalContactEmail",
portal_name="portalName",
role_arn="roleArn",
# the properties below are optional
alarms=alarms,
notification_sender_email="notificationSenderEmail",
portal_auth_mode="portalAuthMode",
portal_description="portalDescription",
portal_type="portalType",
portal_type_configuration={
"portal_type_configuration_key": iotsitewise.CfnPortal.PortalTypeEntryProperty(
portal_tools=["portalTools"]
)
},
tags=[CfnTag(
key="key",
value="value"
)]
)
// 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")
.portalType("portalType")
.portalTypeConfiguration(Map.of(
"portalTypeConfigurationKey", PortalTypeEntryProperty.builder()
.portalTools(List.of("portalTools"))
.build()))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// 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 cfnPortal = new CfnPortal(this, "MyCfnPortal", 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"
} }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// 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{}
cfnPortal := awscdk.Aws_iotsitewise.NewCfnPortal(this, jsii.String("MyCfnPortal"), &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"),
PortalType: jsii.String("portalType"),
PortalTypeConfiguration: map[string]interface{}{
"portalTypeConfigurationKey": &PortalTypeEntryProperty{
"portalTools": []*string{
jsii.String("portalTools"),
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
new CfnPortal(scope: Construct, id: string, props: CfnPortalProps)
CfnPortal(scope: Construct, id: str, props: CfnPortalProps)
new CfnPortal(Construct scope, String id, CfnPortalProps props)
new CfnPortal(Construct scope, string id, CfnPortalProps props)
NewCfnPortal(Scope Construct, Id *string, Props CfnPortalProps)
Construct Props
alarmsoptionalanyalarmsoptionalAnyalarmsoptionalObjectAlarmsoptionalobjectAlarmsoptionalinterface{}#notes
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 .
notificationSenderEmailoptionalstringnotification_sender_emailoptionalstrnotificationSenderEmailoptionalStringNotificationSenderEmailoptionalstringNotificationSenderEmailoptional*string#notes
If you use the AWS IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES .
portalAuthModeoptionalstringportal_auth_modeoptionalstrportalAuthModeoptionalStringPortalAuthModeoptionalstringPortalAuthModeoptional*string#notes
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
portalContactEmailstringportal_contact_emailstrportalContactEmailStringPortalContactEmailstringPortalContactEmail*stringrequired#portalDescriptionoptionalstringportal_descriptionoptionalstrportalDescriptionoptionalStringPortalDescriptionoptionalstringPortalDescriptionoptional*string#portalTypeoptionalstringportal_typeoptionalstrportalTypeoptionalStringPortalTypeoptionalstringPortalTypeoptional*string#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 .
portalTypeConfigurationoptionalIResolvable | { [key: string]: IResolvable | CfnPortal.PortalTypeEntryProperty }portal_type_configurationoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, PortalTypeEntryProperty]]]portalTypeConfigurationoptionalIResolvablePortalTypeConfigurationoptionalIResolvablePortalTypeConfigurationoptionalinterface{}#Properties
attrPortalArnstringattr_portal_arnstrattrPortalArnStringAttrPortalArnstringAttrPortalArn*stringrequired#arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
attrPortalClientIdstringattr_portal_client_idstrattrPortalClientIdStringAttrPortalClientIdstringAttrPortalClientId*stringrequired#attrPortalStartUrlstringattr_portal_start_urlstrattrPortalStartUrlStringAttrPortalStartUrlstringAttrPortalStartUrl*stringrequired#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
notificationSenderEmailmay be undefinedstringnotification_sender_emailmay be undefinedstrnotificationSenderEmailmay be undefinedStringNotificationSenderEmailmay be undefinedstringNotificationSenderEmailmay be undefined*string#portalAuthModemay be undefinedstringportal_auth_modemay be undefinedstrportalAuthModemay be undefinedStringPortalAuthModemay be undefinedstringPortalAuthModemay be undefined*string#Choose from the following options:.
portalContactEmailstringportal_contact_emailstrportalContactEmailStringPortalContactEmailstringPortalContactEmail*stringrequired#portalDescriptionmay be undefinedstringportal_descriptionmay be undefinedstrportalDescriptionmay be undefinedStringPortalDescriptionmay be undefinedstringPortalDescriptionmay be undefined*string#portalRefPortalReferenceportal_refPortalReferenceportalRefPortalReferencePortalRefPortalReferencePortalRefPortalReferencerequired#portalTypemay be undefinedstringportal_typemay be undefinedstrportalTypemay be undefinedStringPortalTypemay be undefinedstringPortalTypemay be undefined*string#portalTypeConfigurationmay be undefinedIResolvable | { [key: string]: IResolvable | CfnPortal.PortalTypeEntryProperty }portal_type_configurationmay be undefinedtyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, PortalTypeEntryProperty]]]portalTypeConfigurationmay be undefinedIResolvablePortalTypeConfigurationmay be undefinedIResolvablePortalTypeConfigurationmay be undefinedinterface{}#If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
CfnElements must be defined within a stack scope (directly or indirectly).
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
arnForPortal(resource: IPortalRef): string@staticmethod def arn_for_portal(resource: IPortalRef) -> strpublic static String arnForPortal(IPortalRef resource)public static string ArnForPortal(IPortalRef resource)func ArnForPortal(Resource IPortalRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#fromPortalArn(scope: Construct, id: string, arn: string): IPortalRef@staticmethod def from_portal_arn(scope: Construct, id: str, arn: str) -> IPortalRefpublic static IPortalRef fromPortalArn(Construct scope, String id, String arn)public static IPortalRef FromPortalArn(Construct scope, string id, string arn)func FromPortalArn(Scope Construct, Id *string, Arn *string) IPortalRefstatic#fromPortalId(scope: Construct, id: string, portalId: string): IPortalRef@staticmethod def from_portal_id(scope: Construct, id: str, portal_id: str) -> IPortalRefpublic static IPortalRef fromPortalId(Construct scope, String id, String portalId)public static IPortalRef FromPortalId(Construct scope, string id, string portalId)func FromPortalId(Scope Construct, Id *string, PortalId *string) IPortalRefstatic#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnPortal(x: any): boolean@staticmethod def is_cfn_portal(x: Any) -> boolpublic static Boolean isCfnPortal(Object x)public static bool IsCfnPortal(object x)func IsCfnPortal(X interface{}) *boolstatic#isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.