Package software.amazon.awssdk.services.mq.model

Class UpdateBrokerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mq.model.MqRequest

software.amazon.awssdk.services.mq.model.UpdateBrokerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateBrokerRequest.Builder,UpdateBrokerRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateBrokerRequest
extends MqRequest
implements ToCopyableBuilder<UpdateBrokerRequest.Builder,UpdateBrokerRequest>

Updates the broker using the specified properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateBrokerRequest.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationStrategy	authenticationStrategy()	Optional.
String	authenticationStrategyAsString()	Optional.
Boolean	autoMinorVersionUpgrade()	Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
String	brokerId()	The unique ID that Amazon MQ generates for the broker.
static UpdateBrokerRequest.Builder	builder()
ConfigurationId	configuration()	A list of information about the configuration.
DataReplicationMode	dataReplicationMode()	Defines whether this broker is a part of a data replication pair.
String	dataReplicationModeAsString()	Defines whether this broker is a part of a data replication pair.
String	engineVersion()	The broker engine version.
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.
String	hostInstanceType()	The broker's host instance type to upgrade to.
LdapServerMetadataInput	ldapServerMetadata()	Optional.
Logs	logs()	Enables Amazon CloudWatch logging for brokers.
WeeklyStartTime	maintenanceWindowStartTime()	The parameters that determine the WeeklyStartTime.
List<SdkField<?>>	sdkFields()
List<String>	securityGroups()	The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
static Class<? extends UpdateBrokerRequest.Builder>	serializableBuilderClass()
UpdateBrokerRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 AuthenticationStrategy authenticationStrategy()

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

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

Returns:

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

See Also:

AuthenticationStrategy

authenticationStrategyAsString

public final String authenticationStrategyAsString()

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

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

Returns:

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

See Also:

AuthenticationStrategy

autoMinorVersionUpgrade

public final Boolean autoMinorVersionUpgrade()

Enables automatic upgrades to 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:

Enables automatic upgrades to 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.

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.

configuration

public final ConfigurationId configuration()

A list of information about the configuration.

Returns:

A list of information about the configuration.

engineVersion

public final String engineVersion()

The broker engine version. For a list of supported engine versions, see Supported engines.

Returns:

The broker engine version. For a list of supported engine versions, see Supported engines.

hostInstanceType

public final String hostInstanceType()

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

Returns:

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

ldapServerMetadata

public final LdapServerMetadataInput ldapServerMetadata()

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Returns:

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

logs

public final Logs logs()

Enables Amazon CloudWatch logging for brokers.

Returns:

Enables Amazon CloudWatch logging for brokers.

maintenanceWindowStartTime

public final WeeklyStartTime maintenanceWindowStartTime()

The parameters that determine the WeeklyStartTime.

Returns:

The parameters that determine the WeeklyStartTime.

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 security groups (1 minimum, 5 maximum) that authorizes 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 security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

dataReplicationMode

public final DataReplicationMode dataReplicationMode()

Defines whether this broker is a part of a data replication pair.

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

Returns:

Defines whether this broker is a part of a data replication pair.

See Also:

DataReplicationMode

dataReplicationModeAsString

public final String dataReplicationModeAsString()

Defines whether this broker is a part of a data replication pair.

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

Returns:

Defines whether this broker is a part of a data replication pair.

See Also:

DataReplicationMode

toBuilder

public UpdateBrokerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateBrokerRequest.Builder,UpdateBrokerRequest>

Specified by:

toBuilder in class MqRequest

builder

public static UpdateBrokerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateBrokerRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo