Package software.amazon.awssdk.services.opsworkscm.model

Interface Server.Builder

All Superinterfaces:

CopyableBuilder<Server.Builder,Server>, SdkBuilder<Server.Builder,Server>

Enclosing class:

Server

public static interface Server.Builder
extends CopyableBuilder<Server.Builder,Server>

Method Summary

Modifier and Type	Method	Description
Server.Builder	associatePublicIpAddress(Boolean associatePublicIpAddress)	Associate a public IP address with a server that you are launching.
Server.Builder	backupRetentionCount(Integer backupRetentionCount)	The number of automated backups to keep.
Server.Builder	cloudFormationStackArn(String cloudFormationStackArn)	The ARN of the CloudFormation stack that was used to create the server.
Server.Builder	createdAt(Date createdAt)	Time stamp of server creation.
Server.Builder	disableAutomatedBackup(Boolean disableAutomatedBackup)	Disables automated backups.
Server.Builder	endpoint(String endpoint)	A DNS name that can be used to access the engine.
Server.Builder	engine(String engine)	The engine type of the server.
Server.Builder	engineAttributes(Collection<EngineAttribute> engineAttributes)	The response of a createServer() request returns the master credential to access the server in EngineAttributes.
Server.Builder	engineAttributes(EngineAttribute... engineAttributes)	The response of a createServer() request returns the master credential to access the server in EngineAttributes.
Server.Builder	engineModel(String engineModel)	The engine model of the server.
Server.Builder	engineVersion(String engineVersion)	The engine version of the server.
Server.Builder	instanceProfileArn(String instanceProfileArn)	The instance profile ARN of the server.
Server.Builder	instanceType(String instanceType)	The instance type for the server, as specified in the CloudFormation stack.
Server.Builder	keyPair(String keyPair)	The key pair associated with the server.
Server.Builder	maintenanceStatus(String maintenanceStatus)	The status of the most recent server maintenance run.
Server.Builder	maintenanceStatus(MaintenanceStatus maintenanceStatus)	The status of the most recent server maintenance run.
Server.Builder	preferredBackupWindow(String preferredBackupWindow)	The preferred backup period specified for the server.
Server.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	The preferred maintenance period specified for the server.
Server.Builder	securityGroupIds(String... securityGroupIds)	The security group IDs for the server, as specified in the CloudFormation stack.
Server.Builder	securityGroupIds(Collection<String> securityGroupIds)	The security group IDs for the server, as specified in the CloudFormation stack.
Server.Builder	serverArn(String serverArn)	The ARN of the server.
Server.Builder	serverName(String serverName)	The name of the server.
Server.Builder	serviceRoleArn(String serviceRoleArn)	The service role ARN used to create the server.
Server.Builder	status(String status)	The server's status.
Server.Builder	status(ServerStatus status)	The server's status.
Server.Builder	statusReason(String statusReason)	Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
Server.Builder	subnetIds(String... subnetIds)	The subnet IDs specified in a CreateServer request.
Server.Builder	subnetIds(Collection<String> subnetIds)	The subnet IDs specified in a CreateServer request.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

associatePublicIpAddress

Server.Builder associatePublicIpAddress(Boolean associatePublicIpAddress)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

backupRetentionCount

Server.Builder backupRetentionCount(Integer backupRetentionCount)

The number of automated backups to keep.

Parameters:

backupRetentionCount - The number of automated backups to keep.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverName

Server.Builder serverName(String serverName)

The name of the server.

Parameters:

serverName - The name of the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdAt

Server.Builder createdAt(Date createdAt)

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

Parameters:

createdAt - Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudFormationStackArn

Server.Builder cloudFormationStackArn(String cloudFormationStackArn)

The ARN of the CloudFormation stack that was used to create the server.

Parameters:

cloudFormationStackArn - The ARN of the CloudFormation stack that was used to create the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

disableAutomatedBackup

Server.Builder disableAutomatedBackup(Boolean disableAutomatedBackup)

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

Parameters:

disableAutomatedBackup - Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpoint

Server.Builder endpoint(String endpoint)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

engine

Server.Builder engine(String engine)

The engine type of the server. The valid value in this release is Chef.

Parameters:

engine - The engine type of the server. The valid value in this release is Chef.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineModel

Server.Builder engineModel(String engineModel)

The engine model of the server. The valid value in this release is Single.

Parameters:

engineModel - The engine model of the server. The valid value in this release is Single.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineAttributes

Server.Builder engineAttributes(Collection<EngineAttribute> engineAttributes)

The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().

Attributes returned in a createServer response:

• CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

• CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

Parameters:

engineAttributes - The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().

Attributes returned in a createServer response:

• CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

• CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineAttributes

Server.Builder engineAttributes(EngineAttribute... engineAttributes)

The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().

Attributes returned in a createServer response:

• CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

• CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

NOTE: This method appends the values to the existing list (if any). Use #setEngineAttributes(java.util.Collection) or #withEngineAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

engineAttributes - The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().

Attributes returned in a createServer response:

• CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

• CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineVersion

Server.Builder engineVersion(String engineVersion)

The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

Parameters:

engineVersion - The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceProfileArn

Server.Builder instanceProfileArn(String instanceProfileArn)

The instance profile ARN of the server.

Parameters:

instanceProfileArn - The instance profile ARN of the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceType

Server.Builder instanceType(String instanceType)

The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

Parameters:

instanceType - The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

Returns:

Returns a reference to this object so that method calls can be chained together.

keyPair

Server.Builder keyPair(String keyPair)

The key pair associated with the server.

Parameters:

keyPair - The key pair associated with the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

maintenanceStatus

Server.Builder maintenanceStatus(String maintenanceStatus)

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

Parameters:

maintenanceStatus - The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MaintenanceStatus

maintenanceStatus

Server.Builder maintenanceStatus(MaintenanceStatus maintenanceStatus)

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

Parameters:

maintenanceStatus - The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MaintenanceStatus

preferredMaintenanceWindow

Server.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

The preferred maintenance period specified for the server.

Parameters:

preferredMaintenanceWindow - The preferred maintenance period specified for the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredBackupWindow

Server.Builder preferredBackupWindow(String preferredBackupWindow)

The preferred backup period specified for the server.

Parameters:

preferredBackupWindow - The preferred backup period specified for the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

Server.Builder securityGroupIds(Collection<String> securityGroupIds)

The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

Parameters:

securityGroupIds - The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

Server.Builder securityGroupIds(String... securityGroupIds)

The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

NOTE: This method appends the values to the existing list (if any). Use #setSecurityGroupIds(java.util.Collection) or #withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroupIds - The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

Returns:

Returns a reference to this object so that method calls can be chained together.

serviceRoleArn

Server.Builder serviceRoleArn(String serviceRoleArn)

The service role ARN used to create the server.

Parameters:

serviceRoleArn - The service role ARN used to create the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

Server.Builder status(String status)

The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

Parameters:

status - The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerStatus

status

Server.Builder status(ServerStatus status)

The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

Parameters:

status - The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerStatus

statusReason

Server.Builder statusReason(String statusReason)

Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

Parameters:

statusReason - Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

Returns:

Returns a reference to this object so that method calls can be chained together.

subnetIds

Server.Builder subnetIds(Collection<String> subnetIds)

The subnet IDs specified in a CreateServer request.

Parameters:

subnetIds - The subnet IDs specified in a CreateServer request.

Returns:

Returns a reference to this object so that method calls can be chained together.

subnetIds

Server.Builder subnetIds(String... subnetIds)

The subnet IDs specified in a CreateServer request.

NOTE: This method appends the values to the existing list (if any). Use #setSubnetIds(java.util.Collection) or #withSubnetIds(java.util.Collection) if you want to override the existing values.

Parameters:

subnetIds - The subnet IDs specified in a CreateServer request.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverArn

Server.Builder serverArn(String serverArn)

The ARN of the server.

Parameters:

serverArn - The ARN of the server.

Returns:

Returns a reference to this object so that method calls can be chained together.