AwsAmazonMqBrokerDetails (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.securityhub.model.AwsAmazonMqBrokerDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsAmazonMqBrokerDetails.Builder,AwsAmazonMqBrokerDetails>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AwsAmazonMqBrokerDetails.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`authenticationStrategy()` The authentication strategy used to secure the broker.
`Boolean`	`autoMinorVersionUpgrade()` Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`String`	`brokerArn()` The Amazon Resource Name (ARN) of the broker.
`String`	`brokerId()` The unique ID that Amazon MQ generates for the broker.
`String`	`brokerName()` The broker's name.
`static AwsAmazonMqBrokerDetails.Builder`	`builder()`
`String`	`deploymentMode()` The broker's deployment mode.
`AwsAmazonMqBrokerEncryptionOptionsDetails`	`encryptionOptions()` Encryption options for the broker.
`String`	`engineType()` The type of broker engine.
`String`	`engineVersion()` The version of the broker engine.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()` For responses, this returns true if the service returned a value for the SecurityGroups property.
`boolean`	`hasSubnetIds()` For responses, this returns true if the service returned a value for the SubnetIds property.
`boolean`	`hasUsers()` For responses, this returns true if the service returned a value for the Users property.
`String`	`hostInstanceType()` The broker's instance type.
`AwsAmazonMqBrokerLdapServerMetadataDetails`	`ldapServerMetadata()` The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker.
`AwsAmazonMqBrokerLogsDetails`	`logs()` Turns on Amazon CloudWatch logging for brokers.
`AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails`	`maintenanceWindowStartTime()` The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
`Boolean`	`publiclyAccessible()` Permits connections from applications outside of the VPC that hosts the broker's subnets.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
`static Class<? extends AwsAmazonMqBrokerDetails.Builder>`	`serializableBuilderClass()`
`String`	`storageType()` The broker's storage type.
`List<String>`	`subnetIds()` The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
`AwsAmazonMqBrokerDetails.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<AwsAmazonMqBrokerUsersDetails>`	`users()` The list of all broker usernames for the specified broker.

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

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

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AwsAmazonMqBrokerDetails.Builder,AwsAmazonMqBrokerDetails>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class AwsAmazonMqBrokerDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

authenticationStrategy

autoMinorVersionUpgrade

brokerArn

brokerName

deploymentMode

encryptionOptions

engineType

engineVersion

hostInstanceType

brokerId

ldapServerMetadata

logs

maintenanceWindowStartTime

publiclyAccessible

hasSecurityGroups

securityGroups

storageType

hasSubnetIds

subnetIds

hasUsers

users

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields