Class CfnServer
The AWS::OpsWorksCM::Server
resource creates an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise configuration management server.
Inherited Members
Namespace: Amazon.CDK.AWS.OpsWorksCM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnServer : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnServer
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see Create a Chef Automate Server in AWS CloudFormation or Create a Puppet Enterprise Master in AWS CloudFormation in the AWS OpsWorks User Guide , and CreateServer in the AWS OpsWorks CM API Reference .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html
CloudformationResource: AWS::OpsWorksCM::Server
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 cfnServer = new CfnServer(this, "MyCfnServer", 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" },
ServerName = "serverName",
SubnetIds = new [] { "subnetIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnServer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnServer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnServer(Construct, String, ICfnServerProps) |
Properties
AssociatePublicIpAddress | Associate a public IP address with a server that you are launching. |
AttrArn | The Amazon Resource Name (ARN) of the server, such as |
AttrEndpoint | A DNS name that can be used to access the engine. |
AttrServerName | The name of the server. |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
ServerName | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnServer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnServer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnServer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnServer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnServer(Construct, String, ICfnServerProps)
public CfnServer(Construct scope, string id, ICfnServerProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnServerProps
Resource properties.
Properties
AssociatePublicIpAddress
Associate a public IP address with a server that you are launching.
public virtual object AssociatePublicIpAddress { get; set; }
Property Value
System.Object
AttrArn
The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrEndpoint
A DNS name that can be used to access the engine.
public virtual string AttrEndpoint { get; }
Property Value
System.String
Remarks
Example: myserver-asdfghjkl.us-east-1.opsworks.io
.
CloudformationAttribute: Endpoint
AttrServerName
The name of the server.
public virtual string AttrServerName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServerName
BackupId
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
public virtual string BackupId { get; set; }
Property Value
System.String
BackupRetentionCount
The number of automated backups that you want to keep.
public virtual Nullable<double> BackupRetentionCount { get; set; }
Property Value
System.Nullable<System.Double>
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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:.
public virtual string CustomCertificate { get; set; }
Property Value
System.String
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
.
public virtual string CustomDomain { get; set; }
Property Value
System.String
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
.
public virtual string CustomPrivateKey { get; set; }
Property Value
System.String
DisableAutomatedBackup
Enable or disable scheduled backups.
public virtual object DisableAutomatedBackup { get; set; }
Property Value
System.Object
Engine
The configuration management engine to use.
public virtual string Engine { get; set; }
Property Value
System.String
EngineAttributes
Optional engine attributes on a specified server.
public virtual object EngineAttributes { get; set; }
Property Value
System.Object
EngineModel
The engine model of the server.
public virtual string EngineModel { get; set; }
Property Value
System.String
EngineVersion
The major release version of the engine that you want to use.
public virtual string EngineVersion { get; set; }
Property Value
System.String
InstanceProfileArn
The ARN of the instance profile that your Amazon EC2 instances use.
public virtual string InstanceProfileArn { get; set; }
Property Value
System.String
InstanceType
The Amazon EC2 instance type to use.
public virtual string InstanceType { get; set; }
Property Value
System.String
KeyPair
The Amazon EC2 key pair to set for the instance.
public virtual string KeyPair { get; set; }
Property Value
System.String
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.
public virtual string PreferredBackupWindow { get; set; }
Property Value
System.String
PreferredMaintenanceWindow
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
SecurityGroupIds
A list of security group IDs to attach to the Amazon EC2 instance.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
ServerName
public virtual string ServerName { get; set; }
Property Value
System.String
ServiceRoleArn
The service role that the AWS OpsWorks CM service backend uses to work with your account.
public virtual string ServiceRoleArn { get; set; }
Property Value
System.String
SubnetIds
The IDs of subnets in which to launch the server EC2 instance.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>