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

#include <CreatePortalRequest.h>

+ Inheritance diagram for Aws::IoTSiteWise::Model::CreatePortalRequest:

Public Member Functions

 CreatePortalRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetPortalName () const
 
bool PortalNameHasBeenSet () const
 
void SetPortalName (const Aws::String &value)
 
void SetPortalName (Aws::String &&value)
 
void SetPortalName (const char *value)
 
CreatePortalRequestWithPortalName (const Aws::String &value)
 
CreatePortalRequestWithPortalName (Aws::String &&value)
 
CreatePortalRequestWithPortalName (const char *value)
 
const Aws::StringGetPortalDescription () const
 
bool PortalDescriptionHasBeenSet () const
 
void SetPortalDescription (const Aws::String &value)
 
void SetPortalDescription (Aws::String &&value)
 
void SetPortalDescription (const char *value)
 
CreatePortalRequestWithPortalDescription (const Aws::String &value)
 
CreatePortalRequestWithPortalDescription (Aws::String &&value)
 
CreatePortalRequestWithPortalDescription (const char *value)
 
const Aws::StringGetPortalContactEmail () const
 
bool PortalContactEmailHasBeenSet () const
 
void SetPortalContactEmail (const Aws::String &value)
 
void SetPortalContactEmail (Aws::String &&value)
 
void SetPortalContactEmail (const char *value)
 
CreatePortalRequestWithPortalContactEmail (const Aws::String &value)
 
CreatePortalRequestWithPortalContactEmail (Aws::String &&value)
 
CreatePortalRequestWithPortalContactEmail (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreatePortalRequestWithClientToken (const Aws::String &value)
 
CreatePortalRequestWithClientToken (Aws::String &&value)
 
CreatePortalRequestWithClientToken (const char *value)
 
const ImageFileGetPortalLogoImageFile () const
 
bool PortalLogoImageFileHasBeenSet () const
 
void SetPortalLogoImageFile (const ImageFile &value)
 
void SetPortalLogoImageFile (ImageFile &&value)
 
CreatePortalRequestWithPortalLogoImageFile (const ImageFile &value)
 
CreatePortalRequestWithPortalLogoImageFile (ImageFile &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
CreatePortalRequestWithRoleArn (const Aws::String &value)
 
CreatePortalRequestWithRoleArn (Aws::String &&value)
 
CreatePortalRequestWithRoleArn (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreatePortalRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
CreatePortalRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
CreatePortalRequestAddTags (const Aws::String &key, const Aws::String &value)
 
CreatePortalRequestAddTags (Aws::String &&key, const Aws::String &value)
 
CreatePortalRequestAddTags (const Aws::String &key, Aws::String &&value)
 
CreatePortalRequestAddTags (Aws::String &&key, Aws::String &&value)
 
CreatePortalRequestAddTags (const char *key, Aws::String &&value)
 
CreatePortalRequestAddTags (Aws::String &&key, const char *value)
 
CreatePortalRequestAddTags (const char *key, const char *value)
 
const AuthModeGetPortalAuthMode () const
 
bool PortalAuthModeHasBeenSet () const
 
void SetPortalAuthMode (const AuthMode &value)
 
void SetPortalAuthMode (AuthMode &&value)
 
CreatePortalRequestWithPortalAuthMode (const AuthMode &value)
 
CreatePortalRequestWithPortalAuthMode (AuthMode &&value)
 
- Public Member Functions inherited from Aws::IoTSiteWise::IoTSiteWiseRequest
virtual ~IoTSiteWiseRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::IoTSiteWise::IoTSiteWiseRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file CreatePortalRequest.h.

Constructor & Destructor Documentation

◆ CreatePortalRequest()

Aws::IoTSiteWise::Model::CreatePortalRequest::CreatePortalRequest ( )

Member Function Documentation

◆ AddTags() [1/7]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 406 of file CreatePortalRequest.h.

◆ AddTags() [2/7]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 415 of file CreatePortalRequest.h.

◆ AddTags() [3/7]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 424 of file CreatePortalRequest.h.

◆ AddTags() [4/7]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 433 of file CreatePortalRequest.h.

◆ AddTags() [5/7]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 442 of file CreatePortalRequest.h.

◆ AddTags() [6/7]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 451 of file CreatePortalRequest.h.

◆ AddTags() [7/7]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 460 of file CreatePortalRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::IoTSiteWise::Model::CreatePortalRequest::ClientTokenHasBeenSet ( ) const
inline

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.

Definition at line 174 of file CreatePortalRequest.h.

◆ GetClientToken()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalRequest::GetClientToken ( ) const
inline

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.

Definition at line 167 of file CreatePortalRequest.h.

◆ GetPortalAuthMode()

const AuthMode& Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalAuthMode ( ) const
inline

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. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions.

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

Default: SSO

Definition at line 479 of file CreatePortalRequest.h.

◆ GetPortalContactEmail()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalContactEmail ( ) const
inline

The AWS administrator's contact email address.

Definition at line 124 of file CreatePortalRequest.h.

◆ GetPortalDescription()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalDescription ( ) const
inline

A description for the portal.

Definition at line 83 of file CreatePortalRequest.h.

◆ GetPortalLogoImageFile()

const ImageFile& Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalLogoImageFile ( ) const
inline

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

Definition at line 223 of file CreatePortalRequest.h.

◆ GetPortalName()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalName ( ) const
inline

A friendly name for the portal.

Definition at line 42 of file CreatePortalRequest.h.

◆ GetRoleArn()

const Aws::String& Aws::IoTSiteWise::Model::CreatePortalRequest::GetRoleArn ( ) const
inline

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.

Definition at line 265 of file CreatePortalRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoTSiteWise::Model::CreatePortalRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreatePortalRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::IoTSiteWise::Model::CreatePortalRequest::GetTags ( ) const
inline

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.

Definition at line 352 of file CreatePortalRequest.h.

◆ PortalAuthModeHasBeenSet()

bool Aws::IoTSiteWise::Model::CreatePortalRequest::PortalAuthModeHasBeenSet ( ) const
inline

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. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions.

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

Default: SSO

Definition at line 497 of file CreatePortalRequest.h.

◆ PortalContactEmailHasBeenSet()

bool Aws::IoTSiteWise::Model::CreatePortalRequest::PortalContactEmailHasBeenSet ( ) const
inline

The AWS administrator's contact email address.

Definition at line 129 of file CreatePortalRequest.h.

◆ PortalDescriptionHasBeenSet()

bool Aws::IoTSiteWise::Model::CreatePortalRequest::PortalDescriptionHasBeenSet ( ) const
inline

A description for the portal.

Definition at line 88 of file CreatePortalRequest.h.

◆ PortalLogoImageFileHasBeenSet()

bool Aws::IoTSiteWise::Model::CreatePortalRequest::PortalLogoImageFileHasBeenSet ( ) const
inline

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

Definition at line 229 of file CreatePortalRequest.h.

◆ PortalNameHasBeenSet()

bool Aws::IoTSiteWise::Model::CreatePortalRequest::PortalNameHasBeenSet ( ) const
inline

A friendly name for the portal.

Definition at line 47 of file CreatePortalRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::IoTSiteWise::Model::CreatePortalRequest::RoleArnHasBeenSet ( ) const
inline

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.

Definition at line 276 of file CreatePortalRequest.h.

◆ SerializePayload()

Aws::String Aws::IoTSiteWise::Model::CreatePortalRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetClientToken ( const Aws::String value)
inline

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.

Definition at line 181 of file CreatePortalRequest.h.

◆ SetClientToken() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetClientToken ( Aws::String &&  value)
inline

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.

Definition at line 188 of file CreatePortalRequest.h.

◆ SetClientToken() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetClientToken ( const char *  value)
inline

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.

Definition at line 195 of file CreatePortalRequest.h.

◆ SetPortalAuthMode() [1/2]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalAuthMode ( const AuthMode value)
inline

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. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions.

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

Default: SSO

Definition at line 515 of file CreatePortalRequest.h.

◆ SetPortalAuthMode() [2/2]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalAuthMode ( AuthMode &&  value)
inline

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. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions.

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

Default: SSO

Definition at line 533 of file CreatePortalRequest.h.

◆ SetPortalContactEmail() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalContactEmail ( const Aws::String value)
inline

The AWS administrator's contact email address.

Definition at line 134 of file CreatePortalRequest.h.

◆ SetPortalContactEmail() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalContactEmail ( Aws::String &&  value)
inline

The AWS administrator's contact email address.

Definition at line 139 of file CreatePortalRequest.h.

◆ SetPortalContactEmail() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalContactEmail ( const char *  value)
inline

The AWS administrator's contact email address.

Definition at line 144 of file CreatePortalRequest.h.

◆ SetPortalDescription() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalDescription ( const Aws::String value)
inline

A description for the portal.

Definition at line 93 of file CreatePortalRequest.h.

◆ SetPortalDescription() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalDescription ( Aws::String &&  value)
inline

A description for the portal.

Definition at line 98 of file CreatePortalRequest.h.

◆ SetPortalDescription() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalDescription ( const char *  value)
inline

A description for the portal.

Definition at line 103 of file CreatePortalRequest.h.

◆ SetPortalLogoImageFile() [1/2]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalLogoImageFile ( const ImageFile value)
inline

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

Definition at line 235 of file CreatePortalRequest.h.

◆ SetPortalLogoImageFile() [2/2]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalLogoImageFile ( ImageFile &&  value)
inline

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

Definition at line 241 of file CreatePortalRequest.h.

◆ SetPortalName() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalName ( const Aws::String value)
inline

A friendly name for the portal.

Definition at line 52 of file CreatePortalRequest.h.

◆ SetPortalName() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalName ( Aws::String &&  value)
inline

A friendly name for the portal.

Definition at line 57 of file CreatePortalRequest.h.

◆ SetPortalName() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalName ( const char *  value)
inline

A friendly name for the portal.

Definition at line 62 of file CreatePortalRequest.h.

◆ SetRoleArn() [1/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetRoleArn ( const Aws::String value)
inline

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.

Definition at line 287 of file CreatePortalRequest.h.

◆ SetRoleArn() [2/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 298 of file CreatePortalRequest.h.

◆ SetRoleArn() [3/3]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetRoleArn ( const char *  value)
inline

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.

Definition at line 309 of file CreatePortalRequest.h.

◆ SetTags() [1/2]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 370 of file CreatePortalRequest.h.

◆ SetTags() [2/2]

void Aws::IoTSiteWise::Model::CreatePortalRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 379 of file CreatePortalRequest.h.

◆ TagsHasBeenSet()

bool Aws::IoTSiteWise::Model::CreatePortalRequest::TagsHasBeenSet ( ) const
inline

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.

Definition at line 361 of file CreatePortalRequest.h.

◆ WithClientToken() [1/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithClientToken ( const Aws::String value)
inline

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.

Definition at line 202 of file CreatePortalRequest.h.

◆ WithClientToken() [2/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithClientToken ( Aws::String &&  value)
inline

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.

Definition at line 209 of file CreatePortalRequest.h.

◆ WithClientToken() [3/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithClientToken ( const char *  value)
inline

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.

Definition at line 216 of file CreatePortalRequest.h.

◆ WithPortalAuthMode() [1/2]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalAuthMode ( const AuthMode value)
inline

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. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions.

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

Default: SSO

Definition at line 551 of file CreatePortalRequest.h.

◆ WithPortalAuthMode() [2/2]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalAuthMode ( AuthMode &&  value)
inline

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. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions.

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

Default: SSO

Definition at line 569 of file CreatePortalRequest.h.

◆ WithPortalContactEmail() [1/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalContactEmail ( const Aws::String value)
inline

The AWS administrator's contact email address.

Definition at line 149 of file CreatePortalRequest.h.

◆ WithPortalContactEmail() [2/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalContactEmail ( Aws::String &&  value)
inline

The AWS administrator's contact email address.

Definition at line 154 of file CreatePortalRequest.h.

◆ WithPortalContactEmail() [3/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalContactEmail ( const char *  value)
inline

The AWS administrator's contact email address.

Definition at line 159 of file CreatePortalRequest.h.

◆ WithPortalDescription() [1/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalDescription ( const Aws::String value)
inline

A description for the portal.

Definition at line 108 of file CreatePortalRequest.h.

◆ WithPortalDescription() [2/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalDescription ( Aws::String &&  value)
inline

A description for the portal.

Definition at line 113 of file CreatePortalRequest.h.

◆ WithPortalDescription() [3/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalDescription ( const char *  value)
inline

A description for the portal.

Definition at line 118 of file CreatePortalRequest.h.

◆ WithPortalLogoImageFile() [1/2]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalLogoImageFile ( const ImageFile value)
inline

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

Definition at line 247 of file CreatePortalRequest.h.

◆ WithPortalLogoImageFile() [2/2]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalLogoImageFile ( ImageFile &&  value)
inline

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

Definition at line 253 of file CreatePortalRequest.h.

◆ WithPortalName() [1/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalName ( const Aws::String value)
inline

A friendly name for the portal.

Definition at line 67 of file CreatePortalRequest.h.

◆ WithPortalName() [2/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalName ( Aws::String &&  value)
inline

A friendly name for the portal.

Definition at line 72 of file CreatePortalRequest.h.

◆ WithPortalName() [3/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalName ( const char *  value)
inline

A friendly name for the portal.

Definition at line 77 of file CreatePortalRequest.h.

◆ WithRoleArn() [1/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithRoleArn ( const Aws::String value)
inline

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.

Definition at line 320 of file CreatePortalRequest.h.

◆ WithRoleArn() [2/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 331 of file CreatePortalRequest.h.

◆ WithRoleArn() [3/3]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithRoleArn ( const char *  value)
inline

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.

Definition at line 342 of file CreatePortalRequest.h.

◆ WithTags() [1/2]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 388 of file CreatePortalRequest.h.

◆ WithTags() [2/2]

CreatePortalRequest& Aws::IoTSiteWise::Model::CreatePortalRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 397 of file CreatePortalRequest.h.


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