Server (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.opsworkscm.model.Server

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Server.Builder,Server>

@Generated(value="software.amazon.awssdk:codegen")
public final class Server
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Server.Builder,Server>

Describes a configuration management server.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Server.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Server.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`associatePublicIpAddress()` Associate a public IP address with a server that you are launching.
`Integer`	`backupRetentionCount()` The number of automated backups to keep.
`static Server.Builder`	`builder()`
`String`	`cloudFormationStackArn()` The ARN of the CloudFormation stack that was used to create the server.
`Instant`	`createdAt()` Time stamp of server creation.
`Boolean`	`disableAutomatedBackup()` Disables automated backups.
`String`	`endpoint()` A DNS name that can be used to access the engine.
`String`	`engine()` The engine type of the server.
`List<EngineAttribute>`	`engineAttributes()` The response of a createServer() request returns the master credential to access the server in EngineAttributes.
`String`	`engineModel()` The engine model of the server.
`String`	`engineVersion()` The engine version of the server.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`instanceProfileArn()` The instance profile ARN of the server.
`String`	`instanceType()` The instance type for the server, as specified in the CloudFormation stack.
`String`	`keyPair()` The key pair associated with the server.
`MaintenanceStatus`	`maintenanceStatus()` The status of the most recent server maintenance run.
`String`	`maintenanceStatusAsString()` The status of the most recent server maintenance run.
`String`	`preferredBackupWindow()` The preferred backup period specified for the server.
`String`	`preferredMaintenanceWindow()` The preferred maintenance period specified for the server.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` The security group IDs for the server, as specified in the CloudFormation stack.
`static Class<? extends Server.Builder>`	`serializableBuilderClass()`
`String`	`serverArn()` The ARN of the server.
`String`	`serverName()` The name of the server.
`String`	`serviceRoleArn()` The service role ARN used to create the server.
`ServerStatus`	`status()` The server's status.
`String`	`statusAsString()` The server's status.
`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).
`List<String>`	`subnetIds()` The subnet IDs specified in a CreateServer request.
`Server.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - associatePublicIpAddress
```
public Boolean associatePublicIpAddress()
```
    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.
  - backupRetentionCount
```
public Integer backupRetentionCount()
```
    The number of automated backups to keep.
    
    Returns:
    
    The number of automated backups to keep.
  - serverName
```
public String serverName()
```
    The name of the server.
    
    Returns:
    
    The name of the server.
  - createdAt
```
public Instant createdAt()
```
    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
  - cloudFormationStackArn
```
public String cloudFormationStackArn()
```
    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.
  - disableAutomatedBackup
```
public Boolean disableAutomatedBackup()
```
    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.
  - endpoint
```
public String endpoint()
```
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
    
    Returns:
    
    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
  - engine
```
public String engine()
```
    The engine type of the server. Valid values in this release include Chef and Puppet.
    
    Returns:
    
    The engine type of the server. Valid values in this release include Chef and Puppet.
  - engineModel
```
public String engineModel()
```
    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.
  - engineAttributes
```
public List<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_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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    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_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.
  - engineVersion
```
public String engineVersion()
```
    The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 12. For a Puppet server, the valid value is 2017.
    
    Returns:
    
    The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 12. For a Puppet server, the valid value is 2017.
  - instanceProfileArn
```
public String instanceProfileArn()
```
    The instance profile ARN of the server.
    
    Returns:
    
    The instance profile ARN of the server.
  - instanceType
```
public 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.
    
    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.
  - keyPair
```
public String keyPair()
```
    The key pair associated with the server.
    
    Returns:
    
    The key pair associated with the server.
  - maintenanceStatus
```
public MaintenanceStatus maintenanceStatus()
```
    The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
    
    If the service returns an enum value that is not available in the current SDK version, maintenanceStatus will return MaintenanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maintenanceStatusAsString().
    
    Returns:
    
    The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
    
    See Also:
    
    MaintenanceStatus
  - maintenanceStatusAsString
```
public String maintenanceStatusAsString()
```
    The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
    
    If the service returns an enum value that is not available in the current SDK version, maintenanceStatus will return MaintenanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maintenanceStatusAsString().
    
    Returns:
    
    The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
    
    See Also:
    
    MaintenanceStatus
  - preferredMaintenanceWindow
```
public String preferredMaintenanceWindow()
```
    The preferred maintenance period specified for the server.
    
    Returns:
    
    The preferred maintenance period specified for the server.
  - preferredBackupWindow
```
public String preferredBackupWindow()
```
    The preferred backup period specified for the server.
    
    Returns:
    
    The preferred backup period specified for the server.
  - securityGroupIds
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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.
  - serviceRoleArn
```
public String serviceRoleArn()
```
    The service role ARN used to create the server.
    
    Returns:
    
    The service role ARN used to create the server.
  - status
```
public 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ServerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    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
  - statusAsString
```
public String statusAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ServerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    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
  - statusReason
```
public 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).
    
    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).
  - subnetIds
```
public List<String> subnetIds()
```
    The subnet IDs specified in a CreateServer request.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The subnet IDs specified in a CreateServer request.
  - serverArn
```
public String serverArn()
```
    The ARN of the server.
    
    Returns:
    
    The ARN of the server.
  - toBuilder
```
public Server.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Server.Builder,Server>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Server.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Server.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Server

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

associatePublicIpAddress

backupRetentionCount

serverName

createdAt

cloudFormationStackArn

disableAutomatedBackup

endpoint

engine

engineModel

engineAttributes

engineVersion

instanceProfileArn

instanceType

keyPair

maintenanceStatus

maintenanceStatusAsString

preferredMaintenanceWindow

preferredBackupWindow

securityGroupIds

serviceRoleArn

status

statusAsString

statusReason

subnetIds

serverArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields