opsworkscm

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 25, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupServerArgs added in v0.12.0

type LookupServerArgs struct {
	// 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.
	ServerName string `pulumi:"serverName"`
}

type LookupServerOutputArgs added in v0.12.0

type LookupServerOutputArgs struct {
	// 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.
	ServerName pulumi.StringInput `pulumi:"serverName"`
}

func (LookupServerOutputArgs) ElementType added in v0.12.0

func (LookupServerOutputArgs) ElementType() reflect.Type

type LookupServerResult added in v0.12.0

type LookupServerResult struct {
	// The Amazon Resource Name (ARN) of the server, such as `arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi` .
	Arn *string `pulumi:"arn"`
	// 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` .
	BackupRetentionCount *int `pulumi:"backupRetentionCount"`
	// Enable or disable scheduled backups. Valid values are `true` or `false` . The default value is `true` .
	DisableAutomatedBackup *bool `pulumi:"disableAutomatedBackup"`
	// A DNS name that can be used to access the engine. Example: `myserver-asdfghjkl.us-east-1.opsworks.io` .
	Endpoint *string `pulumi:"endpoint"`
	// 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.)
	PreferredBackupWindow *string `pulumi:"preferredBackupWindow"`
	// 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.)
	PreferredMaintenanceWindow *string `pulumi:"preferredMaintenanceWindow"`
}

func LookupServer added in v0.12.0

func LookupServer(ctx *pulumi.Context, args *LookupServerArgs, opts ...pulumi.InvokeOption) (*LookupServerResult, error)

Resource Type definition for AWS::OpsWorksCM::Server

type LookupServerResultOutput added in v0.12.0

type LookupServerResultOutput struct{ *pulumi.OutputState }

func LookupServerOutput added in v0.12.0

func LookupServerOutput(ctx *pulumi.Context, args LookupServerOutputArgs, opts ...pulumi.InvokeOption) LookupServerResultOutput

func (LookupServerResultOutput) Arn added in v0.12.0

The Amazon Resource Name (ARN) of the server, such as `arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi` .

func (LookupServerResultOutput) BackupRetentionCount added in v0.12.0

func (o LookupServerResultOutput) BackupRetentionCount() pulumi.IntPtrOutput

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

func (LookupServerResultOutput) DisableAutomatedBackup added in v0.12.0

func (o LookupServerResultOutput) DisableAutomatedBackup() pulumi.BoolPtrOutput

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

func (LookupServerResultOutput) ElementType added in v0.12.0

func (LookupServerResultOutput) ElementType() reflect.Type

func (LookupServerResultOutput) Endpoint added in v0.12.0

A DNS name that can be used to access the engine. Example: `myserver-asdfghjkl.us-east-1.opsworks.io` .

func (LookupServerResultOutput) PreferredBackupWindow added in v0.12.0

func (o LookupServerResultOutput) PreferredBackupWindow() pulumi.StringPtrOutput

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

func (LookupServerResultOutput) PreferredMaintenanceWindow added in v0.12.0

func (o LookupServerResultOutput) PreferredMaintenanceWindow() pulumi.StringPtrOutput

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

func (LookupServerResultOutput) ToLookupServerResultOutput added in v0.12.0

func (o LookupServerResultOutput) ToLookupServerResultOutput() LookupServerResultOutput

func (LookupServerResultOutput) ToLookupServerResultOutputWithContext added in v0.12.0

func (o LookupServerResultOutput) ToLookupServerResultOutputWithContext(ctx context.Context) LookupServerResultOutput

type Server

type Server struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the server, such as `arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi` .
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Associate a public IP address with a server that you are launching. Valid values are `true` or `false` . The default value is `true` .
	AssociatePublicIpAddress pulumi.BoolPtrOutput `pulumi:"associatePublicIpAddress"`
	// If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
	BackupId pulumi.StringPtrOutput `pulumi:"backupId"`
	// 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` .
	BackupRetentionCount pulumi.IntPtrOutput `pulumi:"backupRetentionCount"`
	// 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` .
	CustomCertificate pulumi.StringPtrOutput `pulumi:"customCertificate"`
	// 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` .
	CustomDomain pulumi.StringPtrOutput `pulumi:"customDomain"`
	// 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` .
	CustomPrivateKey pulumi.StringPtrOutput `pulumi:"customPrivateKey"`
	// Enable or disable scheduled backups. Valid values are `true` or `false` . The default value is `true` .
	DisableAutomatedBackup pulumi.BoolPtrOutput `pulumi:"disableAutomatedBackup"`
	// A DNS name that can be used to access the engine. Example: `myserver-asdfghjkl.us-east-1.opsworks.io` .
	Endpoint pulumi.StringOutput `pulumi:"endpoint"`
	// The configuration management engine to use. Valid values include `ChefAutomate` and `Puppet` .
	Engine pulumi.StringPtrOutput `pulumi:"engine"`
	// 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.
	EngineAttributes ServerEngineAttributeArrayOutput `pulumi:"engineAttributes"`
	// The engine model of the server. Valid values in this release include `Monolithic` for Puppet and `Single` for Chef.
	EngineModel pulumi.StringPtrOutput `pulumi:"engineModel"`
	// 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` .
	EngineVersion pulumi.StringPtrOutput `pulumi:"engineVersion"`
	// The ARN of the instance profile that your Amazon EC2 instances use.
	InstanceProfileArn pulumi.StringOutput `pulumi:"instanceProfileArn"`
	// The Amazon EC2 instance type to use. For example, `m5.large` .
	InstanceType pulumi.StringOutput `pulumi:"instanceType"`
	// 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.
	KeyPair pulumi.StringPtrOutput `pulumi:"keyPair"`
	// 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.)
	PreferredBackupWindow pulumi.StringPtrOutput `pulumi:"preferredBackupWindow"`
	// 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.)
	PreferredMaintenanceWindow pulumi.StringPtrOutput `pulumi:"preferredMaintenanceWindow"`
	// 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).
	SecurityGroupIds pulumi.StringArrayOutput `pulumi:"securityGroupIds"`
	// 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.
	ServerName pulumi.StringOutput `pulumi:"serverName"`
	// 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.
	ServiceRoleArn pulumi.StringOutput `pulumi:"serviceRoleArn"`
	// 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) .
	SubnetIds pulumi.StringArrayOutput `pulumi:"subnetIds"`
	// 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.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

Resource Type definition for AWS::OpsWorksCM::Server

## Example Usage ### Example

```go 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
	})
}

```

func GetServer

func GetServer(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServerState, opts ...pulumi.ResourceOption) (*Server, error)

GetServer gets an existing Server resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServer

func NewServer(ctx *pulumi.Context,
	name string, args *ServerArgs, opts ...pulumi.ResourceOption) (*Server, error)

NewServer registers a new resource with the given unique name, arguments, and options.

func (*Server) ElementType

func (*Server) ElementType() reflect.Type

func (*Server) ToServerOutput

func (i *Server) ToServerOutput() ServerOutput

func (*Server) ToServerOutputWithContext

func (i *Server) ToServerOutputWithContext(ctx context.Context) ServerOutput

type ServerArgs

type ServerArgs struct {
	// Associate a public IP address with a server that you are launching. Valid values are `true` or `false` . The default value is `true` .
	AssociatePublicIpAddress pulumi.BoolPtrInput
	// If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
	BackupId pulumi.StringPtrInput
	// 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` .
	BackupRetentionCount pulumi.IntPtrInput
	// 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` .
	CustomCertificate pulumi.StringPtrInput
	// 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` .
	CustomDomain pulumi.StringPtrInput
	// 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` .
	CustomPrivateKey pulumi.StringPtrInput
	// Enable or disable scheduled backups. Valid values are `true` or `false` . The default value is `true` .
	DisableAutomatedBackup pulumi.BoolPtrInput
	// The configuration management engine to use. Valid values include `ChefAutomate` and `Puppet` .
	Engine pulumi.StringPtrInput
	// 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.
	EngineAttributes ServerEngineAttributeArrayInput
	// The engine model of the server. Valid values in this release include `Monolithic` for Puppet and `Single` for Chef.
	EngineModel pulumi.StringPtrInput
	// 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` .
	EngineVersion pulumi.StringPtrInput
	// The ARN of the instance profile that your Amazon EC2 instances use.
	InstanceProfileArn pulumi.StringInput
	// The Amazon EC2 instance type to use. For example, `m5.large` .
	InstanceType pulumi.StringInput
	// 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.
	KeyPair pulumi.StringPtrInput
	// 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.)
	PreferredBackupWindow pulumi.StringPtrInput
	// 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.)
	PreferredMaintenanceWindow pulumi.StringPtrInput
	// 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).
	SecurityGroupIds pulumi.StringArrayInput
	// 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.
	ServerName pulumi.StringPtrInput
	// 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.
	ServiceRoleArn pulumi.StringInput
	// 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) .
	SubnetIds pulumi.StringArrayInput
	// 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.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a Server resource.

func (ServerArgs) ElementType

func (ServerArgs) ElementType() reflect.Type

type ServerEngineAttribute

type ServerEngineAttribute struct {
	// 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`
	Name *string `pulumi:"name"`
	// 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](https://docs.aws.amazon.com/https://www.openssl.org/) 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](https://docs.aws.amazon.com/https://www.ssh.com/ssh/putty/windows/puttygen) 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.
	Value *string `pulumi:"value"`
}

type ServerEngineAttributeArgs

type ServerEngineAttributeArgs struct {
	// 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`
	Name pulumi.StringPtrInput `pulumi:"name"`
	// 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](https://docs.aws.amazon.com/https://www.openssl.org/) 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](https://docs.aws.amazon.com/https://www.ssh.com/ssh/putty/windows/puttygen) 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.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (ServerEngineAttributeArgs) ElementType

func (ServerEngineAttributeArgs) ElementType() reflect.Type

func (ServerEngineAttributeArgs) ToServerEngineAttributeOutput

func (i ServerEngineAttributeArgs) ToServerEngineAttributeOutput() ServerEngineAttributeOutput

func (ServerEngineAttributeArgs) ToServerEngineAttributeOutputWithContext

func (i ServerEngineAttributeArgs) ToServerEngineAttributeOutputWithContext(ctx context.Context) ServerEngineAttributeOutput

type ServerEngineAttributeArray

type ServerEngineAttributeArray []ServerEngineAttributeInput

func (ServerEngineAttributeArray) ElementType

func (ServerEngineAttributeArray) ElementType() reflect.Type

func (ServerEngineAttributeArray) ToServerEngineAttributeArrayOutput

func (i ServerEngineAttributeArray) ToServerEngineAttributeArrayOutput() ServerEngineAttributeArrayOutput

func (ServerEngineAttributeArray) ToServerEngineAttributeArrayOutputWithContext

func (i ServerEngineAttributeArray) ToServerEngineAttributeArrayOutputWithContext(ctx context.Context) ServerEngineAttributeArrayOutput

type ServerEngineAttributeArrayInput

type ServerEngineAttributeArrayInput interface {
	pulumi.Input

	ToServerEngineAttributeArrayOutput() ServerEngineAttributeArrayOutput
	ToServerEngineAttributeArrayOutputWithContext(context.Context) ServerEngineAttributeArrayOutput
}

ServerEngineAttributeArrayInput is an input type that accepts ServerEngineAttributeArray and ServerEngineAttributeArrayOutput values. You can construct a concrete instance of `ServerEngineAttributeArrayInput` via:

ServerEngineAttributeArray{ ServerEngineAttributeArgs{...} }

type ServerEngineAttributeArrayOutput

type ServerEngineAttributeArrayOutput struct{ *pulumi.OutputState }

func (ServerEngineAttributeArrayOutput) ElementType

func (ServerEngineAttributeArrayOutput) Index

func (ServerEngineAttributeArrayOutput) ToServerEngineAttributeArrayOutput

func (o ServerEngineAttributeArrayOutput) ToServerEngineAttributeArrayOutput() ServerEngineAttributeArrayOutput

func (ServerEngineAttributeArrayOutput) ToServerEngineAttributeArrayOutputWithContext

func (o ServerEngineAttributeArrayOutput) ToServerEngineAttributeArrayOutputWithContext(ctx context.Context) ServerEngineAttributeArrayOutput

type ServerEngineAttributeInput

type ServerEngineAttributeInput interface {
	pulumi.Input

	ToServerEngineAttributeOutput() ServerEngineAttributeOutput
	ToServerEngineAttributeOutputWithContext(context.Context) ServerEngineAttributeOutput
}

ServerEngineAttributeInput is an input type that accepts ServerEngineAttributeArgs and ServerEngineAttributeOutput values. You can construct a concrete instance of `ServerEngineAttributeInput` via:

ServerEngineAttributeArgs{...}

type ServerEngineAttributeOutput

type ServerEngineAttributeOutput struct{ *pulumi.OutputState }

func (ServerEngineAttributeOutput) ElementType

func (ServerEngineAttributeOutput) Name

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`

func (ServerEngineAttributeOutput) ToServerEngineAttributeOutput

func (o ServerEngineAttributeOutput) ToServerEngineAttributeOutput() ServerEngineAttributeOutput

func (ServerEngineAttributeOutput) ToServerEngineAttributeOutputWithContext

func (o ServerEngineAttributeOutput) ToServerEngineAttributeOutputWithContext(ctx context.Context) ServerEngineAttributeOutput

func (ServerEngineAttributeOutput) Value

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](https://docs.aws.amazon.com/https://www.openssl.org/) 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](https://docs.aws.amazon.com/https://www.ssh.com/ssh/putty/windows/puttygen) 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.

type ServerInput

type ServerInput interface {
	pulumi.Input

	ToServerOutput() ServerOutput
	ToServerOutputWithContext(ctx context.Context) ServerOutput
}

type ServerOutput

type ServerOutput struct{ *pulumi.OutputState }

func (ServerOutput) Arn added in v0.17.0

The Amazon Resource Name (ARN) of the server, such as `arn:aws:OpsWorksCM:us-east-1:123456789012:server/server-a1bzhi` .

func (ServerOutput) AssociatePublicIpAddress added in v0.17.0

func (o ServerOutput) AssociatePublicIpAddress() pulumi.BoolPtrOutput

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

func (ServerOutput) BackupId added in v0.17.0

func (o ServerOutput) BackupId() pulumi.StringPtrOutput

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

func (ServerOutput) BackupRetentionCount added in v0.17.0

func (o ServerOutput) BackupRetentionCount() pulumi.IntPtrOutput

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

func (ServerOutput) CustomCertificate added in v0.17.0

func (o ServerOutput) CustomCertificate() pulumi.StringPtrOutput

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

func (ServerOutput) CustomDomain added in v0.17.0

func (o ServerOutput) CustomDomain() pulumi.StringPtrOutput

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

func (ServerOutput) CustomPrivateKey added in v0.17.0

func (o ServerOutput) CustomPrivateKey() pulumi.StringPtrOutput

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

func (ServerOutput) DisableAutomatedBackup added in v0.17.0

func (o ServerOutput) DisableAutomatedBackup() pulumi.BoolPtrOutput

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

func (ServerOutput) ElementType

func (ServerOutput) ElementType() reflect.Type

func (ServerOutput) Endpoint added in v0.17.0

func (o ServerOutput) Endpoint() pulumi.StringOutput

A DNS name that can be used to access the engine. Example: `myserver-asdfghjkl.us-east-1.opsworks.io` .

func (ServerOutput) Engine added in v0.17.0

func (o ServerOutput) Engine() pulumi.StringPtrOutput

The configuration management engine to use. Valid values include `ChefAutomate` and `Puppet` .

func (ServerOutput) EngineAttributes added in v0.17.0

func (o ServerOutput) EngineAttributes() ServerEngineAttributeArrayOutput

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.

func (ServerOutput) EngineModel added in v0.17.0

func (o ServerOutput) EngineModel() pulumi.StringPtrOutput

The engine model of the server. Valid values in this release include `Monolithic` for Puppet and `Single` for Chef.

func (ServerOutput) EngineVersion added in v0.17.0

func (o ServerOutput) EngineVersion() pulumi.StringPtrOutput

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

func (ServerOutput) InstanceProfileArn added in v0.17.0

func (o ServerOutput) InstanceProfileArn() pulumi.StringOutput

The ARN of the instance profile that your Amazon EC2 instances use.

func (ServerOutput) InstanceType added in v0.17.0

func (o ServerOutput) InstanceType() pulumi.StringOutput

The Amazon EC2 instance type to use. For example, `m5.large` .

func (ServerOutput) KeyPair added in v0.17.0

func (o ServerOutput) KeyPair() pulumi.StringPtrOutput

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.

func (ServerOutput) PreferredBackupWindow added in v0.17.0

func (o ServerOutput) PreferredBackupWindow() pulumi.StringPtrOutput

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

func (ServerOutput) PreferredMaintenanceWindow added in v0.17.0

func (o ServerOutput) PreferredMaintenanceWindow() pulumi.StringPtrOutput

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

func (ServerOutput) SecurityGroupIds added in v0.17.0

func (o ServerOutput) SecurityGroupIds() pulumi.StringArrayOutput

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

func (ServerOutput) ServerName added in v0.17.0

func (o ServerOutput) ServerName() pulumi.StringOutput

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.

func (ServerOutput) ServiceRoleArn added in v0.17.0

func (o ServerOutput) ServiceRoleArn() pulumi.StringOutput

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.

func (ServerOutput) SubnetIds added in v0.17.0

func (o ServerOutput) SubnetIds() pulumi.StringArrayOutput

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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) .

func (ServerOutput) Tags added in v0.17.0

func (o ServerOutput) Tags() aws.TagArrayOutput

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.

func (ServerOutput) ToServerOutput

func (o ServerOutput) ToServerOutput() ServerOutput

func (ServerOutput) ToServerOutputWithContext

func (o ServerOutput) ToServerOutputWithContext(ctx context.Context) ServerOutput

type ServerState

type ServerState struct {
}

func (ServerState) ElementType

func (ServerState) ElementType() reflect.Type

type ServerTag

type ServerTag struct {
	// A tag key, such as `Stage` or `Name` . A tag 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: `+ - = . _ : /`
	Key string `pulumi:"key"`
	// An optional tag value, such as `Production` or `test-owcm-server` . The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : /`
	Value string `pulumi:"value"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL