CreateBrokerRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.mq.model.CreateBrokerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateBrokerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Creates a 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

CreateBrokerRequest()

Constructors
Constructor and Description
`CreateBrokerRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateBrokerRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreateBrokerRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateBrokerRequest`	`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 minor versions for brokers, as new versions are released and supported by Amazon MQ.
`String`	`getBrokerName()` Required.
`ConfigurationId`	`getConfiguration()` A list of information about the configuration.
`String`	`getCreatorRequestId()` The unique ID that the requester receives for the created broker.
`String`	`getDeploymentMode()` Required.
`EncryptionOptions`	`getEncryptionOptions()` Encryption options for the broker.
`String`	`getEngineType()` Required.
`String`	`getEngineVersion()` Required.
`String`	`getHostInstanceType()` Required.
`LdapServerMetadataInput`	`getLdapServerMetadata()` Optional.
`Logs`	`getLogs()` Enables Amazon CloudWatch logging for brokers.
`WeeklyStartTime`	`getMaintenanceWindowStartTime()` The parameters that determine the WeeklyStartTime.
`Boolean`	`getPubliclyAccessible()` Enables connections from applications outside of the VPC that hosts the broker's subnets.
`List<String>`	`getSecurityGroups()` The list of rules (1 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.
`Map<String,String>`	`getTags()` Create tags when creating the broker.
`List<User>`	`getUsers()` Required.
`int`	`hashCode()`
`Boolean`	`isAutoMinorVersionUpgrade()` Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`Boolean`	`isPubliclyAccessible()` Enables connections from applications outside of the VPC that hosts the broker's subnets.
`void`	`setAuthenticationStrategy(String authenticationStrategy)` Optional.
`void`	`setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`void`	`setBrokerName(String brokerName)` Required.
`void`	`setConfiguration(ConfigurationId configuration)` A list of information about the configuration.
`void`	`setCreatorRequestId(String creatorRequestId)` The unique ID that the requester receives for the created broker.
`void`	`setDeploymentMode(String deploymentMode)` Required.
`void`	`setEncryptionOptions(EncryptionOptions encryptionOptions)` Encryption options for the broker.
`void`	`setEngineType(String engineType)` Required.
`void`	`setEngineVersion(String engineVersion)` Required.
`void`	`setHostInstanceType(String hostInstanceType)` Required.
`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`	`setPubliclyAccessible(Boolean publiclyAccessible)` Enables connections from applications outside of the VPC that hosts the broker's subnets.
`void`	`setSecurityGroups(Collection<String> securityGroups)` The list of rules (1 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`	`setTags(Map<String,String> tags)` Create tags when creating the broker.
`void`	`setUsers(Collection<User> users)` Required.
`String`	`toString()` Returns a string representation of this object.
`CreateBrokerRequest`	`withAuthenticationStrategy(AuthenticationStrategy authenticationStrategy)` Optional.
`CreateBrokerRequest`	`withAuthenticationStrategy(String authenticationStrategy)` Optional.
`CreateBrokerRequest`	`withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`CreateBrokerRequest`	`withBrokerName(String brokerName)` Required.
`CreateBrokerRequest`	`withConfiguration(ConfigurationId configuration)` A list of information about the configuration.
`CreateBrokerRequest`	`withCreatorRequestId(String creatorRequestId)` The unique ID that the requester receives for the created broker.
`CreateBrokerRequest`	`withDeploymentMode(DeploymentMode deploymentMode)` Required.
`CreateBrokerRequest`	`withDeploymentMode(String deploymentMode)` Required.
`CreateBrokerRequest`	`withEncryptionOptions(EncryptionOptions encryptionOptions)` Encryption options for the broker.
`CreateBrokerRequest`	`withEngineType(EngineType engineType)` Required.
`CreateBrokerRequest`	`withEngineType(String engineType)` Required.
`CreateBrokerRequest`	`withEngineVersion(String engineVersion)` Required.
`CreateBrokerRequest`	`withHostInstanceType(String hostInstanceType)` Required.
`CreateBrokerRequest`	`withLdapServerMetadata(LdapServerMetadataInput ldapServerMetadata)` Optional.
`CreateBrokerRequest`	`withLogs(Logs logs)` Enables Amazon CloudWatch logging for brokers.
`CreateBrokerRequest`	`withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)` The parameters that determine the WeeklyStartTime.
`CreateBrokerRequest`	`withPubliclyAccessible(Boolean publiclyAccessible)` Enables connections from applications outside of the VPC that hosts the broker's subnets.
`CreateBrokerRequest`	`withSecurityGroups(Collection<String> securityGroups)` The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
`CreateBrokerRequest`	`withSecurityGroups(String... securityGroups)` The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
`CreateBrokerRequest`	`withStorageType(BrokerStorageType storageType)` The broker's storage type.
`CreateBrokerRequest`	`withStorageType(String storageType)` The broker's storage type.
`CreateBrokerRequest`	`withSubnetIds(Collection<String> subnetIds)` The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
`CreateBrokerRequest`	`withSubnetIds(String... subnetIds)` The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
`CreateBrokerRequest`	`withTags(Map<String,String> tags)` Create tags when creating the broker.
`CreateBrokerRequest`	`withUsers(Collection<User> users)` Required.
`CreateBrokerRequest`	`withUsers(User... users)` Required.

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

- Constructor Detail
  - CreateBrokerRequest
```
public CreateBrokerRequest()
```
- 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 CreateBrokerRequest 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 CreateBrokerRequest 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 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. Set to true by default, if no value is specified.
    
    Parameters:
    
    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. Set to true by default, if no value is specified.
  - getAutoMinorVersionUpgrade
```
public Boolean getAutoMinorVersionUpgrade()
```
    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. Set to true by default, if no value is specified.
    
    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. Set to true by default, if no value is specified.
  - withAutoMinorVersionUpgrade
```
public CreateBrokerRequest withAutoMinorVersionUpgrade(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. Set to true by default, if no value is specified.
    
    Parameters:
    
    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. Set to true by default, if no value is specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutoMinorVersionUpgrade
```
public Boolean isAutoMinorVersionUpgrade()
```
    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. Set to true by default, if no value is specified.
    
    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. Set to true by default, if no value is specified.
  - setBrokerName
```
public void setBrokerName(String brokerName)
```
    Required. The broker's name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
    
    Parameters:
    
    brokerName - Required. The broker's name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
  - getBrokerName
```
public String getBrokerName()
```
    Required. The broker's name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
    
    Returns:
    
    Required. The broker's name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
  - withBrokerName
```
public CreateBrokerRequest withBrokerName(String brokerName)
```
    Required. The broker's name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
    
    Parameters:
    
    brokerName - Required. The broker's name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
    
    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 CreateBrokerRequest 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.
  - setCreatorRequestId
```
public void setCreatorRequestId(String creatorRequestId)
```
    The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
    
    Parameters:
    
    creatorRequestId - The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
  - getCreatorRequestId
```
public String getCreatorRequestId()
```
    The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
    
    Returns:
    
    The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
  - withCreatorRequestId
```
public CreateBrokerRequest withCreatorRequestId(String creatorRequestId)
```
    The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
    
    Parameters:
    
    creatorRequestId - The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentMode
```
public void setDeploymentMode(String deploymentMode)
```
    Required. The broker's deployment mode.
    
    Parameters:
    
    deploymentMode - Required. The broker's deployment mode.
    
    See Also:
    
    DeploymentMode
  - getDeploymentMode
```
public String getDeploymentMode()
```
    Required. The broker's deployment mode.
    
    Returns:
    
    Required. The broker's deployment mode.
    
    See Also:
    
    DeploymentMode
  - withDeploymentMode
```
public CreateBrokerRequest withDeploymentMode(String deploymentMode)
```
    Required. The broker's deployment mode.
    
    Parameters:
    
    deploymentMode - Required. The broker's deployment mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentMode
  - withDeploymentMode
```
public CreateBrokerRequest withDeploymentMode(DeploymentMode deploymentMode)
```
    Required. The broker's deployment mode.
    
    Parameters:
    
    deploymentMode - Required. The broker's deployment mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentMode
  - setEncryptionOptions
```
public void setEncryptionOptions(EncryptionOptions encryptionOptions)
```
    Encryption options for the broker. Does not apply to RabbitMQ brokers.
    
    Parameters:
    
    encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.
  - getEncryptionOptions
```
public EncryptionOptions getEncryptionOptions()
```
    Encryption options for the broker. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Encryption options for the broker. Does not apply to RabbitMQ brokers.
  - withEncryptionOptions
```
public CreateBrokerRequest withEncryptionOptions(EncryptionOptions encryptionOptions)
```
    Encryption options for the broker. Does not apply to RabbitMQ brokers.
    
    Parameters:
    
    encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEngineType
```
public void setEngineType(String engineType)
```
    Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Parameters:
    
    engineType - Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    See Also:
    
    EngineType
  - getEngineType
```
public String getEngineType()
```
    Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Returns:
    
    Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    See Also:
    
    EngineType
  - withEngineType
```
public CreateBrokerRequest withEngineType(String engineType)
```
    Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Parameters:
    
    engineType - Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EngineType
  - withEngineType
```
public CreateBrokerRequest withEngineType(EngineType engineType)
```
    Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Parameters:
    
    engineType - Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EngineType
  - setEngineVersion
```
public void setEngineVersion(String engineVersion)
```
    Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
    
    Parameters:
    
    engineVersion - Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
  - getEngineVersion
```
public String getEngineVersion()
```
    Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
    
    Returns:
    
    Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
  - withEngineVersion
```
public CreateBrokerRequest withEngineVersion(String engineVersion)
```
    Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
    
    Parameters:
    
    engineVersion - Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostInstanceType
```
public void setHostInstanceType(String hostInstanceType)
```
    Required. The broker's instance type.
    
    Parameters:
    
    hostInstanceType - Required. The broker's instance type.
  - getHostInstanceType
```
public String getHostInstanceType()
```
    Required. The broker's instance type.
    
    Returns:
    
    Required. The broker's instance type.
  - withHostInstanceType
```
public CreateBrokerRequest withHostInstanceType(String hostInstanceType)
```
    Required. The broker's instance type.
    
    Parameters:
    
    hostInstanceType - Required. The broker's instance type.
    
    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 CreateBrokerRequest 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 CreateBrokerRequest 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 CreateBrokerRequest 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.
  - setPubliclyAccessible
```
public void setPubliclyAccessible(Boolean publiclyAccessible)
```
    Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
    
    Parameters:
    
    publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
  - getPubliclyAccessible
```
public Boolean getPubliclyAccessible()
```
    Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
    
    Returns:
    
    Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
  - withPubliclyAccessible
```
public CreateBrokerRequest withPubliclyAccessible(Boolean publiclyAccessible)
```
    Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
    
    Parameters:
    
    publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPubliclyAccessible
```
public Boolean isPubliclyAccessible()
```
    Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
    
    Returns:
    
    Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
  - getSecurityGroups
```
public List<String> getSecurityGroups()
```
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Returns:
    
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
  - setSecurityGroups
```
public void setSecurityGroups(Collection<String> securityGroups)
```
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Parameters:
    
    securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
  - withSecurityGroups
```
public CreateBrokerRequest withSecurityGroups(String... securityGroups)
```
    The list of rules (1 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.
    
    Parameters:
    
    securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroups
```
public CreateBrokerRequest withSecurityGroups(Collection<String> securityGroups)
```
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Parameters:
    
    securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageType
```
public void setStorageType(String storageType)
```
    The broker's storage type.
    
    Parameters:
    
    storageType - The broker's storage type.
    
    See Also:
    
    BrokerStorageType
  - getStorageType
```
public String getStorageType()
```
    The broker's storage type.
    
    Returns:
    
    The broker's storage type.
    
    See Also:
    
    BrokerStorageType
  - withStorageType
```
public CreateBrokerRequest withStorageType(String storageType)
```
    The broker's storage type.
    
    Parameters:
    
    storageType - The broker's storage type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrokerStorageType
  - withStorageType
```
public CreateBrokerRequest withStorageType(BrokerStorageType storageType)
```
    The broker's storage type.
    
    Parameters:
    
    storageType - The broker's storage type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrokerStorageType
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
    
    If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
    
    Returns:
    
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
    
    If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
  - setSubnetIds
```
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. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
    
    If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
    
    Parameters:
    
    subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
    
    If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
  - withSubnetIds
```
public CreateBrokerRequest withSubnetIds(String... subnetIds)
```
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
    
    If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
    
    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.
    
    Parameters:
    
    subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
    
    If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public CreateBrokerRequest withSubnetIds(Collection<String> subnetIds)
```
    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
    
    If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
    
    Parameters:
    
    subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
    
    If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Create tags when creating the broker.
    
    Returns:
    
    Create tags when creating the broker.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Create tags when creating the broker.
    
    Parameters:
    
    tags - Create tags when creating the broker.
  - withTags
```
public CreateBrokerRequest withTags(Map<String,String> tags)
```
    Create tags when creating the broker.
    
    Parameters:
    
    tags - Create tags when creating the broker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateBrokerRequest addTagsEntry(String key,
                                        String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateBrokerRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUsers
```
public List<User> getUsers()
```
    Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Amazon MQ for RabbitMQ
    When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
    
    Returns:
    
    Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Amazon MQ for RabbitMQ
    When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
  - setUsers
```
public void setUsers(Collection<User> users)
```
    Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Amazon MQ for RabbitMQ
    When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
    
    Parameters:
    
    users - Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Amazon MQ for RabbitMQ
    When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
  - withUsers
```
public CreateBrokerRequest withUsers(User... users)
```
    Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Amazon MQ for RabbitMQ
    When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
    
    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.
    
    Parameters:
    
    users - Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Amazon MQ for RabbitMQ
    When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUsers
```
public CreateBrokerRequest withUsers(Collection<User> users)
```
    Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Amazon MQ for RabbitMQ
    When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
    
    Parameters:
    
    users - Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Amazon MQ for RabbitMQ
    When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 CreateBrokerRequest 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()

Did this page help you?

Class CreateBrokerRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateBrokerRequest

Method Detail

setAuthenticationStrategy

getAuthenticationStrategy

withAuthenticationStrategy

withAuthenticationStrategy

setAutoMinorVersionUpgrade

getAutoMinorVersionUpgrade

withAutoMinorVersionUpgrade

isAutoMinorVersionUpgrade

setBrokerName

getBrokerName

withBrokerName

setConfiguration

getConfiguration

withConfiguration

setCreatorRequestId

getCreatorRequestId

withCreatorRequestId

setDeploymentMode

getDeploymentMode

withDeploymentMode

withDeploymentMode

setEncryptionOptions

getEncryptionOptions

withEncryptionOptions

setEngineType

getEngineType

withEngineType

withEngineType

setEngineVersion

getEngineVersion

withEngineVersion

setHostInstanceType

getHostInstanceType

withHostInstanceType

setLdapServerMetadata

getLdapServerMetadata

withLdapServerMetadata

setLogs

getLogs

withLogs

setMaintenanceWindowStartTime

getMaintenanceWindowStartTime

withMaintenanceWindowStartTime

setPubliclyAccessible

getPubliclyAccessible

withPubliclyAccessible

isPubliclyAccessible

getSecurityGroups

setSecurityGroups

withSecurityGroups

withSecurityGroups

setStorageType

getStorageType

withStorageType

withStorageType

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getUsers

setUsers

withUsers

withUsers

toString