com.amazonaws.services.mq.model

Class UpdateBrokerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.mq.model.UpdateBrokerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateBrokerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Updates the broker using the specified properties.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateBrokerRequest()

Method Summary

Modifier and Type	Method and Description
UpdateBrokerRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAuthenticationStrategy() Optional.
Boolean	getAutoMinorVersionUpgrade() Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.
String	getBrokerId() The unique ID that Amazon MQ generates for the broker.
ConfigurationId	getConfiguration() A list of information about the configuration.
String	getDataReplicationMode() Defines whether this broker is a part of a data replication pair.
String	getEngineVersion() The broker engine version.
String	getHostInstanceType() The broker's host instance type to upgrade to.
LdapServerMetadataInput	getLdapServerMetadata() Optional.
Logs	getLogs() Enables Amazon CloudWatch logging for brokers.
WeeklyStartTime	getMaintenanceWindowStartTime() The parameters that determine the WeeklyStartTime.
List<String>	getSecurityGroups() The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.
void	setAuthenticationStrategy(String authenticationStrategy) Optional.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.
void	setBrokerId(String brokerId) The unique ID that Amazon MQ generates for the broker.
void	setConfiguration(ConfigurationId configuration) A list of information about the configuration.
void	setDataReplicationMode(String dataReplicationMode) Defines whether this broker is a part of a data replication pair.
void	setEngineVersion(String engineVersion) The broker engine version.
void	setHostInstanceType(String hostInstanceType) The broker's host instance type to upgrade to.
void	setLdapServerMetadata(LdapServerMetadataInput ldapServerMetadata) Optional.
void	setLogs(Logs logs) Enables Amazon CloudWatch logging for brokers.
void	setMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime) The parameters that determine the WeeklyStartTime.
void	setSecurityGroups(Collection<String> securityGroups) The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
String	toString() Returns a string representation of this object.
UpdateBrokerRequest	withAuthenticationStrategy(AuthenticationStrategy authenticationStrategy) Optional.
UpdateBrokerRequest	withAuthenticationStrategy(String authenticationStrategy) Optional.
UpdateBrokerRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.
UpdateBrokerRequest	withBrokerId(String brokerId) The unique ID that Amazon MQ generates for the broker.
UpdateBrokerRequest	withConfiguration(ConfigurationId configuration) A list of information about the configuration.
UpdateBrokerRequest	withDataReplicationMode(DataReplicationMode dataReplicationMode) Defines whether this broker is a part of a data replication pair.
UpdateBrokerRequest	withDataReplicationMode(String dataReplicationMode) Defines whether this broker is a part of a data replication pair.
UpdateBrokerRequest	withEngineVersion(String engineVersion) The broker engine version.
UpdateBrokerRequest	withHostInstanceType(String hostInstanceType) The broker's host instance type to upgrade to.
UpdateBrokerRequest	withLdapServerMetadata(LdapServerMetadataInput ldapServerMetadata) Optional.
UpdateBrokerRequest	withLogs(Logs logs) Enables Amazon CloudWatch logging for brokers.
UpdateBrokerRequest	withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime) The parameters that determine the WeeklyStartTime.
UpdateBrokerRequest	withSecurityGroups(Collection<String> securityGroups) The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
UpdateBrokerRequest	withSecurityGroups(String... securityGroups) The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateBrokerRequest

public UpdateBrokerRequest()

Method Detail

setAuthenticationStrategy

public void setAuthenticationStrategy(String authenticationStrategy)

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

Parameters:

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

See Also:

AuthenticationStrategy

getAuthenticationStrategy

public String getAuthenticationStrategy()

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

Returns:

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

See Also:

AuthenticationStrategy

withAuthenticationStrategy

public UpdateBrokerRequest withAuthenticationStrategy(String authenticationStrategy)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationStrategy

withAuthenticationStrategy

public UpdateBrokerRequest withAuthenticationStrategy(AuthenticationStrategy authenticationStrategy)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationStrategy

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

Parameters:

autoMinorVersionUpgrade - Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

Returns:

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

withAutoMinorVersionUpgrade

public UpdateBrokerRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

Parameters:

autoMinorVersionUpgrade - Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

Returns:

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

setBrokerId

public void setBrokerId(String brokerId)

The unique ID that Amazon MQ generates for the broker.

Parameters:

brokerId - The unique ID that Amazon MQ generates for the broker.

getBrokerId

public String getBrokerId()

The unique ID that Amazon MQ generates for the broker.

Returns:

The unique ID that Amazon MQ generates for the broker.

withBrokerId

public UpdateBrokerRequest withBrokerId(String brokerId)

The unique ID that Amazon MQ generates for the broker.

Parameters:

brokerId - The unique ID that Amazon MQ generates for the broker.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConfiguration

public void setConfiguration(ConfigurationId configuration)

A list of information about the configuration.

Parameters:

configuration - A list of information about the configuration.

getConfiguration

public ConfigurationId getConfiguration()

A list of information about the configuration.

Returns:

A list of information about the configuration.

withConfiguration

public UpdateBrokerRequest withConfiguration(ConfigurationId configuration)

A list of information about the configuration.

Parameters:

configuration - A list of information about the configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEngineVersion

public void setEngineVersion(String engineVersion)

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

Parameters:

engineVersion - The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

getEngineVersion

public String getEngineVersion()

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

Returns:

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

withEngineVersion

public UpdateBrokerRequest withEngineVersion(String engineVersion)

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

Parameters:

engineVersion - The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHostInstanceType

public void setHostInstanceType(String hostInstanceType)

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

Parameters:

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

getHostInstanceType

public String getHostInstanceType()

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.

withHostInstanceType

public UpdateBrokerRequest withHostInstanceType(String hostInstanceType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLdapServerMetadata

public void setLdapServerMetadata(LdapServerMetadataInput ldapServerMetadata)

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

Parameters:

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

getLdapServerMetadata

public LdapServerMetadataInput getLdapServerMetadata()

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.

withLdapServerMetadata

public UpdateBrokerRequest withLdapServerMetadata(LdapServerMetadataInput ldapServerMetadata)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLogs

public void setLogs(Logs logs)

Enables Amazon CloudWatch logging for brokers.

Parameters:

logs - Enables Amazon CloudWatch logging for brokers.

getLogs

public Logs getLogs()

Enables Amazon CloudWatch logging for brokers.

Returns:

Enables Amazon CloudWatch logging for brokers.

withLogs

public UpdateBrokerRequest withLogs(Logs logs)

Enables Amazon CloudWatch logging for brokers.

Parameters:

logs - Enables Amazon CloudWatch logging for brokers.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaintenanceWindowStartTime

public void setMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)

The parameters that determine the WeeklyStartTime.

Parameters:

maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.

getMaintenanceWindowStartTime

public WeeklyStartTime getMaintenanceWindowStartTime()

The parameters that determine the WeeklyStartTime.

Returns:

The parameters that determine the WeeklyStartTime.

withMaintenanceWindowStartTime

public UpdateBrokerRequest withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)

The parameters that determine the WeeklyStartTime.

Parameters:

maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSecurityGroups

public List<String> getSecurityGroups()

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Returns:

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

setSecurityGroups

public void setSecurityGroups(Collection<String> securityGroups)

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Parameters:

securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

withSecurityGroups

public UpdateBrokerRequest withSecurityGroups(String... securityGroups)

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityGroups

public UpdateBrokerRequest withSecurityGroups(Collection<String> securityGroups)

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Parameters:

securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataReplicationMode

public void setDataReplicationMode(String dataReplicationMode)

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

Parameters:

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

See Also:

DataReplicationMode

getDataReplicationMode

public String getDataReplicationMode()

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

Returns:

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

See Also:

DataReplicationMode

withDataReplicationMode

public UpdateBrokerRequest withDataReplicationMode(String dataReplicationMode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataReplicationMode

withDataReplicationMode

public UpdateBrokerRequest withDataReplicationMode(DataReplicationMode dataReplicationMode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataReplicationMode

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateBrokerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()