@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AwsAmazonMqBrokerDetails extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
AwsAmazonMqBrokerDetails() |
Modifier and Type | Method and Description |
---|---|
AwsAmazonMqBrokerDetails |
clone() |
boolean |
equals(Object obj) |
String |
getAuthenticationStrategy()
The authentication strategy used to secure the broker.
|
Boolean |
getAutoMinorVersionUpgrade()
Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by
Amazon MQ.
|
String |
getBrokerArn()
The Amazon Resource Name (ARN) of the broker.
|
String |
getBrokerId()
The unique ID that Amazon MQ generates for the broker.
|
String |
getBrokerName()
The broker's name.
|
String |
getDeploymentMode()
The broker's deployment mode.
|
AwsAmazonMqBrokerEncryptionOptionsDetails |
getEncryptionOptions()
Encryption options for the broker.
|
String |
getEngineType()
The type of broker engine.
|
String |
getEngineVersion()
The version of the broker engine.
|
String |
getHostInstanceType()
The broker's instance type.
|
AwsAmazonMqBrokerLdapServerMetadataDetails |
getLdapServerMetadata()
The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize
connections to the broker.
|
AwsAmazonMqBrokerLogsDetails |
getLogs()
Turns on Amazon CloudWatch logging for brokers.
|
AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails |
getMaintenanceWindowStartTime()
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
|
Boolean |
getPubliclyAccessible()
Permits connections from applications outside of the VPC that hosts the broker's subnets.
|
List<String> |
getSecurityGroups()
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
|
String |
getStorageType()
The broker's storage type.
|
List<String> |
getSubnetIds()
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
|
List<AwsAmazonMqBrokerUsersDetails> |
getUsers()
The list of all broker usernames for the specified broker.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by
Amazon MQ.
|
Boolean |
isPubliclyAccessible()
Permits connections from applications outside of the VPC that hosts the broker's subnets.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAuthenticationStrategy(String authenticationStrategy)
The authentication strategy used to secure the broker.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by
Amazon MQ.
|
void |
setBrokerArn(String brokerArn)
The Amazon Resource Name (ARN) of the broker.
|
void |
setBrokerId(String brokerId)
The unique ID that Amazon MQ generates for the broker.
|
void |
setBrokerName(String brokerName)
The broker's name.
|
void |
setDeploymentMode(String deploymentMode)
The broker's deployment mode.
|
void |
setEncryptionOptions(AwsAmazonMqBrokerEncryptionOptionsDetails encryptionOptions)
Encryption options for the broker.
|
void |
setEngineType(String engineType)
The type of broker engine.
|
void |
setEngineVersion(String engineVersion)
The version of the broker engine.
|
void |
setHostInstanceType(String hostInstanceType)
The broker's instance type.
|
void |
setLdapServerMetadata(AwsAmazonMqBrokerLdapServerMetadataDetails ldapServerMetadata)
The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize
connections to the broker.
|
void |
setLogs(AwsAmazonMqBrokerLogsDetails logs)
Turns on Amazon CloudWatch logging for brokers.
|
void |
setMaintenanceWindowStartTime(AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails maintenanceWindowStartTime)
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Permits connections from applications outside of the VPC that hosts the broker's subnets.
|
void |
setSecurityGroups(Collection<String> securityGroups)
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
|
void |
setStorageType(String storageType)
The broker's storage type.
|
void |
setSubnetIds(Collection<String> subnetIds)
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
|
void |
setUsers(Collection<AwsAmazonMqBrokerUsersDetails> users)
The list of all broker usernames for the specified broker.
|
String |
toString()
Returns a string representation of this object.
|
AwsAmazonMqBrokerDetails |
withAuthenticationStrategy(String authenticationStrategy)
The authentication strategy used to secure the broker.
|
AwsAmazonMqBrokerDetails |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by
Amazon MQ.
|
AwsAmazonMqBrokerDetails |
withBrokerArn(String brokerArn)
The Amazon Resource Name (ARN) of the broker.
|
AwsAmazonMqBrokerDetails |
withBrokerId(String brokerId)
The unique ID that Amazon MQ generates for the broker.
|
AwsAmazonMqBrokerDetails |
withBrokerName(String brokerName)
The broker's name.
|
AwsAmazonMqBrokerDetails |
withDeploymentMode(String deploymentMode)
The broker's deployment mode.
|
AwsAmazonMqBrokerDetails |
withEncryptionOptions(AwsAmazonMqBrokerEncryptionOptionsDetails encryptionOptions)
Encryption options for the broker.
|
AwsAmazonMqBrokerDetails |
withEngineType(String engineType)
The type of broker engine.
|
AwsAmazonMqBrokerDetails |
withEngineVersion(String engineVersion)
The version of the broker engine.
|
AwsAmazonMqBrokerDetails |
withHostInstanceType(String hostInstanceType)
The broker's instance type.
|
AwsAmazonMqBrokerDetails |
withLdapServerMetadata(AwsAmazonMqBrokerLdapServerMetadataDetails ldapServerMetadata)
The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize
connections to the broker.
|
AwsAmazonMqBrokerDetails |
withLogs(AwsAmazonMqBrokerLogsDetails logs)
Turns on Amazon CloudWatch logging for brokers.
|
AwsAmazonMqBrokerDetails |
withMaintenanceWindowStartTime(AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails maintenanceWindowStartTime)
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
|
AwsAmazonMqBrokerDetails |
withPubliclyAccessible(Boolean publiclyAccessible)
Permits connections from applications outside of the VPC that hosts the broker's subnets.
|
AwsAmazonMqBrokerDetails |
withSecurityGroups(Collection<String> securityGroups)
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
|
AwsAmazonMqBrokerDetails |
withSecurityGroups(String... securityGroups)
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
|
AwsAmazonMqBrokerDetails |
withStorageType(String storageType)
The broker's storage type.
|
AwsAmazonMqBrokerDetails |
withSubnetIds(Collection<String> subnetIds)
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
|
AwsAmazonMqBrokerDetails |
withSubnetIds(String... subnetIds)
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
|
AwsAmazonMqBrokerDetails |
withUsers(AwsAmazonMqBrokerUsersDetails... users)
The list of all broker usernames for the specified broker.
|
AwsAmazonMqBrokerDetails |
withUsers(Collection<AwsAmazonMqBrokerUsersDetails> users)
The list of all broker usernames for the specified broker.
|
public void setAuthenticationStrategy(String authenticationStrategy)
The authentication strategy used to secure the broker. The default is SIMPLE
.
authenticationStrategy
- The authentication strategy used to secure the broker. The default is SIMPLE
.public String getAuthenticationStrategy()
The authentication strategy used to secure the broker. The default is SIMPLE
.
SIMPLE
.public AwsAmazonMqBrokerDetails withAuthenticationStrategy(String authenticationStrategy)
The authentication strategy used to secure the broker. The default is SIMPLE
.
authenticationStrategy
- The authentication strategy used to secure the broker. The default is SIMPLE
.public void setAutoMinorVersionUpgrade(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.
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.public Boolean getAutoMinorVersionUpgrade()
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.
public AwsAmazonMqBrokerDetails withAutoMinorVersionUpgrade(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.
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.public Boolean isAutoMinorVersionUpgrade()
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.
public void setBrokerArn(String brokerArn)
The Amazon Resource Name (ARN) of the broker.
brokerArn
- The Amazon Resource Name (ARN) of the broker.public String getBrokerArn()
The Amazon Resource Name (ARN) of the broker.
public AwsAmazonMqBrokerDetails withBrokerArn(String brokerArn)
The Amazon Resource Name (ARN) of the broker.
brokerArn
- The Amazon Resource Name (ARN) of the broker.public void setBrokerName(String brokerName)
The broker's name.
brokerName
- The broker's name.public String getBrokerName()
The broker's name.
public AwsAmazonMqBrokerDetails withBrokerName(String brokerName)
The broker's name.
brokerName
- The broker's name.public void setDeploymentMode(String deploymentMode)
The broker's deployment mode.
deploymentMode
- The broker's deployment mode.public String getDeploymentMode()
The broker's deployment mode.
public AwsAmazonMqBrokerDetails withDeploymentMode(String deploymentMode)
The broker's deployment mode.
deploymentMode
- The broker's deployment mode.public void setEncryptionOptions(AwsAmazonMqBrokerEncryptionOptionsDetails encryptionOptions)
Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.
encryptionOptions
- Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.public AwsAmazonMqBrokerEncryptionOptionsDetails getEncryptionOptions()
Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.
public AwsAmazonMqBrokerDetails withEncryptionOptions(AwsAmazonMqBrokerEncryptionOptionsDetails encryptionOptions)
Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.
encryptionOptions
- Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.public void setEngineType(String engineType)
The type of broker engine.
engineType
- The type of broker engine.public String getEngineType()
The type of broker engine.
public AwsAmazonMqBrokerDetails withEngineType(String engineType)
The type of broker engine.
engineType
- The type of broker engine.public void setEngineVersion(String engineVersion)
The version of the broker engine.
engineVersion
- The version of the broker engine.public String getEngineVersion()
The version of the broker engine.
public AwsAmazonMqBrokerDetails withEngineVersion(String engineVersion)
The version of the broker engine.
engineVersion
- The version of the broker engine.public void setHostInstanceType(String hostInstanceType)
The broker's instance type.
hostInstanceType
- The broker's instance type.public String getHostInstanceType()
The broker's instance type.
public AwsAmazonMqBrokerDetails withHostInstanceType(String hostInstanceType)
The broker's instance type.
hostInstanceType
- The broker's instance type.public void setBrokerId(String brokerId)
The unique ID that Amazon MQ generates for the broker.
brokerId
- The unique ID that Amazon MQ generates for the broker.public String getBrokerId()
The unique ID that Amazon MQ generates for the broker.
public AwsAmazonMqBrokerDetails withBrokerId(String brokerId)
The unique ID that Amazon MQ generates for the broker.
brokerId
- The unique ID that Amazon MQ generates for the broker.public void setLdapServerMetadata(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.
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.public AwsAmazonMqBrokerLdapServerMetadataDetails getLdapServerMetadata()
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.
public AwsAmazonMqBrokerDetails withLdapServerMetadata(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.
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.public void setLogs(AwsAmazonMqBrokerLogsDetails logs)
Turns on Amazon CloudWatch logging for brokers.
logs
- Turns on Amazon CloudWatch logging for brokers.public AwsAmazonMqBrokerLogsDetails getLogs()
Turns on Amazon CloudWatch logging for brokers.
public AwsAmazonMqBrokerDetails withLogs(AwsAmazonMqBrokerLogsDetails logs)
Turns on Amazon CloudWatch logging for brokers.
logs
- Turns on Amazon CloudWatch logging for brokers.public void setMaintenanceWindowStartTime(AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails maintenanceWindowStartTime)
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
maintenanceWindowStartTime
- The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the
broker.public AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails getMaintenanceWindowStartTime()
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
public AwsAmazonMqBrokerDetails withMaintenanceWindowStartTime(AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails maintenanceWindowStartTime)
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
maintenanceWindowStartTime
- The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the
broker.public void setPubliclyAccessible(Boolean publiclyAccessible)
Permits connections from applications outside of the VPC that hosts the broker's subnets.
publiclyAccessible
- Permits connections from applications outside of the VPC that hosts the broker's subnets.public Boolean getPubliclyAccessible()
Permits connections from applications outside of the VPC that hosts the broker's subnets.
public AwsAmazonMqBrokerDetails withPubliclyAccessible(Boolean publiclyAccessible)
Permits connections from applications outside of the VPC that hosts the broker's subnets.
publiclyAccessible
- Permits connections from applications outside of the VPC that hosts the broker's subnets.public Boolean isPubliclyAccessible()
Permits connections from applications outside of the VPC that hosts the broker's subnets.
public List<String> getSecurityGroups()
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
public void setSecurityGroups(Collection<String> securityGroups)
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
securityGroups
- The list of rules (one minimum, 125 maximum) that authorize connections to brokers.public AwsAmazonMqBrokerDetails withSecurityGroups(String... securityGroups)
The list of rules (one minimum, 125 maximum) that authorize 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.
securityGroups
- The list of rules (one minimum, 125 maximum) that authorize connections to brokers.public AwsAmazonMqBrokerDetails withSecurityGroups(Collection<String> securityGroups)
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
securityGroups
- The list of rules (one minimum, 125 maximum) that authorize connections to brokers.public void setStorageType(String storageType)
The broker's storage type.
storageType
- The broker's storage type.public String getStorageType()
The broker's storage type.
public AwsAmazonMqBrokerDetails withStorageType(String storageType)
The broker's storage type.
storageType
- The broker's storage type.public List<String> getSubnetIds()
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
public void setSubnetIds(Collection<String> subnetIds)
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
subnetIds
- The list of groups that define which subnets and IP ranges the broker can use from different Availability
Zones.public AwsAmazonMqBrokerDetails withSubnetIds(String... subnetIds)
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
NOTE: This method appends the values to the existing list (if any). Use
setSubnetIds(java.util.Collection)
or withSubnetIds(java.util.Collection)
if you want to
override the existing values.
subnetIds
- The list of groups that define which subnets and IP ranges the broker can use from different Availability
Zones.public AwsAmazonMqBrokerDetails withSubnetIds(Collection<String> subnetIds)
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
subnetIds
- The list of groups that define which subnets and IP ranges the broker can use from different Availability
Zones.public List<AwsAmazonMqBrokerUsersDetails> getUsers()
The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
public void setUsers(Collection<AwsAmazonMqBrokerUsersDetails> users)
The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
users
- The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.public AwsAmazonMqBrokerDetails withUsers(AwsAmazonMqBrokerUsersDetails... users)
The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
NOTE: This method appends the values to the existing list (if any). Use
setUsers(java.util.Collection)
or withUsers(java.util.Collection)
if you want to override the
existing values.
users
- The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.public AwsAmazonMqBrokerDetails withUsers(Collection<AwsAmazonMqBrokerUsersDetails> users)
The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
users
- The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.public String toString()
toString
in class Object
Object.toString()
public AwsAmazonMqBrokerDetails clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.