Class UpdateBrokerRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateBrokerRequest.Builder,
UpdateBrokerRequest>
Updates the broker using the specified properties.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AuthenticationStrategy
Optional.final String
Optional.final Boolean
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.final String
brokerId()
The unique ID that Amazon MQ generates for the broker.static UpdateBrokerRequest.Builder
builder()
final ConfigurationId
A list of information about the configuration.final DataReplicationMode
Defines whether this broker is a part of a data replication pair.final String
Defines whether this broker is a part of a data replication pair.final String
The broker engine version.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroups property.final String
The broker's host instance type to upgrade to.final LdapServerMetadataInput
Optional.final Logs
logs()
Enables Amazon CloudWatch logging for brokers.final WeeklyStartTime
The parameters that determine the WeeklyStartTime.The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.static Class
<? extends UpdateBrokerRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnAuthenticationStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationStrategyAsString()
.- Returns:
- Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
- See Also:
-
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 returnAuthenticationStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationStrategyAsString()
.- Returns:
- Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
- See Also:
-
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
The unique ID that Amazon MQ generates for the broker.
- Returns:
- The unique ID that Amazon MQ generates for the broker.
-
configuration
A list of information about the configuration.
- Returns:
- A list of information about the configuration.
-
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
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
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
Enables Amazon CloudWatch logging for brokers.
- Returns:
- Enables Amazon CloudWatch logging for brokers.
-
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 theisEmpty()
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
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
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 returnDataReplicationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataReplicationModeAsString()
.- Returns:
- Defines whether this broker is a part of a data replication pair.
- See Also:
-
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 returnDataReplicationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataReplicationModeAsString()
.- Returns:
- Defines whether this broker is a part of a data replication pair.
- See Also:
-
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 interfaceToCopyableBuilder<UpdateBrokerRequest.Builder,
UpdateBrokerRequest> - Specified by:
toBuilder
in classMqRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-