/*
* 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 compute-optimizer-2019-11-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.ComputeOptimizer.Model
{
///
/// Container for the parameters to the UpdateEnrollmentStatus operation.
/// Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer
/// service.
///
///
///
/// If the account is a management account of an organization, this action can also be
/// used to enroll member accounts of the organization.
///
///
///
/// You must have the appropriate permissions to opt in to Compute Optimizer, to view
/// its recommendations, and to opt out. For more information, see Controlling
/// access with Amazon Web Services Identity and Access Management in the Compute
/// Optimizer User Guide.
///
///
///
/// When you opt in, Compute Optimizer automatically creates a service-linked role in
/// your account to access its data. For more information, see Using
/// Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.
///
///
public partial class UpdateEnrollmentStatusRequest : AmazonComputeOptimizerRequest
{
private bool? _includeMemberAccounts;
private Status _status;
///
/// Gets and sets the property IncludeMemberAccounts.
///
/// Indicates whether to enroll member accounts of the organization if the account is
/// the management account of an organization.
///
///
public bool IncludeMemberAccounts
{
get { return this._includeMemberAccounts.GetValueOrDefault(); }
set { this._includeMemberAccounts = value; }
}
// Check to see if IncludeMemberAccounts property is set
internal bool IsSetIncludeMemberAccounts()
{
return this._includeMemberAccounts.HasValue;
}
///
/// Gets and sets the property Status.
///
/// The new enrollment status of the account.
///
///
///
/// The following status options are available:
///
/// -
///
///
Active
- Opts in your account to the Compute Optimizer service. Compute
/// Optimizer begins analyzing the configuration and utilization metrics of your Amazon
/// Web Services resources after you opt in. For more information, see Metrics
/// analyzed by Compute Optimizer in the Compute Optimizer User Guide.
///
/// -
///
///
Inactive
- Opts out your account from the Compute Optimizer service.
/// Your account's recommendations and related metrics data will be deleted from Compute
/// Optimizer after you opt out.
///
///
///
/// The Pending
and Failed
options cannot be used to update
/// the enrollment status of an account. They are returned in the response of a request
/// to update the enrollment status of an account.
///
///
///
[AWSProperty(Required=true)]
public Status Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
}
}