Class CreateBrokerRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateBrokerRequest.Builder,
CreateBrokerRequest>
Creates a broker using the specified properties.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AuthenticationStrategy
Optional.final String
Optional.final Boolean
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.final String
Required.static CreateBrokerRequest.Builder
builder()
final ConfigurationId
A list of information about the configuration.final String
The unique ID that the requester receives for the created broker.final DataReplicationMode
Defines whether this broker is a part of a data replication pair.final String
Defines whether this broker is a part of a data replication pair.final String
The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker.final DeploymentMode
Required.final String
Required.final EncryptionOptions
Encryption options for the broker.final EngineType
Required.final String
Required.final String
Required.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroups property.final boolean
For responses, this returns true if the service returned a value for the SubnetIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
hasUsers()
For responses, this returns true if the service returned a value for the Users property.final String
Required.final LdapServerMetadataInput
Optional.final Logs
logs()
Enables Amazon CloudWatch logging for brokers.final WeeklyStartTime
The parameters that determine the WeeklyStartTime.final Boolean
Enables connections from applications outside of the VPC that hosts the broker's subnets.The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.static Class
<? extends CreateBrokerRequest.Builder> final BrokerStorageType
The broker's storage type.final String
The broker's storage type.The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.tags()
Create tags when creating the broker.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.users()
The list of broker users (persons or applications) who can access queues and topics.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
authenticationStrategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
If the service returns an enum value that is not available in the current SDK version,
authenticationStrategy
will returnAuthenticationStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationStrategyAsString()
.- Returns:
- Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
- See Also:
-
authenticationStrategyAsString
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
If the service returns an enum value that is not available in the current SDK version,
authenticationStrategy
will returnAuthenticationStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationStrategyAsString()
.- Returns:
- Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
- See Also:
-
autoMinorVersionUpgrade
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. 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.
-
brokerName
Required. The broker's name. This value must be unique in your Amazon Web Services 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.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.
- Returns:
- Required. The broker's name. This value must be unique in your Amazon Web Services 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.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.
-
configuration
A list of information about the configuration.
- Returns:
- A list of information about the configuration.
-
creatorRequestId
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.
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.
We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
-
deploymentMode
Required. The broker's deployment mode.
If the service returns an enum value that is not available in the current SDK version,
deploymentMode
will returnDeploymentMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentModeAsString()
.- Returns:
- Required. The broker's deployment mode.
- See Also:
-
deploymentModeAsString
Required. The broker's deployment mode.
If the service returns an enum value that is not available in the current SDK version,
deploymentMode
will returnDeploymentMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentModeAsString()
.- Returns:
- Required. The broker's deployment mode.
- See Also:
-
encryptionOptions
Encryption options for the broker.
- Returns:
- Encryption options for the broker.
-
engineType
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
If the service returns an enum value that is not available in the current SDK version,
engineType
will returnEngineType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromengineTypeAsString()
.- Returns:
- Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
- See Also:
-
engineTypeAsString
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
If the service returns an enum value that is not available in the current SDK version,
engineType
will returnEngineType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromengineTypeAsString()
.- Returns:
- Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
- See Also:
-
engineVersion
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.
-
hostInstanceType
Required. The broker's instance type.
- Returns:
- Required. The broker's instance type.
-
ldapServerMetadata
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- Returns:
- Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
-
logs
Enables Amazon CloudWatch logging for brokers.
- Returns:
- Enables Amazon CloudWatch logging for brokers.
-
maintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.
- Returns:
- The parameters that determine the WeeklyStartTime.
-
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:
- Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
-
hasSecurityGroups
public final boolean hasSecurityGroups()For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
securityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecurityGroups()
method.- Returns:
- The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
-
storageType
The broker's storage type.
If the service returns an enum value that is not available in the current SDK version,
storageType
will returnBrokerStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- The broker's storage type.
- See Also:
-
storageTypeAsString
The broker's storage type.
If the service returns an enum value that is not available in the current SDK version,
storageType
will returnBrokerStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- The broker's storage type.
- See Also:
-
hasSubnetIds
public final boolean hasSubnetIds()For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubnetIds()
method.- 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 Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Create tags when creating the broker.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Create tags when creating the broker.
-
hasUsers
public final boolean hasUsers()For responses, this returns true if the service returned a value for the Users property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
users
The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUsers()
method.- Returns:
- The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ 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.
-
dataReplicationMode
Defines whether this broker is a part of a data replication pair.
If the service returns an enum value that is not available in the current SDK version,
dataReplicationMode
will returnDataReplicationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataReplicationModeAsString()
.- Returns:
- Defines whether this broker is a part of a data replication pair.
- See Also:
-
dataReplicationModeAsString
Defines whether this broker is a part of a data replication pair.
If the service returns an enum value that is not available in the current SDK version,
dataReplicationMode
will returnDataReplicationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataReplicationModeAsString()
.- Returns:
- Defines whether this broker is a part of a data replication pair.
- See Also:
-
dataReplicationPrimaryBrokerArn
The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.
- Returns:
- The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateBrokerRequest.Builder,
CreateBrokerRequest> - Specified by:
toBuilder
in classMqRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-