/*
* 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 opensearch-2021-01-01.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.OpenSearchService.Model
{
///
/// Container for the parameters to the StartServiceSoftwareUpdate operation.
/// Schedules a service software update for an Amazon OpenSearch Service domain. For more
/// information, see Service
/// software updates in Amazon OpenSearch Service.
///
public partial class StartServiceSoftwareUpdateRequest : AmazonOpenSearchServiceRequest
{
private long? _desiredStartTime;
private string _domainName;
private ScheduleAt _scheduleAt;
///
/// Gets and sets the property DesiredStartTime.
///
/// The Epoch timestamp when you want the service software update to start. You only need
/// to specify this parameter if you set ScheduleAt
to TIMESTAMP
.
///
///
public long DesiredStartTime
{
get { return this._desiredStartTime.GetValueOrDefault(); }
set { this._desiredStartTime = value; }
}
// Check to see if DesiredStartTime property is set
internal bool IsSetDesiredStartTime()
{
return this._desiredStartTime.HasValue;
}
///
/// Gets and sets the property DomainName.
///
/// The name of the domain that you want to update to the latest service software.
///
///
[AWSProperty(Required=true, Min=3, Max=28)]
public string DomainName
{
get { return this._domainName; }
set { this._domainName = value; }
}
// Check to see if DomainName property is set
internal bool IsSetDomainName()
{
return this._domainName != null;
}
///
/// Gets and sets the property ScheduleAt.
///
/// When to start the service software update.
///
/// -
///
///
NOW
- Immediately schedules the update to happen in the current hour
/// if there's capacity available.
///
/// -
///
///
TIMESTAMP
- Lets you specify a custom date and time to apply the update.
/// If you specify this value, you must also provide a value for DesiredStartTime
.
///
/// -
///
///
OFF_PEAK_WINDOW
- Marks the update to be picked up during an upcoming
/// off-peak window. There's no guarantee that the update will happen during the next
/// immediate window. Depending on capacity, it might happen in subsequent days.
///
///
///
/// Default: NOW
if you don't specify a value for DesiredStartTime
,
/// and TIMESTAMP
if you do.
///
///
public ScheduleAt ScheduleAt
{
get { return this._scheduleAt; }
set { this._scheduleAt = value; }
}
// Check to see if ScheduleAt property is set
internal bool IsSetScheduleAt()
{
return this._scheduleAt != null;
}
}
}