class CfnPortalPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTSiteWise.Mixins.CfnPortalPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotsitewise/mixins#CfnPortalPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.iotsitewise.mixins.CfnPortalPropsMixin
Python	aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnPortalPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_iotsitewise » mixins » CfnPortalPropsMixin

Implements IMixin

Extends Mixin

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-portal.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as iotsitewise_mixins } from '@aws-cdk/mixins-preview/aws-iotsitewise';

declare const alarms: any;
const cfnPortalPropsMixin = new iotsitewise_mixins.CfnPortalPropsMixin({
  alarms: alarms,
  notificationSenderEmail: 'notificationSenderEmail',
  portalAuthMode: 'portalAuthMode',
  portalContactEmail: 'portalContactEmail',
  portalDescription: 'portalDescription',
  portalName: 'portalName',
  portalType: 'portalType',
  portalTypeConfiguration: {
    portalTypeConfigurationKey: {
      portalTools: ['portalTools'],
    },
  },
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnPortalPropsMixin(props: CfnPortalMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnPortalMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::IoTSiteWise::Portal.

Properties

Name	Type	Description
props	CfnPortalMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnPortalMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.