/* * 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 opsworkscm-2016-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.OpsWorksCM.Model { /// /// Describes a configuration management server. /// public partial class CMServer { private bool? _associatePublicIpAddress; private int? _backupRetentionCount; private string _cloudFormationStackArn; private DateTime? _createdAt; private string _customDomain; private bool? _disableAutomatedBackup; private string _endpoint; private string _engine; private List _engineAttributes = new List(); private string _engineModel; private string _engineVersion; private string _instanceProfileArn; private string _instanceType; private string _keyPair; private MaintenanceStatus _maintenanceStatus; private string _preferredBackupWindow; private string _preferredMaintenanceWindow; private List _securityGroupIds = new List(); private string _serverArn; private string _serverName; private string _serviceRoleArn; private ServerStatus _status; private string _statusReason; private List _subnetIds = new List(); /// /// Gets and sets the property AssociatePublicIpAddress. /// /// Associate a public IP address with a server that you are launching. /// /// public bool AssociatePublicIpAddress { get { return this._associatePublicIpAddress.GetValueOrDefault(); } set { this._associatePublicIpAddress = value; } } // Check to see if AssociatePublicIpAddress property is set internal bool IsSetAssociatePublicIpAddress() { return this._associatePublicIpAddress.HasValue; } /// /// Gets and sets the property BackupRetentionCount. /// /// The number of automated backups to keep. /// /// public int BackupRetentionCount { get { return this._backupRetentionCount.GetValueOrDefault(); } set { this._backupRetentionCount = value; } } // Check to see if BackupRetentionCount property is set internal bool IsSetBackupRetentionCount() { return this._backupRetentionCount.HasValue; } /// /// Gets and sets the property CloudFormationStackArn. /// /// The ARN of the CloudFormation stack that was used to create the server. /// /// [AWSProperty(Max=10000)] public string CloudFormationStackArn { get { return this._cloudFormationStackArn; } set { this._cloudFormationStackArn = value; } } // Check to see if CloudFormationStackArn property is set internal bool IsSetCloudFormationStackArn() { return this._cloudFormationStackArn != null; } /// /// Gets and sets the property CreatedAt. /// /// Time stamp of server creation. Example 2016-07-29T13:38:47.520Z /// /// public DateTime CreatedAt { get { return this._createdAt.GetValueOrDefault(); } set { this._createdAt = value; } } // Check to see if CreatedAt property is set internal bool IsSetCreatedAt() { return this._createdAt.HasValue; } /// /// Gets and sets the property CustomDomain. /// /// An optional public endpoint of a server, such as https://aws.my-company.com. /// You cannot access the server by using the Endpoint value if the server /// has a CustomDomain specified. /// /// [AWSProperty(Max=253)] public string CustomDomain { get { return this._customDomain; } set { this._customDomain = value; } } // Check to see if CustomDomain property is set internal bool IsSetCustomDomain() { return this._customDomain != null; } /// /// Gets and sets the property DisableAutomatedBackup. /// /// Disables automated backups. The number of stored backups is dependent on the value /// of PreferredBackupCount. /// /// public bool DisableAutomatedBackup { get { return this._disableAutomatedBackup.GetValueOrDefault(); } set { this._disableAutomatedBackup = value; } } // Check to see if DisableAutomatedBackup property is set internal bool IsSetDisableAutomatedBackup() { return this._disableAutomatedBackup.HasValue; } /// /// Gets and sets the property Endpoint. /// /// A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. /// You cannot access the server by using the Endpoint value if the server /// has a CustomDomain specified. /// /// [AWSProperty(Max=10000)] public string Endpoint { get { return this._endpoint; } set { this._endpoint = value; } } // Check to see if Endpoint property is set internal bool IsSetEndpoint() { return this._endpoint != null; } /// /// Gets and sets the property Engine. /// /// The engine type of the server. Valid values in this release include ChefAutomate /// and Puppet. /// /// [AWSProperty(Max=10000)] public string Engine { get { return this._engine; } set { this._engine = value; } } // Check to see if Engine property is set internal bool IsSetEngine() { return this._engine != null; } /// /// Gets and sets the property EngineAttributes. /// /// The response of a createServer() request returns the master credential to access the /// server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they /// are returned only as part of the result of createServer(). /// ///

Attributes returned in a createServer response for Chef /// /// ///

  • /// /// CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is /// generated by AWS OpsWorks for Chef Automate. This private key is required to access /// the Chef API. /// ///
  • /// /// CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a /// Chef starter kit, which includes a README, a configuration file, and the required /// RSA private key. Save this file, unzip it, and then change to the directory where /// you've unzipped the file contents. From this directory, you can run Knife commands. /// ///

Attributes returned in a createServer response for /// Puppet /// ///

  • /// /// PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains /// a Puppet starter kit, including a README and a required private key. Save this file, /// unzip it, and then change to the directory where you've unzipped the file contents. /// ///
  • /// /// PUPPET_ADMIN_PASSWORD: An administrator password that you can use to /// sign in to the Puppet Enterprise console after the server is online. /// ///
///
public List EngineAttributes { get { return this._engineAttributes; } set { this._engineAttributes = value; } } // Check to see if EngineAttributes property is set internal bool IsSetEngineAttributes() { return this._engineAttributes != null && this._engineAttributes.Count > 0; } /// /// Gets and sets the property EngineModel. /// /// The engine model of the server. Valid values in this release include Monolithic /// for Puppet and Single for Chef. /// /// [AWSProperty(Max=10000)] public string EngineModel { get { return this._engineModel; } set { this._engineModel = value; } } // Check to see if EngineModel property is set internal bool IsSetEngineModel() { return this._engineModel != null; } /// /// Gets and sets the property EngineVersion. /// /// The engine version of the server. For a Chef server, the valid value for EngineVersion /// is currently 2. For a Puppet server, specify either 2019 /// or 2017. /// /// [AWSProperty(Max=10000)] public string EngineVersion { get { return this._engineVersion; } set { this._engineVersion = value; } } // Check to see if EngineVersion property is set internal bool IsSetEngineVersion() { return this._engineVersion != null; } /// /// Gets and sets the property InstanceProfileArn. /// /// The instance profile ARN of the server. /// /// [AWSProperty(Max=10000)] public string InstanceProfileArn { get { return this._instanceProfileArn; } set { this._instanceProfileArn = value; } } // Check to see if InstanceProfileArn property is set internal bool IsSetInstanceProfileArn() { return this._instanceProfileArn != null; } /// /// Gets and sets the property InstanceType. /// /// The instance type for the server, as specified in the CloudFormation stack. This /// might not be the same instance type that is shown in the EC2 console. /// /// [AWSProperty(Max=10000)] public string InstanceType { get { return this._instanceType; } set { this._instanceType = value; } } // Check to see if InstanceType property is set internal bool IsSetInstanceType() { return this._instanceType != null; } /// /// Gets and sets the property KeyPair. /// /// The key pair associated with the server. /// /// [AWSProperty(Max=10000)] public string KeyPair { get { return this._keyPair; } set { this._keyPair = value; } } // Check to see if KeyPair property is set internal bool IsSetKeyPair() { return this._keyPair != null; } /// /// Gets and sets the property MaintenanceStatus. /// /// The status of the most recent server maintenance run. Shows SUCCESS or /// FAILED. /// /// public MaintenanceStatus MaintenanceStatus { get { return this._maintenanceStatus; } set { this._maintenanceStatus = value; } } // Check to see if MaintenanceStatus property is set internal bool IsSetMaintenanceStatus() { return this._maintenanceStatus != null; } /// /// Gets and sets the property PreferredBackupWindow. /// /// The preferred backup period specified for the server. /// /// [AWSProperty(Max=10000)] public string PreferredBackupWindow { get { return this._preferredBackupWindow; } set { this._preferredBackupWindow = value; } } // Check to see if PreferredBackupWindow property is set internal bool IsSetPreferredBackupWindow() { return this._preferredBackupWindow != null; } /// /// Gets and sets the property PreferredMaintenanceWindow. /// /// The preferred maintenance period specified for the server. /// /// [AWSProperty(Max=10000)] public string PreferredMaintenanceWindow { get { return this._preferredMaintenanceWindow; } set { this._preferredMaintenanceWindow = value; } } // Check to see if PreferredMaintenanceWindow property is set internal bool IsSetPreferredMaintenanceWindow() { return this._preferredMaintenanceWindow != null; } /// /// Gets and sets the property SecurityGroupIds. /// /// The security group IDs for the server, as specified in the CloudFormation stack. /// These might not be the same security groups that are shown in the EC2 console. /// /// public List SecurityGroupIds { get { return this._securityGroupIds; } set { this._securityGroupIds = value; } } // Check to see if SecurityGroupIds property is set internal bool IsSetSecurityGroupIds() { return this._securityGroupIds != null && this._securityGroupIds.Count > 0; } /// /// Gets and sets the property ServerArn. /// /// The ARN of the server. /// /// [AWSProperty(Max=10000)] public string ServerArn { get { return this._serverArn; } set { this._serverArn = value; } } // Check to see if ServerArn property is set internal bool IsSetServerArn() { return this._serverArn != null; } /// /// Gets and sets the property ServerName. /// /// The name of the server. /// /// [AWSProperty(Max=10000)] public string ServerName { get { return this._serverName; } set { this._serverName = value; } } // Check to see if ServerName property is set internal bool IsSetServerName() { return this._serverName != null; } /// /// Gets and sets the property ServiceRoleArn. /// /// The service role ARN used to create the server. /// /// [AWSProperty(Max=10000)] public string ServiceRoleArn { get { return this._serviceRoleArn; } set { this._serviceRoleArn = value; } } // Check to see if ServiceRoleArn property is set internal bool IsSetServiceRoleArn() { return this._serviceRoleArn != null; } /// /// Gets and sets the property Status. /// /// The server's status. This field displays the states of actions in progress, such /// as creating, running, or backing up the server, as well as the server's health state. /// /// /// public ServerStatus Status { get { return this._status; } set { this._status = value; } } // Check to see if Status property is set internal bool IsSetStatus() { return this._status != null; } /// /// Gets and sets the property StatusReason. /// /// Depending on the server status, this field has either a human-readable message (such /// as a create or backup error), or an escaped block of JSON (used for health check results). /// /// /// [AWSProperty(Max=10000)] public string StatusReason { get { return this._statusReason; } set { this._statusReason = value; } } // Check to see if StatusReason property is set internal bool IsSetStatusReason() { return this._statusReason != null; } /// /// Gets and sets the property SubnetIds. /// /// The subnet IDs specified in a CreateServer request. /// /// public List SubnetIds { get { return this._subnetIds; } set { this._subnetIds = value; } } // Check to see if SubnetIds property is set internal bool IsSetSubnetIds() { return this._subnetIds != null && this._subnetIds.Count > 0; } } }