Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. opsworkscm
  5. Server

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.opsworkscm.Server

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::OpsWorksCM::Server

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var pivotalKey = config.Require("pivotalKey");
    var password = config.Require("password");
    var myChefServer = new AwsNative.OpsWorksCm.Server("myChefServer", new()
    {
        BackupRetentionCount = 12,
        CustomCertificate = "-----BEGIN CERTIFICATE----- EXAMPLEqEXAMPLE== -----END CERTIFICATE-----",
        CustomDomain = "https://aws.my-company.com",
        CustomPrivateKey = "-----BEGIN RSA PRIVATE KEY----- EXAMPLEqEXAMPLE= -----END RSA PRIVATE KEY-----",
        DisableAutomatedBackup = false,
        Engine = "ChefAutomate",
        EngineVersion = "2",
        EngineAttributes = new[]
        {
            new AwsNative.OpsWorksCm.Inputs.ServerEngineAttributeArgs
            {
                Name = "CHEF_AUTOMATE_PIVOTAL_KEY",
                Value = pivotalKey,
            },
            new AwsNative.OpsWorksCm.Inputs.ServerEngineAttributeArgs
            {
                Name = "CHEF_AUTOMATE_ADMIN_PASSWORD",
                Value = password,
            },
        },
        EngineModel = "Single",
        InstanceProfileArn = "INSTANCE-PROFILE-ARN",
        InstanceType = "r5.xlarge",
        PreferredBackupWindow = "08:00",
        PreferredMaintenanceWindow = "Fri:08:00",
        ServiceRoleArn = "SERVICE-ROLE-ARN",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "Stage",
                Value = "Production",
            },
            new AwsNative.Inputs.TagArgs
            {
                Key = "Name",
                Value = "test-owcm-server",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["endpoint"] = myChefServer.Endpoint,
    };
});

    package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/opsworkscm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		pivotalKey := cfg.Require("pivotalKey")
		password := cfg.Require("password")
		myChefServer, err := opsworkscm.NewServer(ctx, "myChefServer", &opsworkscm.ServerArgs{
			BackupRetentionCount:   pulumi.Int(12),
			CustomCertificate:      pulumi.String("-----BEGIN CERTIFICATE----- EXAMPLEqEXAMPLE== -----END CERTIFICATE-----"),
			CustomDomain:           pulumi.String("https://aws.my-company.com"),
			CustomPrivateKey:       pulumi.String("-----BEGIN RSA PRIVATE KEY----- EXAMPLEqEXAMPLE= -----END RSA PRIVATE KEY-----"),
			DisableAutomatedBackup: pulumi.Bool(false),
			Engine:                 pulumi.String("ChefAutomate"),
			EngineVersion:          pulumi.String("2"),
			EngineAttributes: opsworkscm.ServerEngineAttributeArray{
				&opsworkscm.ServerEngineAttributeArgs{
					Name:  pulumi.String("CHEF_AUTOMATE_PIVOTAL_KEY"),
					Value: pulumi.String(pivotalKey),
				},
				&opsworkscm.ServerEngineAttributeArgs{
					Name:  pulumi.String("CHEF_AUTOMATE_ADMIN_PASSWORD"),
					Value: pulumi.String(password),
				},
			},
			EngineModel:                pulumi.String("Single"),
			InstanceProfileArn:         pulumi.String("INSTANCE-PROFILE-ARN"),
			InstanceType:               pulumi.String("r5.xlarge"),
			PreferredBackupWindow:      pulumi.String("08:00"),
			PreferredMaintenanceWindow: pulumi.String("Fri:08:00"),
			ServiceRoleArn:             pulumi.String("SERVICE-ROLE-ARN"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("Stage"),
					Value: pulumi.String("Production"),
				},
				&aws.TagArgs{
					Key:   pulumi.String("Name"),
					Value: pulumi.String("test-owcm-server"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("endpoint", myChefServer.Endpoint)
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
pivotal_key = config.require("pivotalKey")
password = config.require("password")
my_chef_server = aws_native.opsworkscm.Server("myChefServer",
    backup_retention_count=12,
    custom_certificate="-----BEGIN CERTIFICATE----- EXAMPLEqEXAMPLE== -----END CERTIFICATE-----",
    custom_domain="https://aws.my-company.com",
    custom_private_key="-----BEGIN RSA PRIVATE KEY----- EXAMPLEqEXAMPLE= -----END RSA PRIVATE KEY-----",
    disable_automated_backup=False,
    engine="ChefAutomate",
    engine_version="2",
    engine_attributes=[
        {
            "name": "CHEF_AUTOMATE_PIVOTAL_KEY",
            "value": pivotal_key,
        },
        {
            "name": "CHEF_AUTOMATE_ADMIN_PASSWORD",
            "value": password,
        },
    ],
    engine_model="Single",
    instance_profile_arn="INSTANCE-PROFILE-ARN",
    instance_type="r5.xlarge",
    preferred_backup_window="08:00",
    preferred_maintenance_window="Fri:08:00",
    service_role_arn="SERVICE-ROLE-ARN",
    tags=[
        {
            "key": "Stage",
            "value": "Production",
        },
        {
            "key": "Name",
            "value": "test-owcm-server",
        },
    ])
pulumi.export("endpoint", my_chef_server.endpoint)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const pivotalKey = config.require("pivotalKey");
const password = config.require("password");
const myChefServer = new aws_native.opsworkscm.Server("myChefServer", {
    backupRetentionCount: 12,
    customCertificate: "-----BEGIN CERTIFICATE----- EXAMPLEqEXAMPLE== -----END CERTIFICATE-----",
    customDomain: "https://aws.my-company.com",
    customPrivateKey: "-----BEGIN RSA PRIVATE KEY----- EXAMPLEqEXAMPLE= -----END RSA PRIVATE KEY-----",
    disableAutomatedBackup: false,
    engine: "ChefAutomate",
    engineVersion: "2",
    engineAttributes: [
        {
            name: "CHEF_AUTOMATE_PIVOTAL_KEY",
            value: pivotalKey,
        },
        {
            name: "CHEF_AUTOMATE_ADMIN_PASSWORD",
            value: password,
        },
    ],
    engineModel: "Single",
    instanceProfileArn: "INSTANCE-PROFILE-ARN",
    instanceType: "r5.xlarge",
    preferredBackupWindow: "08:00",
    preferredMaintenanceWindow: "Fri:08:00",
    serviceRoleArn: "SERVICE-ROLE-ARN",
    tags: [
        {
            key: "Stage",
            value: "Production",
        },
        {
            key: "Name",
            value: "test-owcm-server",
        },
    ],
});
export const endpoint = myChefServer.endpoint;

    Coming soon!

    Create Server Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Server(name: string, args: ServerArgs, opts?: CustomResourceOptions);
    @overload
def Server(resource_name: str,
           args: ServerArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Server(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           instance_profile_arn: Optional[str] = None,
           service_role_arn: Optional[str] = None,
           instance_type: Optional[str] = None,
           engine_version: Optional[str] = None,
           backup_retention_count: Optional[int] = None,
           custom_private_key: Optional[str] = None,
           disable_automated_backup: Optional[bool] = None,
           engine: Optional[str] = None,
           engine_attributes: Optional[Sequence[ServerEngineAttributeArgs]] = None,
           engine_model: Optional[str] = None,
           associate_public_ip_address: Optional[bool] = None,
           custom_certificate: Optional[str] = None,
           custom_domain: Optional[str] = None,
           key_pair: Optional[str] = None,
           preferred_backup_window: Optional[str] = None,
           preferred_maintenance_window: Optional[str] = None,
           security_group_ids: Optional[Sequence[str]] = None,
           server_name: Optional[str] = None,
           backup_id: Optional[str] = None,
           subnet_ids: Optional[Sequence[str]] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewServer(ctx *Context, name string, args ServerArgs, opts ...ResourceOption) (*Server, error)
    public Server(string name, ServerArgs args, CustomResourceOptions? opts = null)
    public Server(String name, ServerArgs args)
public Server(String name, ServerArgs args, CustomResourceOptions options)

    type: aws-native:opsworkscm:Server
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Server Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Server resource accepts the following input properties:

    InstanceProfileArn string
    The ARN of the instance profile that your Amazon EC2 instances use.
    InstanceType string
    The Amazon EC2 instance type to use. For example, m5.large .
    ServiceRoleArn string
    The service role that the AWS OpsWorks CM 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-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.
    AssociatePublicIpAddress bool
    Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
    BackupId string
    If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
    BackupRetentionCount int
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    CustomCertificate string
    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:

    • You can provide either a self-signed, custom certificate, or the full certificate chain.
    • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
    • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
    • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
    • The certificate must match the value of CustomPrivateKey .
    CustomDomain string
    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 .
    CustomPrivateKey string
    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 .
    DisableAutomatedBackup bool
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    Engine string
    The configuration management engine to use. Valid values include ChefAutomate and Puppet .
    EngineAttributes List<Pulumi.AwsNative.OpsWorksCm.Inputs.ServerEngineAttribute>

    Optional engine attributes on a specified server.

    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.

    • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

    Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    EngineModel string
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    EngineVersion string
    The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .
    KeyPair string
    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.
    PreferredBackupWindow string

    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. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    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 string

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. 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 List<string>

    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 CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    ServerName string
    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.
    SubnetIds List<string>

    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 .

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

    • The key cannot be empty.
    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • Leading and trailing spaces are trimmed from both the key and value.
    • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks CM server.
    InstanceProfileArn string
    The ARN of the instance profile that your Amazon EC2 instances use.
    InstanceType string
    The Amazon EC2 instance type to use. For example, m5.large .
    ServiceRoleArn string
    The service role that the AWS OpsWorks CM 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-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.
    AssociatePublicIpAddress bool
    Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
    BackupId string
    If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
    BackupRetentionCount int
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    CustomCertificate string
    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:

    • You can provide either a self-signed, custom certificate, or the full certificate chain.
    • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
    • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
    • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
    • The certificate must match the value of CustomPrivateKey .
    CustomDomain string
    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 .
    CustomPrivateKey string
    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 .
    DisableAutomatedBackup bool
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    Engine string
    The configuration management engine to use. Valid values include ChefAutomate and Puppet .
    EngineAttributes []ServerEngineAttributeArgs

    Optional engine attributes on a specified server.

    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.

    • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

    Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    EngineModel string
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    EngineVersion string
    The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .
    KeyPair string
    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.
    PreferredBackupWindow string

    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. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    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 string

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. 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 []string

    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 CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    ServerName string
    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.
    SubnetIds []string

    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 .

    Tags TagArgs
    A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

    • The key cannot be empty.
    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • Leading and trailing spaces are trimmed from both the key and value.
    • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks CM server.
    instanceProfileArn String
    The ARN of the instance profile that your Amazon EC2 instances use.
    instanceType String
    The Amazon EC2 instance type to use. For example, m5.large .
    serviceRoleArn String
    The service role that the AWS OpsWorks CM 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-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.
    associatePublicIpAddress Boolean
    Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
    backupId String
    If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
    backupRetentionCount Integer
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    customCertificate String
    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:

    • You can provide either a self-signed, custom certificate, or the full certificate chain.
    • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
    • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
    • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
    • The certificate must match the value of CustomPrivateKey .
    customDomain String
    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 .
    customPrivateKey String
    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 .
    disableAutomatedBackup Boolean
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    engine String
    The configuration management engine to use. Valid values include ChefAutomate and Puppet .
    engineAttributes List<ServerEngineAttribute>

    Optional engine attributes on a specified server.

    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.

    • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

    Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    engineModel String
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    engineVersion String
    The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .
    keyPair String
    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.
    preferredBackupWindow String

    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. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    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 String

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. 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 List<String>

    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 CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    serverName String
    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.
    subnetIds List<String>

    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 .

    tags List<Tag>
    A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

    • The key cannot be empty.
    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • Leading and trailing spaces are trimmed from both the key and value.
    • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks CM server.
    instanceProfileArn string
    The ARN of the instance profile that your Amazon EC2 instances use.
    instanceType string
    The Amazon EC2 instance type to use. For example, m5.large .
    serviceRoleArn string
    The service role that the AWS OpsWorks CM 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-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.
    associatePublicIpAddress boolean
    Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
    backupId string
    If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
    backupRetentionCount number
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    customCertificate string
    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:

    • You can provide either a self-signed, custom certificate, or the full certificate chain.
    • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
    • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
    • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
    • The certificate must match the value of CustomPrivateKey .
    customDomain string
    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 .
    customPrivateKey string
    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 .
    disableAutomatedBackup boolean
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    engine string
    The configuration management engine to use. Valid values include ChefAutomate and Puppet .
    engineAttributes ServerEngineAttribute[]

    Optional engine attributes on a specified server.

    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.

    • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

    Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    engineModel string
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    engineVersion string
    The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .
    keyPair string
    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.
    preferredBackupWindow string

    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. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    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 string

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. 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 string[]

    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 CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    serverName string
    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.
    subnetIds string[]

    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 .

    tags Tag[]
    A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

    • The key cannot be empty.
    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • Leading and trailing spaces are trimmed from both the key and value.
    • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks CM server.
    instance_profile_arn str
    The ARN of the instance profile that your Amazon EC2 instances use.
    instance_type str
    The Amazon EC2 instance type to use. For example, m5.large .
    service_role_arn str
    The service role that the AWS OpsWorks CM 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-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.
    associate_public_ip_address bool
    Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
    backup_id str
    If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
    backup_retention_count int
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    custom_certificate str
    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:

    • You can provide either a self-signed, custom certificate, or the full certificate chain.
    • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
    • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
    • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
    • The certificate must match the value of CustomPrivateKey .
    custom_domain str
    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 .
    custom_private_key str
    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 .
    disable_automated_backup bool
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    engine str
    The configuration management engine to use. Valid values include ChefAutomate and Puppet .
    engine_attributes Sequence[ServerEngineAttributeArgs]

    Optional engine attributes on a specified server.

    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.

    • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

    Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    engine_model str
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    engine_version str
    The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .
    key_pair str
    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.
    preferred_backup_window str

    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. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    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.)

    preferred_maintenance_window str

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. 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.)

    security_group_ids Sequence[str]

    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 CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    server_name str
    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.
    subnet_ids Sequence[str]

    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 .

    tags Sequence[TagArgs]
    A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

    • The key cannot be empty.
    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • Leading and trailing spaces are trimmed from both the key and value.
    • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks CM server.
    instanceProfileArn String
    The ARN of the instance profile that your Amazon EC2 instances use.
    instanceType String
    The Amazon EC2 instance type to use. For example, m5.large .
    serviceRoleArn String
    The service role that the AWS OpsWorks CM 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-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.
    associatePublicIpAddress Boolean
    Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
    backupId String
    If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
    backupRetentionCount Number
    The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
    customCertificate String
    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:

    • You can provide either a self-signed, custom certificate, or the full certificate chain.
    • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
    • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
    • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
    • The certificate must match the value of CustomPrivateKey .
    customDomain String
    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 .
    customPrivateKey String
    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 .
    disableAutomatedBackup Boolean
    Enable or disable scheduled backups. Valid values are true or false . The default value is true .
    engine String
    The configuration management engine to use. Valid values include ChefAutomate and Puppet .
    engineAttributes List<Property Map>

    Optional engine attributes on a specified server.

    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.

    • CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

    Attributes accepted in a Puppet createServer request: - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.

    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    engineModel String
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    engineVersion String
    The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2 . For a Puppet server, valid values are 2019 or 2017 .
    keyPair String
    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.
    preferredBackupWindow String

    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. Valid values must be specified in one of the following formats:

    • HH:MM for daily backups
    • DDD:HH:MM for weekly backups

    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 String

    The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. 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 List<String>

    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 CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

    serverName String
    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.
    subnetIds List<String>

    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 .

    tags List<Property Map>
    A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

    • The key cannot be empty.
    • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @
    • Leading and trailing spaces are trimmed from both the key and value.
    • A maximum of 50 user-applied tags is allowed for any AWS OpsWorks CM server.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Server resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    Endpoint string
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    Endpoint string
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    endpoint String
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    endpoint string
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    endpoint str
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the server, such as arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi .
    endpoint String
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io .
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ServerEngineAttribute, ServerEngineAttributeArgs

    Name string

    The name of the engine attribute.

    Attribute name for Chef Automate servers:

    • CHEF_AUTOMATE_ADMIN_PASSWORD

    Attribute names for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD
    • PUPPET_R10K_REMOTE
    • PUPPET_R10K_PRIVATE_KEY
    Value string

    The value of the engine attribute.

    Attribute value for Chef Automate servers:

    • CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following OpenSSL command on Linux-based computers.

    openssl genrsa -out *pivotal_key_file_name* .pem 2048

    On Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see PuTTYgen - Key Generator for PuTTY on Windows on SSH.com.

    Attribute values for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters.
    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    Name string

    The name of the engine attribute.

    Attribute name for Chef Automate servers:

    • CHEF_AUTOMATE_ADMIN_PASSWORD

    Attribute names for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD
    • PUPPET_R10K_REMOTE
    • PUPPET_R10K_PRIVATE_KEY
    Value string

    The value of the engine attribute.

    Attribute value for Chef Automate servers:

    • CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following OpenSSL command on Linux-based computers.

    openssl genrsa -out *pivotal_key_file_name* .pem 2048

    On Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see PuTTYgen - Key Generator for PuTTY on Windows on SSH.com.

    Attribute values for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters.
    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    name String

    The name of the engine attribute.

    Attribute name for Chef Automate servers:

    • CHEF_AUTOMATE_ADMIN_PASSWORD

    Attribute names for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD
    • PUPPET_R10K_REMOTE
    • PUPPET_R10K_PRIVATE_KEY
    value String

    The value of the engine attribute.

    Attribute value for Chef Automate servers:

    • CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following OpenSSL command on Linux-based computers.

    openssl genrsa -out *pivotal_key_file_name* .pem 2048

    On Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see PuTTYgen - Key Generator for PuTTY on Windows on SSH.com.

    Attribute values for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters.
    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    name string

    The name of the engine attribute.

    Attribute name for Chef Automate servers:

    • CHEF_AUTOMATE_ADMIN_PASSWORD

    Attribute names for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD
    • PUPPET_R10K_REMOTE
    • PUPPET_R10K_PRIVATE_KEY
    value string

    The value of the engine attribute.

    Attribute value for Chef Automate servers:

    • CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following OpenSSL command on Linux-based computers.

    openssl genrsa -out *pivotal_key_file_name* .pem 2048

    On Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see PuTTYgen - Key Generator for PuTTY on Windows on SSH.com.

    Attribute values for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters.
    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    name str

    The name of the engine attribute.

    Attribute name for Chef Automate servers:

    • CHEF_AUTOMATE_ADMIN_PASSWORD

    Attribute names for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD
    • PUPPET_R10K_REMOTE
    • PUPPET_R10K_PRIVATE_KEY
    value str

    The value of the engine attribute.

    Attribute value for Chef Automate servers:

    • CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following OpenSSL command on Linux-based computers.

    openssl genrsa -out *pivotal_key_file_name* .pem 2048

    On Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see PuTTYgen - Key Generator for PuTTY on Windows on SSH.com.

    Attribute values for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters.
    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
    name String

    The name of the engine attribute.

    Attribute name for Chef Automate servers:

    • CHEF_AUTOMATE_ADMIN_PASSWORD

    Attribute names for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD
    • PUPPET_R10K_REMOTE
    • PUPPET_R10K_PRIVATE_KEY
    value String

    The value of the engine attribute.

    Attribute value for Chef Automate servers:

    • CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following OpenSSL command on Linux-based computers.

    openssl genrsa -out *pivotal_key_file_name* .pem 2048

    On Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see PuTTYgen - Key Generator for PuTTY on Windows on SSH.com.

    Attribute values for Puppet Enterprise servers:

    • PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters.
    • PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
    • PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native