Class CreatePortalRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest
software.amazon.awssdk.services.iotsitewise.model.CreatePortalRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePortalRequest extends IoTSiteWiseRequest implements ToCopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>

  • Method Details

    • portalName

      public final String portalName()

      A friendly name for the portal.

      Returns:
      A friendly name for the portal.

    • portalDescription

      public final String portalDescription()

      A description for the portal.

      Returns:
      A description for the portal.

    • portalContactEmail

      public final String portalContactEmail()

      The Amazon Web Services administrator's contact email address.

      Returns:
      The Amazon Web Services administrator's contact email address.

    • clientToken

      public final 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.

      Returns:
      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.

    • portalLogoImageFile

      public final ImageFile portalLogoImageFile()

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

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

    • roleArn

      public final String roleArn()

      The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

      Returns:
      The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

    • portalAuthMode

      public final AuthMode portalAuthMode()

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

      • SSO – The portal uses IAM Identity Center 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 IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.

      • IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.

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

      Default: SSO

      If the service returns an enum value that is not available in the current SDK version, portalAuthMode will return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from portalAuthModeAsString().

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

      • SSO – The portal uses IAM Identity Center 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 IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.

      • IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.

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

      Default: SSO

      See Also:

    • portalAuthModeAsString

      public final String portalAuthModeAsString()

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

      • SSO – The portal uses IAM Identity Center 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 IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.

      • IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.

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

      Default: SSO

      If the service returns an enum value that is not available in the current SDK version, portalAuthMode will return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from portalAuthModeAsString().

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

      • SSO – The portal uses IAM Identity Center 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 IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.

      • IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.

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

      Default: SSO

      See Also:

    • notificationSenderEmail

      public final String notificationSenderEmail()

      The email address that sends alarm notifications.

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

      Returns:
      The email address that sends alarm notifications.

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

    • alarms

      public final Alarms alarms()

      Contains the configuration information of an alarm created in an 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 Monitoring with alarms in the IoT SiteWise Application Guide.

      Returns:
      Contains the configuration information of an alarm created in an 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 Monitoring with alarms in the IoT SiteWise Application Guide.

    • toBuilder

      public CreatePortalRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreatePortalRequest.Builder,CreatePortalRequest>
      Specified by:
      toBuilder in class IoTSiteWiseRequest
      Returns:
      a builder for type T

    • builder

      public static CreatePortalRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePortalRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.