AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTSiteWise::Model::CreatePortalResult Class Reference

#include <CreatePortalResult.h>

Public Member Functions

 CreatePortalResult ()
 
 CreatePortalResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
CreatePortalResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetPortalId () const
 
void SetPortalId (const Aws::String &value)
 
void SetPortalId (Aws::String &&value)
 
void SetPortalId (const char *value)
 
CreatePortalResultWithPortalId (const Aws::String &value)
 
CreatePortalResultWithPortalId (Aws::String &&value)
 
CreatePortalResultWithPortalId (const char *value)
 
const Aws::StringGetPortalArn () const
 
void SetPortalArn (const Aws::String &value)
 
void SetPortalArn (Aws::String &&value)
 
void SetPortalArn (const char *value)
 
CreatePortalResultWithPortalArn (const Aws::String &value)
 
CreatePortalResultWithPortalArn (Aws::String &&value)
 
CreatePortalResultWithPortalArn (const char *value)
 
const Aws::StringGetPortalStartUrl () const
 
void SetPortalStartUrl (const Aws::String &value)
 
void SetPortalStartUrl (Aws::String &&value)
 
void SetPortalStartUrl (const char *value)
 
CreatePortalResultWithPortalStartUrl (const Aws::String &value)
 
CreatePortalResultWithPortalStartUrl (Aws::String &&value)
 
CreatePortalResultWithPortalStartUrl (const char *value)
 
const PortalStatusGetPortalStatus () const
 
void SetPortalStatus (const PortalStatus &value)
 
void SetPortalStatus (PortalStatus &&value)
 
CreatePortalResultWithPortalStatus (const PortalStatus &value)
 
CreatePortalResultWithPortalStatus (PortalStatus &&value)
 
const Aws::StringGetSsoApplicationId () const
 
void SetSsoApplicationId (const Aws::String &value)
 
void SetSsoApplicationId (Aws::String &&value)
 
void SetSsoApplicationId (const char *value)
 
CreatePortalResultWithSsoApplicationId (const Aws::String &value)
 
CreatePortalResultWithSsoApplicationId (Aws::String &&value)
 
CreatePortalResultWithSsoApplicationId (const char *value)
 

Detailed Description

Definition at line 28 of file CreatePortalResult.h.

Constructor & Destructor Documentation

◆ CreatePortalResult() [1/2]

Aws::IoTSiteWise::Model::CreatePortalResult::CreatePortalResult ( )

◆ CreatePortalResult() [2/2]

Aws::IoTSiteWise::Model::CreatePortalResult::CreatePortalResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetPortalArn()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalResult::GetPortalArn ( ) const
inline

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

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

Definition at line 79 of file CreatePortalResult.h.

◆ GetPortalId()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalResult::GetPortalId ( ) const
inline

The ID of the created portal.

Definition at line 39 of file CreatePortalResult.h.

◆ GetPortalStartUrl()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalResult::GetPortalStartUrl ( ) const
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 144 of file CreatePortalResult.h.

◆ GetPortalStatus()

const PortalStatus& Aws::IoTSiteWise::Model::CreatePortalResult::GetPortalStatus ( ) const
inline

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

Definition at line 211 of file CreatePortalResult.h.

◆ GetSsoApplicationId()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalResult::GetSsoApplicationId ( ) const
inline

The associated AWS SSO application ID, if the portal uses AWS SSO.

Definition at line 241 of file CreatePortalResult.h.

◆ operator=()

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetPortalArn() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalArn ( const Aws::String value)
inline

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

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

Definition at line 88 of file CreatePortalResult.h.

◆ SetPortalArn() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalArn ( Aws::String &&  value)
inline

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

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

Definition at line 97 of file CreatePortalResult.h.

◆ SetPortalArn() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalArn ( const char *  value)
inline

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

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

Definition at line 106 of file CreatePortalResult.h.

◆ SetPortalId() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalId ( const Aws::String value)
inline

The ID of the created portal.

Definition at line 44 of file CreatePortalResult.h.

◆ SetPortalId() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalId ( Aws::String &&  value)
inline

The ID of the created portal.

Definition at line 49 of file CreatePortalResult.h.

◆ SetPortalId() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalId ( const char *  value)
inline

The ID of the created portal.

Definition at line 54 of file CreatePortalResult.h.

◆ SetPortalStartUrl() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalStartUrl ( const Aws::String value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 154 of file CreatePortalResult.h.

◆ SetPortalStartUrl() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalStartUrl ( Aws::String &&  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 164 of file CreatePortalResult.h.

◆ SetPortalStartUrl() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalStartUrl ( const char *  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 174 of file CreatePortalResult.h.

◆ SetPortalStatus() [1/2]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalStatus ( const PortalStatus value)
inline

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

Definition at line 217 of file CreatePortalResult.h.

◆ SetPortalStatus() [2/2]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetPortalStatus ( PortalStatus &&  value)
inline

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

Definition at line 223 of file CreatePortalResult.h.

◆ SetSsoApplicationId() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetSsoApplicationId ( const Aws::String value)
inline

The associated AWS SSO application ID, if the portal uses AWS SSO.

Definition at line 246 of file CreatePortalResult.h.

◆ SetSsoApplicationId() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetSsoApplicationId ( Aws::String &&  value)
inline

The associated AWS SSO application ID, if the portal uses AWS SSO.

Definition at line 251 of file CreatePortalResult.h.

◆ SetSsoApplicationId() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalResult::SetSsoApplicationId ( const char *  value)
inline

The associated AWS SSO application ID, if the portal uses AWS SSO.

Definition at line 256 of file CreatePortalResult.h.

◆ WithPortalArn() [1/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalArn ( const Aws::String value)
inline

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

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

Definition at line 115 of file CreatePortalResult.h.

◆ WithPortalArn() [2/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalArn ( Aws::String &&  value)
inline

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

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

Definition at line 124 of file CreatePortalResult.h.

◆ WithPortalArn() [3/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalArn ( const char *  value)
inline

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

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

Definition at line 133 of file CreatePortalResult.h.

◆ WithPortalId() [1/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalId ( const Aws::String value)
inline

The ID of the created portal.

Definition at line 59 of file CreatePortalResult.h.

◆ WithPortalId() [2/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalId ( Aws::String &&  value)
inline

The ID of the created portal.

Definition at line 64 of file CreatePortalResult.h.

◆ WithPortalId() [3/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalId ( const char *  value)
inline

The ID of the created portal.

Definition at line 69 of file CreatePortalResult.h.

◆ WithPortalStartUrl() [1/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalStartUrl ( const Aws::String value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 184 of file CreatePortalResult.h.

◆ WithPortalStartUrl() [2/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalStartUrl ( Aws::String &&  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 194 of file CreatePortalResult.h.

◆ WithPortalStartUrl() [3/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalStartUrl ( const char *  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 204 of file CreatePortalResult.h.

◆ WithPortalStatus() [1/2]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalStatus ( const PortalStatus value)
inline

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

Definition at line 229 of file CreatePortalResult.h.

◆ WithPortalStatus() [2/2]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithPortalStatus ( PortalStatus &&  value)
inline

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

Definition at line 235 of file CreatePortalResult.h.

◆ WithSsoApplicationId() [1/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithSsoApplicationId ( const Aws::String value)
inline

The associated AWS SSO application ID, if the portal uses AWS SSO.

Definition at line 261 of file CreatePortalResult.h.

◆ WithSsoApplicationId() [2/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithSsoApplicationId ( Aws::String &&  value)
inline

The associated AWS SSO application ID, if the portal uses AWS SSO.

Definition at line 266 of file CreatePortalResult.h.

◆ WithSsoApplicationId() [3/3]

CreatePortalResult& Aws::IoTSiteWise::Model::CreatePortalResult::WithSsoApplicationId ( const char *  value)
inline

The associated AWS SSO application ID, if the portal uses AWS SSO.

Definition at line 271 of file CreatePortalResult.h.


The documentation for this class was generated from the following file: