software.amazon.awssdk.services.iotsitewise.model

Interface CreatePortalRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<CreatePortalRequest.Builder,CreatePortalRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreatePortalRequest

public static interface CreatePortalRequest.Builder
extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>

Method Summary

Modifier and Type	Method and Description
CreatePortalRequest.Builder	alarms(Alarms alarms) Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
default CreatePortalRequest.Builder	alarms(Consumer<Alarms.Builder> alarms) Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
CreatePortalRequest.Builder	clientToken(String clientToken) A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
CreatePortalRequest.Builder	notificationSenderEmail(String notificationSenderEmail) The email address that sends alarm notifications.
CreatePortalRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreatePortalRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreatePortalRequest.Builder	portalAuthMode(AuthMode portalAuthMode) The service to use to authenticate users to the portal.
CreatePortalRequest.Builder	portalAuthMode(String portalAuthMode) The service to use to authenticate users to the portal.
CreatePortalRequest.Builder	portalContactEmail(String portalContactEmail) The AWS administrator's contact email address.
CreatePortalRequest.Builder	portalDescription(String portalDescription) A description for the portal.
default CreatePortalRequest.Builder	portalLogoImageFile(Consumer<ImageFile.Builder> portalLogoImageFile) A logo image to display in the portal.
CreatePortalRequest.Builder	portalLogoImageFile(ImageFile portalLogoImageFile) A logo image to display in the portal.
CreatePortalRequest.Builder	portalName(String portalName) A friendly name for the portal.
CreatePortalRequest.Builder	roleArn(String roleArn) The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
CreatePortalRequest.Builder	tags(Map<String,String> tags) A list of key-value pairs that contain metadata for the portal.

Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

portalName

CreatePortalRequest.Builder portalName(String portalName)

A friendly name for the portal.

Parameters:

portalName - A friendly name for the portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

portalDescription

CreatePortalRequest.Builder portalDescription(String portalDescription)

A description for the portal.

Parameters:

portalDescription - A description for the portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

portalContactEmail

CreatePortalRequest.Builder portalContactEmail(String portalContactEmail)

The AWS administrator's contact email address.

Parameters:

portalContactEmail - The AWS administrator's contact email address.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

CreatePortalRequest.Builder clientToken(String clientToken)

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Parameters:

clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Returns:

Returns a reference to this object so that method calls can be chained together.

portalLogoImageFile

CreatePortalRequest.Builder portalLogoImageFile(ImageFile portalLogoImageFile)

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

Parameters:

portalLogoImageFile - A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

Returns:

Returns a reference to this object so that method calls can be chained together.

portalLogoImageFile

default CreatePortalRequest.Builder portalLogoImageFile(Consumer<ImageFile.Builder> portalLogoImageFile)

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

This is a convenience that creates an instance of the ImageFile.Builder avoiding the need to create one manually via ImageFile.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to portalLogoImageFile(ImageFile).

Parameters:

portalLogoImageFile - a consumer that will call methods on ImageFile.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

portalLogoImageFile(ImageFile)

roleArn

CreatePortalRequest.Builder roleArn(String roleArn)

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.

Parameters:

roleArn - 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:

Returns a reference to this object so that method calls can be chained together.

tags

CreatePortalRequest.Builder tags(Map<String,String> tags)

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.

Parameters:

tags - 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:

Returns a reference to this object so that method calls can be chained together.

portalAuthMode

CreatePortalRequest.Builder portalAuthMode(String portalAuthMode)

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

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO 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. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Parameters:

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

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO 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. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthMode, AuthMode

portalAuthMode

CreatePortalRequest.Builder portalAuthMode(AuthMode portalAuthMode)

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

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO 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. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Parameters:

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

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO 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. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthMode, AuthMode

notificationSenderEmail

CreatePortalRequest.Builder notificationSenderEmail(String notificationSenderEmail)

The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

Parameters:

notificationSenderEmail - The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarms

CreatePortalRequest.Builder alarms(Alarms alarms)

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 .

Parameters:

alarms - 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 .

Returns:

Returns a reference to this object so that method calls can be chained together.

alarms

default CreatePortalRequest.Builder alarms(Consumer<Alarms.Builder> alarms)

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 .

This is a convenience that creates an instance of the Alarms.Builder avoiding the need to create one manually via Alarms.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarms(Alarms).

Parameters:

alarms - a consumer that will call methods on Alarms.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

alarms(Alarms)

overrideConfiguration

CreatePortalRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreatePortalRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder