Class DBInstanceRole

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

Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

See Also:

  • Method Details

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

    • featureName

      public final String featureName()

      The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

      Returns:
      The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

    • status

      public final String status()

      Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

      • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.

      • PENDING - the IAM role ARN is being associated with the DB instance.

      • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

      Returns:
      Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

      • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.

      • PENDING - the IAM role ARN is being associated with the DB instance.

      • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

    • toBuilder

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

    • builder

      public static DBInstanceRole.Builder builder()

    • serializableBuilderClass

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