Class RegisteredInstance

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

Describes an Amazon EC2 instance that is enabled for SQL Server High Availability standby detection monitoring.

See Also:

  • Method Details

    • instanceId

      public final String instanceId()

      The ID of the SQL Server High Availability instance.

      Returns:
      The ID of the SQL Server High Availability instance.

    • sqlServerLicenseUsage

      public final SqlServerLicenseUsage sqlServerLicenseUsage()

      The license type for the SQL Server license. Valid values include:

      • full - The SQL Server High Availability instance is using a full SQL Server license.

      • waived - The SQL Server High Availability instance is waived from the SQL Server license.

      If the service returns an enum value that is not available in the current SDK version, sqlServerLicenseUsage will return SqlServerLicenseUsage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sqlServerLicenseUsageAsString().

      Returns:
      The license type for the SQL Server license. Valid values include:

      • full - The SQL Server High Availability instance is using a full SQL Server license.

      • waived - The SQL Server High Availability instance is waived from the SQL Server license.

      See Also:

    • sqlServerLicenseUsageAsString

      public final String sqlServerLicenseUsageAsString()

      The license type for the SQL Server license. Valid values include:

      • full - The SQL Server High Availability instance is using a full SQL Server license.

      • waived - The SQL Server High Availability instance is waived from the SQL Server license.

      If the service returns an enum value that is not available in the current SDK version, sqlServerLicenseUsage will return SqlServerLicenseUsage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sqlServerLicenseUsageAsString().

      Returns:
      The license type for the SQL Server license. Valid values include:

      • full - The SQL Server High Availability instance is using a full SQL Server license.

      • waived - The SQL Server High Availability instance is waived from the SQL Server license.

      See Also:

    • haStatus

      public final HaStatus haStatus()

      The SQL Server High Availability status of the instance. Valid values are:

      • processing - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.

      • active - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.

      • standby - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.

      • invalid - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.

      If the service returns an enum value that is not available in the current SDK version, haStatus will return HaStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from haStatusAsString().

      Returns:
      The SQL Server High Availability status of the instance. Valid values are:

      • processing - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.

      • active - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.

      • standby - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.

      • invalid - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.

      See Also:

    • haStatusAsString

      public final String haStatusAsString()

      The SQL Server High Availability status of the instance. Valid values are:

      • processing - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.

      • active - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.

      • standby - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.

      • invalid - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.

      If the service returns an enum value that is not available in the current SDK version, haStatus will return HaStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from haStatusAsString().

      Returns:
      The SQL Server High Availability status of the instance. Valid values are:

      • processing - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.

      • active - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.

      • standby - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.

      • invalid - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.

      See Also:

    • processingStatus

      public final String processingStatus()

      A brief description of the SQL Server High Availability status. If the instance is in the invalid High Availability status, this parameter includes the error message.

      Returns:
      A brief description of the SQL Server High Availability status. If the instance is in the invalid High Availability status, this parameter includes the error message.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date and time when the instance's SQL Server High Availability status was last updated, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

      Returns:
      The date and time when the instance's SQL Server High Availability status was last updated, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

    • sqlServerCredentials

      public final String sqlServerCredentials()

      The ARN of the Secrets Manager secret containing the SQL Server access credentials for the SQL Server High Availability instance. If not specified, deafult local user credentials will be used by the Amazon Web Services Systems Manager agent.

      Returns:
      The ARN of the Secrets Manager secret containing the SQL Server access credentials for the SQL Server High Availability instance. If not specified, deafult local user credentials will be used by the Amazon Web Services Systems Manager agent.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The tags assigned to the SQL Server High Availability instance.

      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 hasTags() method.

      Returns:
      The tags assigned to the SQL Server High Availability instance.

    • toBuilder

      public RegisteredInstance.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<RegisteredInstance.Builder,RegisteredInstance>
      Returns:
      a builder for type T

    • builder

      public static RegisteredInstance.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RegisteredInstance.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.