@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateBrokerRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateBrokerRequest() |
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()
The authentication strategy used to secure the broker.
|
Boolean |
getAutoMinorVersionUpgrade()
Required.
|
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()
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
|
Logs |
getLogs()
Enables Amazon CloudWatch logging for brokers.
|
WeeklyStartTime |
getMaintenanceWindowStartTime()
The parameters that determine the WeeklyStartTime.
|
Boolean |
getPubliclyAccessible()
Required.
|
List<String> |
getSecurityGroups()
The list of security groups (1 minimum, 5 maximum) that authorizes 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()
Required.
|
Boolean |
isPubliclyAccessible()
Required.
|
void |
setAuthenticationStrategy(String authenticationStrategy)
The authentication strategy used to secure the broker.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Required.
|
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)
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
|
void |
setLogs(Logs logs)
Enables Amazon CloudWatch logging for brokers.
|
void |
setMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
The parameters that determine the WeeklyStartTime.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Required.
|
void |
setSecurityGroups(Collection<String> securityGroups)
The list of security groups (1 minimum, 5 maximum) that authorizes 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)
The authentication strategy used to secure the broker.
|
CreateBrokerRequest |
withAuthenticationStrategy(String authenticationStrategy)
The authentication strategy used to secure the broker.
|
CreateBrokerRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Required.
|
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)
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
|
CreateBrokerRequest |
withLogs(Logs logs)
Enables Amazon CloudWatch logging for brokers.
|
CreateBrokerRequest |
withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
The parameters that determine the WeeklyStartTime.
|
CreateBrokerRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Required.
|
CreateBrokerRequest |
withSecurityGroups(Collection<String> securityGroups)
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
|
CreateBrokerRequest |
withSecurityGroups(String... securityGroups)
The list of security groups (1 minimum, 5 maximum) that authorizes 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.
|
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
public void setAuthenticationStrategy(String authenticationStrategy)
authenticationStrategy
- The authentication strategy used to secure the broker.AuthenticationStrategy
public String getAuthenticationStrategy()
AuthenticationStrategy
public CreateBrokerRequest withAuthenticationStrategy(String authenticationStrategy)
authenticationStrategy
- The authentication strategy used to secure the broker.AuthenticationStrategy
public CreateBrokerRequest withAuthenticationStrategy(AuthenticationStrategy authenticationStrategy)
authenticationStrategy
- The authentication strategy used to secure the broker.AuthenticationStrategy
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
autoMinorVersionUpgrade
- Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.
The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.public Boolean getAutoMinorVersionUpgrade()
public CreateBrokerRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
autoMinorVersionUpgrade
- Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.
The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.public Boolean isAutoMinorVersionUpgrade()
public void setBrokerName(String brokerName)
brokerName
- Required. The name of the broker. 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 whitespaces, brackets,
wildcard characters, or special characters.public String getBrokerName()
public CreateBrokerRequest withBrokerName(String brokerName)
brokerName
- Required. The name of the broker. 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 whitespaces, brackets,
wildcard characters, or special characters.public void setConfiguration(ConfigurationId configuration)
configuration
- A list of information about the configuration.public ConfigurationId getConfiguration()
public CreateBrokerRequest withConfiguration(ConfigurationId configuration)
configuration
- A list of information about the configuration.public void setCreatorRequestId(String creatorRequestId)
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.public String getCreatorRequestId()
public CreateBrokerRequest withCreatorRequestId(String creatorRequestId)
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.public void setDeploymentMode(String deploymentMode)
deploymentMode
- Required. The deployment mode of the broker.DeploymentMode
public String getDeploymentMode()
DeploymentMode
public CreateBrokerRequest withDeploymentMode(String deploymentMode)
deploymentMode
- Required. The deployment mode of the broker.DeploymentMode
public CreateBrokerRequest withDeploymentMode(DeploymentMode deploymentMode)
deploymentMode
- Required. The deployment mode of the broker.DeploymentMode
public void setEncryptionOptions(EncryptionOptions encryptionOptions)
encryptionOptions
- Encryption options for the broker.public EncryptionOptions getEncryptionOptions()
public CreateBrokerRequest withEncryptionOptions(EncryptionOptions encryptionOptions)
encryptionOptions
- Encryption options for the broker.public void setEngineType(String engineType)
engineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.EngineType
public String getEngineType()
EngineType
public CreateBrokerRequest withEngineType(String engineType)
engineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.EngineType
public CreateBrokerRequest withEngineType(EngineType engineType)
engineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.EngineType
public void setEngineVersion(String engineVersion)
engineVersion
- Required. The version of the broker engine. For a list of supported engine versions, see
https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.htmlpublic String getEngineVersion()
public CreateBrokerRequest withEngineVersion(String engineVersion)
engineVersion
- Required. The version of the broker engine. For a list of supported engine versions, see
https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.htmlpublic void setHostInstanceType(String hostInstanceType)
hostInstanceType
- Required. The broker's instance type.public String getHostInstanceType()
public CreateBrokerRequest withHostInstanceType(String hostInstanceType)
hostInstanceType
- Required. The broker's instance type.public void setLdapServerMetadata(LdapServerMetadataInput ldapServerMetadata)
ldapServerMetadata
- The metadata of the LDAP server used to authenticate and authorize connections to the broker.public LdapServerMetadataInput getLdapServerMetadata()
public CreateBrokerRequest withLdapServerMetadata(LdapServerMetadataInput ldapServerMetadata)
ldapServerMetadata
- The metadata of the LDAP server used to authenticate and authorize connections to the broker.public void setLogs(Logs logs)
logs
- Enables Amazon CloudWatch logging for brokers.public Logs getLogs()
public CreateBrokerRequest withLogs(Logs logs)
logs
- Enables Amazon CloudWatch logging for brokers.public void setMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
maintenanceWindowStartTime
- The parameters that determine the WeeklyStartTime.public WeeklyStartTime getMaintenanceWindowStartTime()
public CreateBrokerRequest withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
maintenanceWindowStartTime
- The parameters that determine the WeeklyStartTime.public void setPubliclyAccessible(Boolean publiclyAccessible)
publiclyAccessible
- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.public Boolean getPubliclyAccessible()
public CreateBrokerRequest withPubliclyAccessible(Boolean publiclyAccessible)
publiclyAccessible
- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.public Boolean isPubliclyAccessible()
public List<String> getSecurityGroups()
public void setSecurityGroups(Collection<String> securityGroups)
securityGroups
- The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.public CreateBrokerRequest withSecurityGroups(String... securityGroups)
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 security groups (1 minimum, 5 maximum) that authorizes connections to brokers.public CreateBrokerRequest withSecurityGroups(Collection<String> securityGroups)
securityGroups
- The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.public void setStorageType(String storageType)
storageType
- The broker's storage type.BrokerStorageType
public String getStorageType()
BrokerStorageType
public CreateBrokerRequest withStorageType(String storageType)
storageType
- The broker's storage type.BrokerStorageType
public CreateBrokerRequest withStorageType(BrokerStorageType storageType)
storageType
- The broker's storage type.BrokerStorageType
public List<String> getSubnetIds()
public void setSubnetIds(Collection<String> subnetIds)
subnetIds
- The list of groups that define which subnets and IP ranges the broker can use from different Availability
Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An
ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment
(RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public
accessibility requires at least one subnet.public CreateBrokerRequest withSubnetIds(String... subnetIds)
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. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An
ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment
(RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public
accessibility requires at least one subnet.public CreateBrokerRequest withSubnetIds(Collection<String> subnetIds)
subnetIds
- The list of groups that define which subnets and IP ranges the broker can use from different Availability
Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An
ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment
(RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public
accessibility requires at least one subnet.public Map<String,String> getTags()
public void setTags(Map<String,String> tags)
tags
- Create tags when creating the broker.public CreateBrokerRequest withTags(Map<String,String> tags)
tags
- Create tags when creating the broker.public CreateBrokerRequest addTagsEntry(String key, String value)
public CreateBrokerRequest clearTagsEntries()
public List<User> getUsers()
public void setUsers(Collection<User> users)
users
- Required. The list of broker users (persons or applications) who can access queues and topics. For
RabbitMQ brokers, 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. This value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters long.public CreateBrokerRequest withUsers(User... users)
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
- Required. The list of broker users (persons or applications) who can access queues and topics. For
RabbitMQ brokers, 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. This value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters long.public CreateBrokerRequest withUsers(Collection<User> users)
users
- Required. The list of broker users (persons or applications) who can access queues and topics. For
RabbitMQ brokers, 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. This value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters long.public String toString()
toString
in class Object
Object.toString()
public CreateBrokerRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()