AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateServer operation. Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.

This operation is asynchronous.

A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.

If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group. The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

By default, the Chef Server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.OpsWorksCM.AmazonOpsWorksCMRequest
      Amazon.OpsWorksCM.Model.CreateServerRequest

Namespace: Amazon.OpsWorksCM.Model
Assembly: AWSSDK.OpsWorksCM.dll
Version: 3.x.y.z

Syntax

C#
public class CreateServerRequest : AmazonOpsWorksCMRequest
         IAmazonWebServiceRequest

The CreateServerRequest type exposes the following members

Constructors

NameDescription
Public Method CreateServerRequest()

Properties

NameTypeDescription
Public Property AssociatePublicIpAddress System.Boolean

Gets and sets the property AssociatePublicIpAddress.

Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

Public Property BackupId System.String

Gets and sets the property BackupId.

If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.

Public Property BackupRetentionCount System.Int32

Gets and sets the property BackupRetentionCount.

The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks for Chef Automate deletes the oldest backups if this number is exceeded. The default value is 1.

Public Property DisableAutomatedBackup System.Boolean

Gets and sets the property DisableAutomatedBackup.

Enable or disable scheduled backups. Valid values are true or false. The default value is true.

Public Property Engine System.String

Gets and sets the property Engine.

The configuration management engine to use. Valid values include Chef.

Public Property EngineAttributes System.Collections.Generic.List<Amazon.OpsWorksCM.Model.EngineAttribute>
Public Property EngineModel System.String

Gets and sets the property EngineModel.

The engine model, or option. Valid values include Single.

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

The major release version of the engine that you want to use. Values depend on the engine that you choose.

Public Property InstanceProfileArn System.String

Gets and sets the property InstanceProfileArn.

The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The Amazon EC2 instance type to use. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m4.large. Valid values are t2.medium, m4.large, or m4.2xlarge.

Public Property KeyPair System.String

Gets and sets the property KeyPair.

The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.

Public Property PreferredBackupWindow System.String

Gets and sets the property PreferredBackupWindow.

The start time for a one-hour period during which AWS OpsWorks for Chef Automate backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

  • HH:MM for daily backups

  • DDD:HH:MM for weekly backups

The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

Example: 08:00, which represents a daily start time of 08:00 UTC.

Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

Public Property SecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroupIds.

A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds.

If you do not specify this parameter, AWS OpsWorks for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

Public Property ServerName System.String

Gets and sets the property ServerName.

The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.

Public Property ServiceRoleArn System.String

Gets and sets the property ServiceRoleArn.

The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a CloudFormation stack that includes the service role that you need.

Public Property SubnetIds System.Collections.Generic.List<System.String>

Gets and sets the property SubnetIds.

The IDs of subnets in which to launch the server EC2 instance.

Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.

EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.

For more information about supported Amazon EC2 platforms, see Supported Platforms.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms