Interface Server.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Server.Builder,
,Server> SdkBuilder<Server.Builder,
,Server> SdkPojo
- Enclosing class:
Server
-
Method Summary
Modifier and TypeMethodDescriptionassociatePublicIpAddress
(Boolean associatePublicIpAddress) Associate a public IP address with a server that you are launching.backupRetentionCount
(Integer backupRetentionCount) The number of automated backups to keep.cloudFormationStackArn
(String cloudFormationStackArn) The ARN of the CloudFormation stack that was used to create the server.Time stamp of server creation.customDomain
(String customDomain) An optional public endpoint of a server, such ashttps://aws.my-company.com
.disableAutomatedBackup
(Boolean disableAutomatedBackup) Disables automated backups.A DNS name that can be used to access the engine.The engine type of the server.engineAttributes
(Collection<EngineAttribute> engineAttributes) The response of a createServer() request returns the master credential to access the server in EngineAttributes.engineAttributes
(Consumer<EngineAttribute.Builder>... engineAttributes) The response of a createServer() request returns the master credential to access the server in EngineAttributes.engineAttributes
(EngineAttribute... engineAttributes) The response of a createServer() request returns the master credential to access the server in EngineAttributes.engineModel
(String engineModel) The engine model of the server.engineVersion
(String engineVersion) The engine version of the server.instanceProfileArn
(String instanceProfileArn) The instance profile ARN of the server.instanceType
(String instanceType) The instance type for the server, as specified in the CloudFormation stack.The key pair associated with the server.maintenanceStatus
(String maintenanceStatus) The status of the most recent server maintenance run.maintenanceStatus
(MaintenanceStatus maintenanceStatus) The status of the most recent server maintenance run.preferredBackupWindow
(String preferredBackupWindow) The preferred backup period specified for the server.preferredMaintenanceWindow
(String preferredMaintenanceWindow) The preferred maintenance period specified for the server.securityGroupIds
(String... securityGroupIds) The security group IDs for the server, as specified in the CloudFormation stack.securityGroupIds
(Collection<String> securityGroupIds) The security group IDs for the server, as specified in the CloudFormation stack.The ARN of the server.serverName
(String serverName) The name of the server.serviceRoleArn
(String serviceRoleArn) The service role ARN used to create the server.The server's status.status
(ServerStatus status) The server's status.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).The subnet IDs specified in a CreateServer request.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
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
Time stamp of server creation. Example
2016-07-29T13:38:47.520Z
- Parameters:
createdAt
- Time stamp of server creation. Example2016-07-29T13:38:47.520Z
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
customDomain
An optional public endpoint of a server, such as
https://aws.my-company.com
. You cannot access the server by using theEndpoint
value if the server has aCustomDomain
specified.- Parameters:
customDomain
- An optional public endpoint of a server, such ashttps://aws.my-company.com
. You cannot access the server by using theEndpoint
value if the server has aCustomDomain
specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io
. You cannot access the server by using theEndpoint
value if the server has aCustomDomain
specified.- Parameters:
endpoint
- A DNS name that can be used to access the engine. Example:myserver-asdfghjkl.us-east-1.opsworks.io
. You cannot access the server by using theEndpoint
value if the server has aCustomDomain
specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engine
The engine type of the server. Valid values in this release include
ChefAutomate
andPuppet
.- Parameters:
engine
- The engine type of the server. Valid values in this release includeChefAutomate
andPuppet
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineModel
The engine model of the server. Valid values in this release include
Monolithic
for Puppet andSingle
for Chef.- Parameters:
engineModel
- The engine model of the server. Valid values in this release includeMonolithic
for Puppet andSingle
for Chef.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 CM; they are returned only as part of the result of createServer().
Attributes returned in a createServer response for Chef
-
CHEF_AUTOMATE_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.
Attributes returned in a createServer response for Puppet
-
PUPPET_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. -
PUPPET_ADMIN_PASSWORD
: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
- 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 CM; they are returned only as part of the result of createServer().Attributes returned in a createServer response for Chef
-
CHEF_AUTOMATE_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.
Attributes returned in a createServer response for Puppet
-
PUPPET_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. -
PUPPET_ADMIN_PASSWORD
: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 CM; they are returned only as part of the result of createServer().
Attributes returned in a createServer response for Chef
-
CHEF_AUTOMATE_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.
Attributes returned in a createServer response for Puppet
-
PUPPET_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. -
PUPPET_ADMIN_PASSWORD
: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
- 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 CM; they are returned only as part of the result of createServer().Attributes returned in a createServer response for Chef
-
CHEF_AUTOMATE_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.
Attributes returned in a createServer response for Puppet
-
PUPPET_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. -
PUPPET_ADMIN_PASSWORD
: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 CM; they are returned only as part of the result of createServer().
Attributes returned in a createServer response for Chef
-
CHEF_AUTOMATE_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.
Attributes returned in a createServer response for Puppet
-
PUPPET_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. -
PUPPET_ADMIN_PASSWORD
: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
EngineAttribute.Builder
avoiding the need to create one manually viaEngineAttribute.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toengineAttributes(List<EngineAttribute>)
.- Parameters:
engineAttributes
- a consumer that will call methods onEngineAttribute.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
engineVersion
The engine version of the server. For a Chef server, the valid value for EngineVersion is currently
2
. For a Puppet server, specify either2019
or2017
.- Parameters:
engineVersion
- The engine version of the server. For a Chef server, the valid value for EngineVersion is currently2
. For a Puppet server, specify either2019
or2017
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
The status of the most recent server maintenance run. Shows
SUCCESS
orFAILED
.- Parameters:
maintenanceStatus
- The status of the most recent server maintenance run. ShowsSUCCESS
orFAILED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maintenanceStatus
The status of the most recent server maintenance run. Shows
SUCCESS
orFAILED
.- Parameters:
maintenanceStatus
- The status of the most recent server maintenance run. ShowsSUCCESS
orFAILED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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.
-
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
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:
-
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:
-
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
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
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.
-
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.
-