Class Server

java.lang.Object
software.amazon.awssdk.services.opsworkscm.model.Server
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Server.Builder,Server>
@Generated("software.amazon.awssdk:codegen") public final class Server extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Server.Builder,Server>

Describes a configuration management server.

See Also:

  • Method Details

    • associatePublicIpAddress

      public final 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 final Integer backupRetentionCount()

      The number of automated backups to keep.

      Returns:
      The number of automated backups to keep.

    • serverName

      public final String serverName()

      The name of the server.

      Returns:
      The name of the server.

    • createdAt

      public final 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 final 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.

    • customDomain

      public final 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.

      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.

    • disableAutomatedBackup

      public final 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 final 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.

      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.

    • engine

      public final String engine()

      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.

    • engineModel

      public final 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.

    • hasEngineAttributes

      public final boolean hasEngineAttributes()
      For responses, this returns true if the service returned a value for the EngineAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • engineAttributes

      public final 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_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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEngineAttributes() method.

      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.

    • engineVersion

      public final 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.

      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.

    • instanceProfileArn

      public final String instanceProfileArn()

      The instance profile ARN of the server.

      Returns:
      The instance profile ARN of the server.

    • instanceType

      public final 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 final String keyPair()

      The key pair associated with the server.

      Returns:
      The key pair associated with the server.

    • maintenanceStatus

      public final 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:

    • maintenanceStatusAsString

      public final 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:

    • preferredMaintenanceWindow

      public final String preferredMaintenanceWindow()

      The preferred maintenance period specified for the server.

      Returns:
      The preferred maintenance period specified for the server.

    • preferredBackupWindow

      public final String preferredBackupWindow()

      The preferred backup period specified for the server.

      Returns:
      The preferred backup period specified for the server.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroupIds

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

      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 final String serviceRoleArn()

      The service role ARN used to create the server.

      Returns:
      The service role ARN used to create the server.

    • status

      public final 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:

    • statusAsString

      public final 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:

    • statusReason

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

    • hasSubnetIds

      public final boolean hasSubnetIds()
      For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • subnetIds

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

      Returns:
      The subnet IDs specified in a CreateServer request.

    • serverArn

      public final 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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final 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.