Server (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opsworkscm.model.Server

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Server
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes a configuration management server.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Server()

Constructors
Constructor and Description
`Server()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Server`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAssociatePublicIpAddress()` Associate a public IP address with a server that you are launching.
`Integer`	`getBackupRetentionCount()` The number of automated backups to keep.
`String`	`getCloudFormationStackArn()` The ARN of the CloudFormation stack that was used to create the server.
`Date`	`getCreatedAt()` Time stamp of server creation.
`String`	`getCustomDomain()` An optional public endpoint of a server, such as `https://aws.my-company.com`.
`Boolean`	`getDisableAutomatedBackup()` Disables automated backups.
`String`	`getEndpoint()` A DNS name that can be used to access the engine.
`String`	`getEngine()` The engine type of the server.
`List<EngineAttribute>`	`getEngineAttributes()` The response of a createServer() request returns the master credential to access the server in EngineAttributes.
`String`	`getEngineModel()` The engine model of the server.
`String`	`getEngineVersion()` The engine version of the server.
`String`	`getInstanceProfileArn()` The instance profile ARN of the server.
`String`	`getInstanceType()` The instance type for the server, as specified in the CloudFormation stack.
`String`	`getKeyPair()` The key pair associated with the server.
`String`	`getMaintenanceStatus()` The status of the most recent server maintenance run.
`String`	`getPreferredBackupWindow()` The preferred backup period specified for the server.
`String`	`getPreferredMaintenanceWindow()` The preferred maintenance period specified for the server.
`List<String>`	`getSecurityGroupIds()` The security group IDs for the server, as specified in the CloudFormation stack.
`String`	`getServerArn()` The ARN of the server.
`String`	`getServerName()` The name of the server.
`String`	`getServiceRoleArn()` The service role ARN used to create the server.
`String`	`getStatus()` The server's status.
`String`	`getStatusReason()` 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).
`List<String>`	`getSubnetIds()` The subnet IDs specified in a CreateServer request.
`int`	`hashCode()`
`Boolean`	`isAssociatePublicIpAddress()` Associate a public IP address with a server that you are launching.
`Boolean`	`isDisableAutomatedBackup()` Disables automated backups.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAssociatePublicIpAddress(Boolean associatePublicIpAddress)` Associate a public IP address with a server that you are launching.
`void`	`setBackupRetentionCount(Integer backupRetentionCount)` The number of automated backups to keep.
`void`	`setCloudFormationStackArn(String cloudFormationStackArn)` The ARN of the CloudFormation stack that was used to create the server.
`void`	`setCreatedAt(Date createdAt)` Time stamp of server creation.
`void`	`setCustomDomain(String customDomain)` An optional public endpoint of a server, such as `https://aws.my-company.com`.
`void`	`setDisableAutomatedBackup(Boolean disableAutomatedBackup)` Disables automated backups.
`void`	`setEndpoint(String endpoint)` A DNS name that can be used to access the engine.
`void`	`setEngine(String engine)` The engine type of the server.
`void`	`setEngineAttributes(Collection<EngineAttribute> engineAttributes)` The response of a createServer() request returns the master credential to access the server in EngineAttributes.
`void`	`setEngineModel(String engineModel)` The engine model of the server.
`void`	`setEngineVersion(String engineVersion)` The engine version of the server.
`void`	`setInstanceProfileArn(String instanceProfileArn)` The instance profile ARN of the server.
`void`	`setInstanceType(String instanceType)` The instance type for the server, as specified in the CloudFormation stack.
`void`	`setKeyPair(String keyPair)` The key pair associated with the server.
`void`	`setMaintenanceStatus(MaintenanceStatus maintenanceStatus)` The status of the most recent server maintenance run.
`void`	`setMaintenanceStatus(String maintenanceStatus)` The status of the most recent server maintenance run.
`void`	`setPreferredBackupWindow(String preferredBackupWindow)` The preferred backup period specified for the server.
`void`	`setPreferredMaintenanceWindow(String preferredMaintenanceWindow)` The preferred maintenance period specified for the server.
`void`	`setSecurityGroupIds(Collection<String> securityGroupIds)` The security group IDs for the server, as specified in the CloudFormation stack.
`void`	`setServerArn(String serverArn)` The ARN of the server.
`void`	`setServerName(String serverName)` The name of the server.
`void`	`setServiceRoleArn(String serviceRoleArn)` The service role ARN used to create the server.
`void`	`setStatus(ServerStatus status)` The server's status.
`void`	`setStatus(String status)` The server's status.
`void`	`setStatusReason(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).
`void`	`setSubnetIds(Collection<String> subnetIds)` The subnet IDs specified in a CreateServer request.
`String`	`toString()` Returns a string representation of this object.
`Server`	`withAssociatePublicIpAddress(Boolean associatePublicIpAddress)` Associate a public IP address with a server that you are launching.
`Server`	`withBackupRetentionCount(Integer backupRetentionCount)` The number of automated backups to keep.
`Server`	`withCloudFormationStackArn(String cloudFormationStackArn)` The ARN of the CloudFormation stack that was used to create the server.
`Server`	`withCreatedAt(Date createdAt)` Time stamp of server creation.
`Server`	`withCustomDomain(String customDomain)` An optional public endpoint of a server, such as `https://aws.my-company.com`.
`Server`	`withDisableAutomatedBackup(Boolean disableAutomatedBackup)` Disables automated backups.
`Server`	`withEndpoint(String endpoint)` A DNS name that can be used to access the engine.
`Server`	`withEngine(String engine)` The engine type of the server.
`Server`	`withEngineAttributes(Collection<EngineAttribute> engineAttributes)` The response of a createServer() request returns the master credential to access the server in EngineAttributes.
`Server`	`withEngineAttributes(EngineAttribute... engineAttributes)` The response of a createServer() request returns the master credential to access the server in EngineAttributes.
`Server`	`withEngineModel(String engineModel)` The engine model of the server.
`Server`	`withEngineVersion(String engineVersion)` The engine version of the server.
`Server`	`withInstanceProfileArn(String instanceProfileArn)` The instance profile ARN of the server.
`Server`	`withInstanceType(String instanceType)` The instance type for the server, as specified in the CloudFormation stack.
`Server`	`withKeyPair(String keyPair)` The key pair associated with the server.
`Server`	`withMaintenanceStatus(MaintenanceStatus maintenanceStatus)` The status of the most recent server maintenance run.
`Server`	`withMaintenanceStatus(String maintenanceStatus)` The status of the most recent server maintenance run.
`Server`	`withPreferredBackupWindow(String preferredBackupWindow)` The preferred backup period specified for the server.
`Server`	`withPreferredMaintenanceWindow(String preferredMaintenanceWindow)` The preferred maintenance period specified for the server.
`Server`	`withSecurityGroupIds(Collection<String> securityGroupIds)` The security group IDs for the server, as specified in the CloudFormation stack.
`Server`	`withSecurityGroupIds(String... securityGroupIds)` The security group IDs for the server, as specified in the CloudFormation stack.
`Server`	`withServerArn(String serverArn)` The ARN of the server.
`Server`	`withServerName(String serverName)` The name of the server.
`Server`	`withServiceRoleArn(String serviceRoleArn)` The service role ARN used to create the server.
`Server`	`withStatus(ServerStatus status)` The server's status.
`Server`	`withStatus(String status)` The server's status.
`Server`	`withStatusReason(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`	`withSubnetIds(Collection<String> subnetIds)` The subnet IDs specified in a CreateServer request.
`Server`	`withSubnetIds(String... subnetIds)` The subnet IDs specified in a CreateServer request.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Server
```
public Server()
```
- Method Detail
  - setAssociatePublicIpAddress
```
public void setAssociatePublicIpAddress(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.
  - getAssociatePublicIpAddress
```
public Boolean getAssociatePublicIpAddress()
```
    Associate a public IP address with a server that you are launching.
    
    Returns:
    
    Associate a public IP address with a server that you are launching.
  - withAssociatePublicIpAddress
```
public Server withAssociatePublicIpAddress(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.
  - isAssociatePublicIpAddress
```
public Boolean isAssociatePublicIpAddress()
```
    Associate a public IP address with a server that you are launching.
    
    Returns:
    
    Associate a public IP address with a server that you are launching.
  - setBackupRetentionCount
```
public void setBackupRetentionCount(Integer backupRetentionCount)
```
    The number of automated backups to keep.
    
    Parameters:
    
    backupRetentionCount - The number of automated backups to keep.
  - getBackupRetentionCount
```
public Integer getBackupRetentionCount()
```
    The number of automated backups to keep.
    
    Returns:
    
    The number of automated backups to keep.
  - withBackupRetentionCount
```
public Server withBackupRetentionCount(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.
  - setServerName
```
public void setServerName(String serverName)
```
    The name of the server.
    
    Parameters:
    
    serverName - The name of the server.
  - getServerName
```
public String getServerName()
```
    The name of the server.
    
    Returns:
    
    The name of the server.
  - withServerName
```
public Server withServerName(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.
  - setCreatedAt
```
public void setCreatedAt(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
  - getCreatedAt
```
public Date getCreatedAt()
```
    Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
    
    Returns:
    
    Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
  - withCreatedAt
```
public Server withCreatedAt(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.
  - setCloudFormationStackArn
```
public void setCloudFormationStackArn(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.
  - getCloudFormationStackArn
```
public String getCloudFormationStackArn()
```
    The ARN of the CloudFormation stack that was used to create the server.
    
    Returns:
    
    The ARN of the CloudFormation stack that was used to create the server.
  - withCloudFormationStackArn
```
public Server withCloudFormationStackArn(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.
  - setCustomDomain
```
public void setCustomDomain(String customDomain)
```
    An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
    
    Parameters:
    
    customDomain - An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
  - getCustomDomain
```
public String getCustomDomain()
```
    An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
    
    Returns:
    
    An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
  - withCustomDomain
```
public Server withCustomDomain(String customDomain)
```
    An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
    
    Parameters:
    
    customDomain - An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisableAutomatedBackup
```
public void setDisableAutomatedBackup(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.
  - getDisableAutomatedBackup
```
public Boolean getDisableAutomatedBackup()
```
    Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
    
    Returns:
    
    Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
  - withDisableAutomatedBackup
```
public Server withDisableAutomatedBackup(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.
  - isDisableAutomatedBackup
```
public Boolean isDisableAutomatedBackup()
```
    Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
    
    Returns:
    
    Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
  - setEndpoint
```
public void setEndpoint(String 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 the Endpoint value if the server has a CustomDomain 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 the Endpoint value if the server has a CustomDomain specified.
  - getEndpoint
```
public String getEndpoint()
```
    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 the Endpoint value if the server has a CustomDomain specified.
    
    Returns:
    
    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 the Endpoint value if the server has a CustomDomain specified.
  - withEndpoint
```
public Server withEndpoint(String 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 the Endpoint value if the server has a CustomDomain 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 the Endpoint value if the server has a CustomDomain specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngine
```
public void setEngine(String engine)
```
    The engine type of the server. Valid values in this release include ChefAutomate and Puppet.
    
    Parameters:
    
    engine - The engine type of the server. Valid values in this release include ChefAutomate and Puppet.
  - getEngine
```
public String getEngine()
```
    The engine type of the server. Valid values in this release include ChefAutomate and Puppet.
    
    Returns:
    
    The engine type of the server. Valid values in this release include ChefAutomate and Puppet.
  - withEngine
```
public Server withEngine(String engine)
```
    The engine type of the server. Valid values in this release include ChefAutomate and Puppet.
    
    Parameters:
    
    engine - The engine type of the server. Valid values in this release include ChefAutomate and Puppet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineModel
```
public void setEngineModel(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. Valid values in this release include Monolithic for Puppet and Single for Chef.
  - getEngineModel
```
public String getEngineModel()
```
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
    
    Returns:
    
    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
  - withEngineModel
```
public Server withEngineModel(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. Valid values in this release include Monolithic for Puppet and Single for Chef.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEngineAttributes
```
public List<EngineAttribute> getEngineAttributes()
```
    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:
    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.
  - setEngineAttributes
```
public void setEngineAttributes(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 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.
  - withEngineAttributes
```
public Server withEngineAttributes(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 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.
    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 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.
  - withEngineAttributes
```
public Server withEngineAttributes(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 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.
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.
    
    Parameters:
    
    engineVersion - The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.
  - getEngineVersion
```
public String getEngineVersion()
```
    The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.
    
    Returns:
    
    The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.
  - withEngineVersion
```
public Server withEngineVersion(String engineVersion)
```
    The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.
    
    Parameters:
    
    engineVersion - The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceProfileArn
```
public void setInstanceProfileArn(String instanceProfileArn)
```
    The instance profile ARN of the server.
    
    Parameters:
    
    instanceProfileArn - The instance profile ARN of the server.
  - getInstanceProfileArn
```
public String getInstanceProfileArn()
```
    The instance profile ARN of the server.
    
    Returns:
    
    The instance profile ARN of the server.
  - withInstanceProfileArn
```
public Server withInstanceProfileArn(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.
  - setInstanceType
```
public void setInstanceType(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.
  - getInstanceType
```
public String getInstanceType()
```
    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:
    
    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.
  - withInstanceType
```
public Server withInstanceType(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.
  - setKeyPair
```
public void setKeyPair(String keyPair)
```
    The key pair associated with the server.
    
    Parameters:
    
    keyPair - The key pair associated with the server.
  - getKeyPair
```
public String getKeyPair()
```
    The key pair associated with the server.
    
    Returns:
    
    The key pair associated with the server.
  - withKeyPair
```
public Server withKeyPair(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.
  - setMaintenanceStatus
```
public void setMaintenanceStatus(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.
    
    See Also:
    
    MaintenanceStatus
  - getMaintenanceStatus
```
public String getMaintenanceStatus()
```
    The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
    
    Returns:
    
    The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
    
    See Also:
    
    MaintenanceStatus
  - withMaintenanceStatus
```
public Server withMaintenanceStatus(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
  - setMaintenanceStatus
```
public void setMaintenanceStatus(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.
    
    See Also:
    
    MaintenanceStatus
  - withMaintenanceStatus
```
public Server withMaintenanceStatus(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
  - setPreferredMaintenanceWindow
```
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    The preferred maintenance period specified for the server.
    
    Parameters:
    
    preferredMaintenanceWindow - The preferred maintenance period specified for the server.
  - getPreferredMaintenanceWindow
```
public String getPreferredMaintenanceWindow()
```
    The preferred maintenance period specified for the server.
    
    Returns:
    
    The preferred maintenance period specified for the server.
  - withPreferredMaintenanceWindow
```
public Server withPreferredMaintenanceWindow(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.
  - setPreferredBackupWindow
```
public void setPreferredBackupWindow(String preferredBackupWindow)
```
    The preferred backup period specified for the server.
    
    Parameters:
    
    preferredBackupWindow - The preferred backup period specified for the server.
  - getPreferredBackupWindow
```
public String getPreferredBackupWindow()
```
    The preferred backup period specified for the server.
    
    Returns:
    
    The preferred backup period specified for the server.
  - withPreferredBackupWindow
```
public Server withPreferredBackupWindow(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.
  - getSecurityGroupIds
```
public List<String> getSecurityGroupIds()
```
    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:
    
    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.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(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.
  - withSecurityGroupIds
```
public Server withSecurityGroupIds(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.
  - withSecurityGroupIds
```
public Server withSecurityGroupIds(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.
  - setServiceRoleArn
```
public void setServiceRoleArn(String serviceRoleArn)
```
    The service role ARN used to create the server.
    
    Parameters:
    
    serviceRoleArn - The service role ARN used to create the server.
  - getServiceRoleArn
```
public String getServiceRoleArn()
```
    The service role ARN used to create the server.
    
    Returns:
    
    The service role ARN used to create the server.
  - withServiceRoleArn
```
public Server withServiceRoleArn(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.
  - setStatus
```
public void setStatus(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.
    
    See Also:
    
    ServerStatus
  - getStatus
```
public String getStatus()
```
    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:
    
    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.
    
    See Also:
    
    ServerStatus
  - withStatus
```
public Server withStatus(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
  - setStatus
```
public void setStatus(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.
    
    See Also:
    
    ServerStatus
  - withStatus
```
public Server withStatus(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
  - setStatusReason
```
public void setStatusReason(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).
  - getStatusReason
```
public String getStatusReason()
```
    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:
    
    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).
  - withStatusReason
```
public Server withStatusReason(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.
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    The subnet IDs specified in a CreateServer request.
    
    Returns:
    
    The subnet IDs specified in a CreateServer request.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    The subnet IDs specified in a CreateServer request.
    
    Parameters:
    
    subnetIds - The subnet IDs specified in a CreateServer request.
  - withSubnetIds
```
public Server withSubnetIds(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.
  - withSubnetIds
```
public Server withSubnetIds(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.
  - setServerArn
```
public void setServerArn(String serverArn)
```
    The ARN of the server.
    
    Parameters:
    
    serverArn - The ARN of the server.
  - getServerArn
```
public String getServerArn()
```
    The ARN of the server.
    
    Returns:
    
    The ARN of the server.
  - withServerArn
```
public Server withServerArn(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Server clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.476

Class Server

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Server

Method Detail

setAssociatePublicIpAddress

getAssociatePublicIpAddress

withAssociatePublicIpAddress

isAssociatePublicIpAddress

setBackupRetentionCount

getBackupRetentionCount

withBackupRetentionCount

setServerName

getServerName

withServerName

setCreatedAt

getCreatedAt

withCreatedAt

setCloudFormationStackArn

getCloudFormationStackArn

withCloudFormationStackArn

setCustomDomain

getCustomDomain

withCustomDomain

setDisableAutomatedBackup

getDisableAutomatedBackup

withDisableAutomatedBackup

isDisableAutomatedBackup

setEndpoint

getEndpoint

withEndpoint

setEngine

getEngine

withEngine

setEngineModel

getEngineModel

withEngineModel

getEngineAttributes

setEngineAttributes

withEngineAttributes

withEngineAttributes

setEngineVersion

getEngineVersion

withEngineVersion

setInstanceProfileArn

getInstanceProfileArn

withInstanceProfileArn

setInstanceType

getInstanceType

withInstanceType

setKeyPair

getKeyPair

withKeyPair

setMaintenanceStatus

getMaintenanceStatus

withMaintenanceStatus

setMaintenanceStatus

withMaintenanceStatus

setPreferredMaintenanceWindow

getPreferredMaintenanceWindow

withPreferredMaintenanceWindow

setPreferredBackupWindow

getPreferredBackupWindow

withPreferredBackupWindow

getSecurityGroupIds

setSecurityGroupIds

withSecurityGroupIds

withSecurityGroupIds

setServiceRoleArn

getServiceRoleArn

withServiceRoleArn

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusReason