/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the iotsitewise-2019-12-02.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.IoTSiteWise.Model
{
///
/// Container for the parameters to the UpdatePortal operation.
/// Updates an IoT SiteWise Monitor portal.
///
public partial class UpdatePortalRequest : AmazonIoTSiteWiseRequest
{
private Alarms _alarms;
private string _clientToken;
private string _notificationSenderEmail;
private string _portalContactEmail;
private string _portalDescription;
private string _portalId;
private Image _portalLogoImage;
private string _portalName;
private string _roleArn;
///
/// Gets and sets the property 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.
///
///
public Alarms Alarms
{
get { return this._alarms; }
set { this._alarms = value; }
}
// Check to see if Alarms property is set
internal bool IsSetAlarms()
{
return this._alarms != null;
}
///
/// Gets and sets the property 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.
///
///
[AWSProperty(Min=36, Max=64)]
public string ClientToken
{
get { return this._clientToken; }
set { this._clientToken = value; }
}
// Check to see if ClientToken property is set
internal bool IsSetClientToken()
{
return this._clientToken != null;
}
///
/// Gets and sets the property NotificationSenderEmail.
///
/// The email address that sends alarm notifications.
///
///
[AWSProperty(Min=1, Max=255)]
public string NotificationSenderEmail
{
get { return this._notificationSenderEmail; }
set { this._notificationSenderEmail = value; }
}
// Check to see if NotificationSenderEmail property is set
internal bool IsSetNotificationSenderEmail()
{
return this._notificationSenderEmail != null;
}
///
/// Gets and sets the property PortalContactEmail.
///
/// The Amazon Web Services administrator's contact email address.
///
///
[AWSProperty(Required=true, Min=1, Max=255)]
public string PortalContactEmail
{
get { return this._portalContactEmail; }
set { this._portalContactEmail = value; }
}
// Check to see if PortalContactEmail property is set
internal bool IsSetPortalContactEmail()
{
return this._portalContactEmail != null;
}
///
/// Gets and sets the property PortalDescription.
///
/// A new description for the portal.
///
///
[AWSProperty(Min=1, Max=2048)]
public string PortalDescription
{
get { return this._portalDescription; }
set { this._portalDescription = value; }
}
// Check to see if PortalDescription property is set
internal bool IsSetPortalDescription()
{
return this._portalDescription != null;
}
///
/// Gets and sets the property PortalId.
///
/// The ID of the portal to update.
///
///
[AWSProperty(Required=true, Min=36, Max=36)]
public string PortalId
{
get { return this._portalId; }
set { this._portalId = value; }
}
// Check to see if PortalId property is set
internal bool IsSetPortalId()
{
return this._portalId != null;
}
///
/// Gets and sets the property PortalLogoImage.
///
public Image PortalLogoImage
{
get { return this._portalLogoImage; }
set { this._portalLogoImage = value; }
}
// Check to see if PortalLogoImage property is set
internal bool IsSetPortalLogoImage()
{
return this._portalLogoImage != null;
}
///
/// Gets and sets the property PortalName.
///
/// A new friendly name for the portal.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string PortalName
{
get { return this._portalName; }
set { this._portalName = value; }
}
// Check to see if PortalName property is set
internal bool IsSetPortalName()
{
return this._portalName != null;
}
///
/// Gets and sets the property 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.
///
///
[AWSProperty(Required=true, Min=1, Max=1600)]
public string RoleArn
{
get { return this._roleArn; }
set { this._roleArn = value; }
}
// Check to see if RoleArn property is set
internal bool IsSetRoleArn()
{
return this._roleArn != null;
}
}
}