Class AwsAmazonMqBrokerDetails

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

Provides details about an Amazon MQ message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

See Also:

  • Method Details

    • authenticationStrategy

      public final String authenticationStrategy()

      The authentication strategy used to secure the broker. The default is SIMPLE.

      Returns:
      The authentication strategy used to secure the broker. The default is SIMPLE.

    • autoMinorVersionUpgrade

      public final Boolean autoMinorVersionUpgrade()

      Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

      Returns:
      Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

    • brokerArn

      public final String brokerArn()

      The Amazon Resource Name (ARN) of the broker.

      Returns:
      The Amazon Resource Name (ARN) of the broker.

    • brokerName

      public final String brokerName()

      The broker's name.

      Returns:
      The broker's name.

    • deploymentMode

      public final String deploymentMode()

      The broker's deployment mode.

      Returns:
      The broker's deployment mode.

    • encryptionOptions

      public final AwsAmazonMqBrokerEncryptionOptionsDetails encryptionOptions()

      Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.

      Returns:
      Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.

    • engineType

      public final String engineType()

      The type of broker engine.

      Returns:
      The type of broker engine.

    • engineVersion

      public final String engineVersion()

      The version of the broker engine.

      Returns:
      The version of the broker engine.

    • hostInstanceType

      public final String hostInstanceType()

      The broker's instance type.

      Returns:
      The broker's instance type.

    • brokerId

      public final String brokerId()

      The unique ID that Amazon MQ generates for the broker.

      Returns:
      The unique ID that Amazon MQ generates for the broker.

    • ldapServerMetadata

      public final AwsAmazonMqBrokerLdapServerMetadataDetails ldapServerMetadata()

      The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

      Returns:
      The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

    • logs

      public final AwsAmazonMqBrokerLogsDetails logs()

      Turns on Amazon CloudWatch logging for brokers.

      Returns:
      Turns on Amazon CloudWatch logging for brokers.

    • maintenanceWindowStartTime

      public final AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails maintenanceWindowStartTime()

      The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.

      Returns:
      The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Permits connections from applications outside of the VPC that hosts the broker's subnets.

      Returns:
      Permits connections from applications outside of the VPC that hosts the broker's subnets.

    • hasSecurityGroups

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

    • securityGroups

      public final List<String> securityGroups()

      The list of rules (one minimum, 125 maximum) that authorize connections to brokers.

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

      Returns:
      The list of rules (one minimum, 125 maximum) that authorize connections to brokers.

    • storageType

      public final String storageType()

      The broker's storage type.

      Returns:
      The broker's storage type.

    • 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 list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

      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 list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

    • hasUsers

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

    • users

      public final List<AwsAmazonMqBrokerUsersDetails> users()

      The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

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

      Returns:
      The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

    • toBuilder

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

    • builder

      public static AwsAmazonMqBrokerDetails.Builder builder()

    • serializableBuilderClass

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