Interface ICfnServerProps
Properties for defining a CfnServer
.
Namespace: Amazon.CDK.AWS.OpsWorksCM
Assembly: Amazon.CDK.AWS.OpsWorksCM.dll
Syntax (csharp)
public interface ICfnServerProps
Syntax (vb)
Public Interface ICfnServerProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.OpsWorksCM;
var cfnServerProps = new CfnServerProps {
InstanceProfileArn = "instanceProfileArn",
InstanceType = "instanceType",
ServiceRoleArn = "serviceRoleArn",
// the properties below are optional
AssociatePublicIpAddress = false,
BackupId = "backupId",
BackupRetentionCount = 123,
CustomCertificate = "customCertificate",
CustomDomain = "customDomain",
CustomPrivateKey = "customPrivateKey",
DisableAutomatedBackup = false,
Engine = "engine",
EngineAttributes = new [] { new EngineAttributeProperty {
Name = "name",
Value = "value"
} },
EngineModel = "engineModel",
EngineVersion = "engineVersion",
KeyPair = "keyPair",
PreferredBackupWindow = "preferredBackupWindow",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
AssociatePublicIpAddress | Associate a public IP address with a server that you are launching. |
BackupId | If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId. |
BackupRetentionCount | The number of automated backups that you want to keep. |
CustomCertificate | Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for |
CustomDomain | Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as |
CustomPrivateKey | Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for |
DisableAutomatedBackup | Enable or disable scheduled backups. |
Engine | The configuration management engine to use. |
EngineAttributes | Optional engine attributes on a specified server. |
EngineModel | The engine model of the server. |
EngineVersion | The major release version of the engine that you want to use. |
InstanceProfileArn | The ARN of the instance profile that your Amazon EC2 instances use. |
InstanceType | The Amazon EC2 instance type to use. |
KeyPair | The Amazon EC2 key pair to set for the instance. |
PreferredBackupWindow | The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. |
PreferredMaintenanceWindow | The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. |
SecurityGroupIds | A list of security group IDs to attach to the Amazon EC2 instance. |
ServiceRoleArn | The service role that the AWS OpsWorks CM service backend uses to work with your account. |
SubnetIds | The IDs of subnets in which to launch the server EC2 instance. |
Tags | A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server. |
Properties
AssociatePublicIpAddress
Associate a public IP address with a server that you are launching.
virtual object AssociatePublicIpAddress { get; }
Property Value
System.Object
Remarks
Valid values are true
or false
. The default value is true
.
BackupId
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
virtual string BackupId { get; }
Property Value
System.String
Remarks
BackupRetentionCount
The number of automated backups that you want to keep.
virtual Nullable<double> BackupRetentionCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1
.
CustomCertificate
Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain
and CustomPrivateKey
. The following are requirements for the CustomCertificate
value:.
virtual string CustomCertificate { get; }
Property Value
System.String
Remarks
CustomDomain
Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as https://aws.my-company.com
. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint
value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate
and CustomPrivateKey
.
virtual string CustomDomain { get; }
Property Value
System.String
Remarks
CustomPrivateKey
Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain
and CustomCertificate
.
virtual string CustomPrivateKey { get; }
Property Value
System.String
Remarks
DisableAutomatedBackup
Enable or disable scheduled backups.
virtual object DisableAutomatedBackup { get; }
Property Value
System.Object
Remarks
Valid values are true
or false
. The default value is true
.
Engine
The configuration management engine to use.
virtual string Engine { get; }
Property Value
System.String
Remarks
Valid values include ChefAutomate
and Puppet
.
EngineAttributes
Optional engine attributes on a specified server.
virtual object EngineAttributes { get; }
Property Value
System.Object
Remarks
Attributes accepted in a Chef createServer request: - CHEF_AUTOMATE_PIVOTAL_KEY
: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response. When you are specifying the value of CHEF_AUTOMATE_PIVOTAL_KEY as a parameter in the AWS CloudFormation console, you must add newline ( \n
) characters at the end of each line of the pivotal key value.
Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD
: To work with the Puppet Enterprise console, a password must use ASCII characters.
EngineModel
The engine model of the server.
virtual string EngineModel { get; }
Property Value
System.String
Remarks
Valid values in this release include Monolithic
for Puppet and Single
for Chef.
EngineVersion
The major release version of the engine that you want to use.
virtual string EngineVersion { get; }
Property Value
System.String
Remarks
For a Chef server, the valid value for EngineVersion is currently 2
. For a Puppet server, valid values are 2019
or 2017
.
InstanceProfileArn
The ARN of the instance profile that your Amazon EC2 instances use.
string InstanceProfileArn { get; }
Property Value
System.String
Remarks
InstanceType
The Amazon EC2 instance type to use.
string InstanceType { get; }
Property Value
System.String
Remarks
KeyPair
The Amazon EC2 key pair to set for the instance.
virtual string KeyPair { get; }
Property Value
System.String
Remarks
This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.
PreferredBackupWindow
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.
virtual string PreferredBackupWindow { get; }
Property Value
System.String
Remarks
Valid values must be specified in one of the following formats:
MM
must be specified as 00
. 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.)
PreferredMaintenanceWindow
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
virtual string PreferredMaintenanceWindow { get; }
Property Value
System.String
Remarks
Valid values must be specified in the following format: DDD:HH:MM
. MM
must be specified as 00
. 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.)
SecurityGroupIds
A list of security group IDs to attach to the Amazon EC2 instance.
virtual string[] SecurityGroupIds { get; }
Property Value
System.String[]
Remarks
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 CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
ServiceRoleArn
The service role that the AWS OpsWorks CM service backend uses to work with your account.
string ServiceRoleArn { get; }
Property Value
System.String
Remarks
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-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.
SubnetIds
The IDs of subnets in which to launch the server EC2 instance.
virtual string[] SubnetIds { get; }
Property Value
System.String[]
Remarks
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 .
Tags
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]