Package software.amazon.awssdk.services.iotsitewise.model

Interface CreatePortalResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<CreatePortalResponse.Builder,CreatePortalResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CreatePortalResponse
public static interface CreatePortalResponse.Builder extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>

  • Method Details

    • portalId

      CreatePortalResponse.Builder portalId(String portalId)

      The ID of the created portal.

      Parameters:
      portalId - The ID of the created portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portalArn

      CreatePortalResponse.Builder portalArn(String portalArn)

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

      Parameters:
      portalArn - The ARN of the portal, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

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

    • portalStartUrl

      CreatePortalResponse.Builder portalStartUrl(String portalStartUrl)

      The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

      Parameters:
      portalStartUrl - The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portalStatus

      CreatePortalResponse.Builder portalStatus(PortalStatus portalStatus)

      The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

      Parameters:
      portalStatus - The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portalStatus

      default CreatePortalResponse.Builder portalStatus(Consumer<PortalStatus.Builder> portalStatus)

      The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

      This is a convenience method that creates an instance of the PortalStatus.Builder avoiding the need to create one manually via PortalStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to portalStatus(PortalStatus).

      Parameters:
      portalStatus - a consumer that will call methods on PortalStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ssoApplicationId

      CreatePortalResponse.Builder ssoApplicationId(String ssoApplicationId)

      The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.

      Parameters:
      ssoApplicationId - The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.
      Returns:
      Returns a reference to this object so that method calls can be chained together.