Package software.amazon.awscdk.cfnpropertymixins.services.opsworkscm

Class CfnServerPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.opsworkscm.CfnServerPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServerPropsMixin>

Enclosing class:

CfnServerPropsMixin

@Stability(Stable)
public static final class CfnServerPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnServerPropsMixin>

A fluent builder for CfnServerPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnServerPropsMixin.Builder	associatePublicIpAddress(Boolean associatePublicIpAddress)	Associate a public IP address with a server that you are launching.
CfnServerPropsMixin.Builder	associatePublicIpAddress(IResolvable associatePublicIpAddress)	Associate a public IP address with a server that you are launching.
CfnServerPropsMixin.Builder	backupId(String backupId)	If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
CfnServerPropsMixin.Builder	backupRetentionCount(Number backupRetentionCount)	The number of automated backups that you want to keep.
CfnServerPropsMixin	build()
static CfnServerPropsMixin.Builder	create()
static CfnServerPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnServerPropsMixin.Builder	customCertificate(String customCertificate)	Supported on servers running Chef Automate 2.0 only.
CfnServerPropsMixin.Builder	customDomain(String customDomain)	Supported on servers running Chef Automate 2.0 only.
CfnServerPropsMixin.Builder	customPrivateKey(String customPrivateKey)	Supported on servers running Chef Automate 2.0 only.
CfnServerPropsMixin.Builder	disableAutomatedBackup(Boolean disableAutomatedBackup)	Enable or disable scheduled backups.
CfnServerPropsMixin.Builder	disableAutomatedBackup(IResolvable disableAutomatedBackup)	Enable or disable scheduled backups.
CfnServerPropsMixin.Builder	engine(String engine)	The configuration management engine to use.
CfnServerPropsMixin.Builder	engineAttributes(List<? extends Object> engineAttributes)	Optional engine attributes on a specified server.
CfnServerPropsMixin.Builder	engineAttributes(IResolvable engineAttributes)	Optional engine attributes on a specified server.
CfnServerPropsMixin.Builder	engineModel(String engineModel)	The engine model of the server.
CfnServerPropsMixin.Builder	engineVersion(String engineVersion)	The major release version of the engine that you want to use.
CfnServerPropsMixin.Builder	instanceProfileArn(String instanceProfileArn)	The ARN of the instance profile that your Amazon EC2 instances use.
CfnServerPropsMixin.Builder	instanceType(String instanceType)	The Amazon EC2 instance type to use.
CfnServerPropsMixin.Builder	keyPair(String keyPair)	The Amazon EC2 key pair to set for the instance.
CfnServerPropsMixin.Builder	preferredBackupWindow(String preferredBackupWindow)	The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.
CfnServerPropsMixin.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
CfnServerPropsMixin.Builder	securityGroupIds(List<String> securityGroupIds)	A list of security group IDs to attach to the Amazon EC2 instance.
CfnServerPropsMixin.Builder	serviceRoleArn(String serviceRoleArn)	The service role that the AWS OpsWorks CM service backend uses to work with your account.
CfnServerPropsMixin.Builder	subnetIds(List<String> subnetIds)	The IDs of subnets in which to launch the server EC2 instance.
CfnServerPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnServerPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnServerPropsMixin.Builder.

create

@Stability(Stable)
public static CfnServerPropsMixin.Builder create()

Returns:

a new instance of CfnServerPropsMixin.Builder.

associatePublicIpAddress

@Stability(Stable)
public CfnServerPropsMixin.Builder associatePublicIpAddress(Boolean associatePublicIpAddress)

Associate a public IP address with a server that you are launching.

Valid values are true or false . The default value is true .

Parameters:

associatePublicIpAddress - Associate a public IP address with a server that you are launching. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-associatepublicipaddress

associatePublicIpAddress

@Stability(Stable)
public CfnServerPropsMixin.Builder associatePublicIpAddress(IResolvable associatePublicIpAddress)

Associate a public IP address with a server that you are launching.

Valid values are true or false . The default value is true .

Parameters:

associatePublicIpAddress - Associate a public IP address with a server that you are launching. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-associatepublicipaddress

backupId

@Stability(Stable)
public CfnServerPropsMixin.Builder backupId(String backupId)

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

Parameters:

backupId - If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupid

backupRetentionCount

@Stability(Stable)
public CfnServerPropsMixin.Builder backupRetentionCount(Number backupRetentionCount)

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 .

Parameters:

backupRetentionCount - The number of automated backups that you want to keep. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupretentioncount

customCertificate

@Stability(Stable)
public CfnServerPropsMixin.Builder customCertificate(String customCertificate)

Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey . The following are requirements for the CustomCertificate value:.

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

Parameters:

customCertificate - Supported on servers running Chef Automate 2.0 only. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey . The following are requirements for the CustomCertificate value:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customcertificate

customDomain

@Stability(Stable)
public CfnServerPropsMixin.Builder customDomain(String customDomain)

Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as https://aws.my-company.com . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey .

Parameters:

customDomain - Supported on servers running Chef Automate 2.0 only. An optional public endpoint of a server, such as https://aws.my-company.com . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customdomain

customPrivateKey

@Stability(Stable)
public CfnServerPropsMixin.Builder customPrivateKey(String customPrivateKey)

Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate .

Parameters:

customPrivateKey - Supported on servers running Chef Automate 2.0 only. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-customprivatekey

disableAutomatedBackup

@Stability(Stable)
public CfnServerPropsMixin.Builder disableAutomatedBackup(Boolean disableAutomatedBackup)

Enable or disable scheduled backups.

Valid values are true or false . The default value is true .

Parameters:

disableAutomatedBackup - Enable or disable scheduled backups. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-disableautomatedbackup

disableAutomatedBackup

@Stability(Stable)
public CfnServerPropsMixin.Builder disableAutomatedBackup(IResolvable disableAutomatedBackup)

Enable or disable scheduled backups.

Valid values are true or false . The default value is true .

Parameters:

disableAutomatedBackup - Enable or disable scheduled backups. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-disableautomatedbackup

engine

@Stability(Stable)
public CfnServerPropsMixin.Builder engine(String engine)

The configuration management engine to use.

Valid values include ChefAutomate and Puppet .

Parameters:

engine - The configuration management engine to use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engine

engineAttributes

@Stability(Stable)
public CfnServerPropsMixin.Builder engineAttributes(IResolvable engineAttributes)

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.

Parameters:

engineAttributes - Optional engine attributes on a specified server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineattributes

engineAttributes

@Stability(Stable)
public CfnServerPropsMixin.Builder engineAttributes(List<? extends Object> engineAttributes)

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.

Parameters:

engineAttributes - Optional engine attributes on a specified server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineattributes

engineModel

@Stability(Stable)
public CfnServerPropsMixin.Builder engineModel(String engineModel)

The engine model of the server.

Valid values in this release include Monolithic for Puppet and Single for Chef.

Parameters:

engineModel - The engine model of the server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-enginemodel

engineVersion

@Stability(Stable)
public CfnServerPropsMixin.Builder engineVersion(String engineVersion)

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 .

Parameters:

engineVersion - The major release version of the engine that you want to use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-engineversion

instanceProfileArn

@Stability(Stable)
public CfnServerPropsMixin.Builder instanceProfileArn(String instanceProfileArn)

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

Parameters:

instanceProfileArn - The ARN of the instance profile that your Amazon EC2 instances use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-instanceprofilearn

instanceType

@Stability(Stable)
public CfnServerPropsMixin.Builder instanceType(String instanceType)

The Amazon EC2 instance type to use.

For example, m5.large .

Parameters:

instanceType - The Amazon EC2 instance type to use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-instancetype

keyPair

@Stability(Stable)
public CfnServerPropsMixin.Builder keyPair(String keyPair)

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.

Parameters:

keyPair - The Amazon EC2 key pair to set for the instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-keypair

preferredBackupWindow

@Stability(Stable)
public CfnServerPropsMixin.Builder preferredBackupWindow(String preferredBackupWindow)

The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled.

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

Parameters:

preferredBackupWindow - The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-preferredbackupwindow

preferredMaintenanceWindow

@Stability(Stable)
public CfnServerPropsMixin.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

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

Parameters:

preferredMaintenanceWindow - The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-preferredmaintenancewindow

securityGroupIds

@Stability(Stable)
public CfnServerPropsMixin.Builder securityGroupIds(List<String> securityGroupIds)

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

Parameters:

securityGroupIds - A list of security group IDs to attach to the Amazon EC2 instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-securitygroupids

serviceRoleArn

@Stability(Stable)
public CfnServerPropsMixin.Builder serviceRoleArn(String serviceRoleArn)

The service role that the AWS OpsWorks CM service backend uses to work with your account.

Parameters:

serviceRoleArn - The service role that the AWS OpsWorks CM service backend uses to work with your account. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-servicerolearn

subnetIds

@Stability(Stable)
public CfnServerPropsMixin.Builder subnetIds(List<String> subnetIds)

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 .

Parameters:

subnetIds - The IDs of subnets in which to launch the server EC2 instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-subnetids

tags

@Stability(Stable)
public CfnServerPropsMixin.Builder tags(List<? extends CfnTag> tags)

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

• 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: `+ - = . _ : /

Parameters:

tags - A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-tags

build

@Stability(Stable)
public CfnServerPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnServerPropsMixin>

Returns:

a newly built instance of CfnServerPropsMixin.