We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 23, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 23, 2026 by Pulumi
Resource Type definition for AWS::OpsWorksCM::Server
Using getServer
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>def get_server(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput> Note: This function is named LookupServer in the Go SDK.
public static class GetServer
{
public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:opsworkscm:getServer
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- The ID of the server.
- Id string
- The ID of the server.
- id String
- The ID of the server.
- id string
- The ID of the server.
- id str
- The ID of the server.
- id String
- The ID of the server.
getServer Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the server, such as
arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi. - Backup
Retention intCount - 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. - Disable
Automated boolBackup - Enable or disable scheduled backups. Valid values are
trueorfalse. The default value istrue. - Endpoint string
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. - Engine
Attributes List<Pulumi.Aws Native. Ops Works Cm. Outputs. Server Engine Attribute> 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 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.
- Id string
- The ID of the server.
- Preferred
Backup stringWindow 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:MMfor daily backupsDDD:HH:MMfor weekly backups
MMmust be specified as00. 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 stringWindow 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.MMmust be specified as00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinitionfor more information.Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)-
List<Pulumi.
Aws Native. Outputs. 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.
- Arn string
- The Amazon Resource Name (ARN) of the server, such as
arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi. - Backup
Retention intCount - 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. - Disable
Automated boolBackup - Enable or disable scheduled backups. Valid values are
trueorfalse. The default value istrue. - Endpoint string
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. - Engine
Attributes []ServerEngine Attribute 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 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.
- Id string
- The ID of the server.
- Preferred
Backup stringWindow 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:MMfor daily backupsDDD:HH:MMfor weekly backups
MMmust be specified as00. 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 stringWindow 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.MMmust be specified as00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinitionfor more information.Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)- 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.
- arn String
- The Amazon Resource Name (ARN) of the server, such as
arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi. - backup
Retention IntegerCount - 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. - disable
Automated BooleanBackup - Enable or disable scheduled backups. Valid values are
trueorfalse. The default value istrue. - endpoint String
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. - engine
Attributes List<ServerEngine Attribute> 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 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.
- id String
- The ID of the server.
- preferred
Backup StringWindow 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:MMfor daily backupsDDD:HH:MMfor weekly backups
MMmust be specified as00. 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 StringWindow 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.MMmust be specified as00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinitionfor more information.Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)- 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.
- arn string
- The Amazon Resource Name (ARN) of the server, such as
arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi. - backup
Retention numberCount - 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. - disable
Automated booleanBackup - Enable or disable scheduled backups. Valid values are
trueorfalse. The default value istrue. - endpoint string
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. - engine
Attributes ServerEngine Attribute[] 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 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.
- id string
- The ID of the server.
- preferred
Backup stringWindow 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:MMfor daily backupsDDD:HH:MMfor weekly backups
MMmust be specified as00. 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 stringWindow 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.MMmust be specified as00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinitionfor more information.Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)- 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.
- arn str
- The Amazon Resource Name (ARN) of the server, such as
arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi. - backup_
retention_ intcount - 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. - disable_
automated_ boolbackup - Enable or disable scheduled backups. Valid values are
trueorfalse. The default value istrue. - endpoint str
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. - engine_
attributes Sequence[ServerEngine Attribute] 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 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.
- id str
- The ID of the server.
- preferred_
backup_ strwindow 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:MMfor daily backupsDDD:HH:MMfor weekly backups
MMmust be specified as00. 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_ strwindow 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.MMmust be specified as00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinitionfor more information.Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)- Sequence[root_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.
- arn String
- The Amazon Resource Name (ARN) of the server, such as
arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi. - backup
Retention NumberCount - 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. - disable
Automated BooleanBackup - Enable or disable scheduled backups. Valid values are
trueorfalse. The default value istrue. - endpoint String
- A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. - engine
Attributes 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 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.
- id String
- The ID of the server.
- preferred
Backup StringWindow 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:MMfor daily backupsDDD:HH:MMfor weekly backups
MMmust be specified as00. 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 StringWindow 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.MMmust be specified as00. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinitionfor more information.Example:
Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)- 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.
Supporting Types
ServerEngineAttribute
- 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_PASSWORDPUPPET_R10K_REMOTEPUPPET_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 2048On 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, addPUPPET_R10K_PRIVATE_KEYto 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_PASSWORDPUPPET_R10K_REMOTEPUPPET_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 2048On 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, addPUPPET_R10K_PRIVATE_KEYto 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_PASSWORDPUPPET_R10K_REMOTEPUPPET_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 2048On 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, addPUPPET_R10K_PRIVATE_KEYto 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_PASSWORDPUPPET_R10K_REMOTEPUPPET_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 2048On 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, addPUPPET_R10K_PRIVATE_KEYto 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_PASSWORDPUPPET_R10K_REMOTEPUPPET_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 2048On 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, addPUPPET_R10K_PRIVATE_KEYto 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_PASSWORDPUPPET_R10K_REMOTEPUPPET_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 2048On 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, addPUPPET_R10K_PRIVATE_KEYto specify a PEM-encoded private SSH key.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 23, 2026 by Pulumi
