AWS Native

Pulumi Official
Package maintained by Pulumi
v0.17.0 published on Monday, May 23, 2022 by Pulumi

getPortal

Resource schema for AWS::IoTSiteWise::Portal

Using getPortal

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPortal(args: GetPortalArgs, opts?: InvokeOptions): Promise<GetPortalResult>
function getPortalOutput(args: GetPortalOutputArgs, opts?: InvokeOptions): Output<GetPortalResult>
def get_portal(portal_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPortalResult
def get_portal_output(portal_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPortalResult]
func LookupPortal(ctx *Context, args *LookupPortalArgs, opts ...InvokeOption) (*LookupPortalResult, error)
func LookupPortalOutput(ctx *Context, args *LookupPortalOutputArgs, opts ...InvokeOption) LookupPortalResultOutput

> Note: This function is named LookupPortal in the Go SDK.

public static class GetPortal 
{
    public static Task<GetPortalResult> InvokeAsync(GetPortalArgs args, InvokeOptions? opts = null)
    public static Output<GetPortalResult> Invoke(GetPortalInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:iotsitewise:getPortal
  Arguments:
    # Arguments dictionary

The following arguments are supported:

PortalId string

The ID of the portal.

PortalId string

The ID of the portal.

portalId String

The ID of the portal.

portalId string

The ID of the portal.

portal_id str

The ID of the portal.

portalId String

The ID of the portal.

getPortal Result

The following output properties are available:

Alarms Pulumi.AwsNative.IoTSiteWise.Outputs.AlarmsProperties

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.

NotificationSenderEmail string

The email address that sends alarm notifications.

PortalArn string

The ARN of the portal, which has the following format.

PortalClientId string

The AWS SSO application generated client ID (used with AWS SSO APIs).

PortalContactEmail string

The AWS administrator's contact email address.

PortalDescription string

A description for the portal.

PortalId string

The ID of the portal.

PortalName string

A friendly name for the portal.

PortalStartUrl string

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

RoleArn string

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.

Alarms AlarmsProperties

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.

NotificationSenderEmail string

The email address that sends alarm notifications.

PortalArn string

The ARN of the portal, which has the following format.

PortalClientId string

The AWS SSO application generated client ID (used with AWS SSO APIs).

PortalContactEmail string

The AWS administrator's contact email address.

PortalDescription string

A description for the portal.

PortalId string

The ID of the portal.

PortalName string

A friendly name for the portal.

PortalStartUrl string

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

RoleArn string

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.

alarms AlarmsProperties

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.

notificationSenderEmail String

The email address that sends alarm notifications.

portalArn String

The ARN of the portal, which has the following format.

portalClientId String

The AWS SSO application generated client ID (used with AWS SSO APIs).

portalContactEmail String

The AWS administrator's contact email address.

portalDescription String

A description for the portal.

portalId String

The ID of the portal.

portalName String

A friendly name for the portal.

portalStartUrl String

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

roleArn String

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.

alarms AlarmsProperties

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.

notificationSenderEmail string

The email address that sends alarm notifications.

portalArn string

The ARN of the portal, which has the following format.

portalClientId string

The AWS SSO application generated client ID (used with AWS SSO APIs).

portalContactEmail string

The AWS administrator's contact email address.

portalDescription string

A description for the portal.

portalId string

The ID of the portal.

portalName string

A friendly name for the portal.

portalStartUrl string

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

roleArn string

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.

alarms AlarmsProperties

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.

notification_sender_email str

The email address that sends alarm notifications.

portal_arn str

The ARN of the portal, which has the following format.

portal_client_id str

The AWS SSO application generated client ID (used with AWS SSO APIs).

portal_contact_email str

The AWS administrator's contact email address.

portal_description str

A description for the portal.

portal_id str

The ID of the portal.

portal_name str

A friendly name for the portal.

portal_start_url str

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

role_arn str

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.

alarms Property Map

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.

notificationSenderEmail String

The email address that sends alarm notifications.

portalArn String

The ARN of the portal, which has the following format.

portalClientId String

The AWS SSO application generated client ID (used with AWS SSO APIs).

portalContactEmail String

The AWS administrator's contact email address.

portalDescription String

A description for the portal.

portalId String

The ID of the portal.

portalName String

A friendly name for the portal.

portalStartUrl String

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

roleArn String

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.

Supporting Types

AlarmsProperties

AlarmRoleArn string

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.

NotificationLambdaArn string

The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

AlarmRoleArn string

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.

NotificationLambdaArn string

The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

alarmRoleArn String

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.

notificationLambdaArn String

The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

alarmRoleArn string

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.

notificationLambdaArn string

The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

alarm_role_arn str

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.

notification_lambda_arn str

The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

alarmRoleArn String

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events.

notificationLambdaArn String

The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0