software.amazon.awssdk.services.mq.model

Class CreateBrokerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mq.model.MqRequest

software.amazon.awssdk.services.mq.model.CreateBrokerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateBrokerRequest
extends MqRequest
implements ToCopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>

Creates a broker using the specified properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBrokerRequest.Builder

Method Summary

Modifier and Type	Method and Description
AuthenticationStrategy	authenticationStrategy() Optional.
String	authenticationStrategyAsString() Optional.
Boolean	autoMinorVersionUpgrade() Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
String	brokerName() Required.
static CreateBrokerRequest.Builder	builder()
ConfigurationId	configuration() A list of information about the configuration.
String	creatorRequestId() The unique ID that the requester receives for the created broker.
DataReplicationMode	dataReplicationMode() Defines whether this broker is a part of a data replication pair.
String	dataReplicationModeAsString() Defines whether this broker is a part of a data replication pair.
String	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.
DeploymentMode	deploymentMode() Required.
String	deploymentModeAsString() Required.
EncryptionOptions	encryptionOptions() Encryption options for the broker.
EngineType	engineType() Required.
String	engineTypeAsString() Required.
String	engineVersion() Required.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityGroups() For responses, this returns true if the service returned a value for the SecurityGroups property.
boolean	hasSubnetIds() For responses, this returns true if the service returned a value for the SubnetIds property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasUsers() For responses, this returns true if the service returned a value for the Users property.
String	hostInstanceType() Required.
LdapServerMetadataInput	ldapServerMetadata() Optional.
Logs	logs() Enables Amazon CloudWatch logging for brokers.
WeeklyStartTime	maintenanceWindowStartTime() The parameters that determine the WeeklyStartTime.
Boolean	publiclyAccessible() Enables connections from applications outside of the VPC that hosts the broker's subnets.
List<SdkField<?>>	sdkFields()
List<String>	securityGroups() The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
static Class<? extends CreateBrokerRequest.Builder>	serializableBuilderClass()
BrokerStorageType	storageType() The broker's storage type.
String	storageTypeAsString() The broker's storage type.
List<String>	subnetIds() The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
Map<String,String>	tags() Create tags when creating the broker.
CreateBrokerRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<User>	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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

authenticationStrategy

public final AuthenticationStrategy 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 return AuthenticationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationStrategyAsString().

Returns:

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

See Also:

AuthenticationStrategy

authenticationStrategyAsString

public final String 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 return AuthenticationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationStrategyAsString().

Returns:

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

See Also:

AuthenticationStrategy

autoMinorVersionUpgrade

public final 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.

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

public final String 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

public final ConfigurationId configuration()

A list of information about the configuration.

Returns:

A list of information about the configuration.

creatorRequestId

public final String 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

public final DeploymentMode 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 return DeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentModeAsString().

Returns:

Required. The broker's deployment mode.

See Also:

DeploymentMode

deploymentModeAsString

public final String 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 return DeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentModeAsString().

Returns:

Required. The broker's deployment mode.

See Also:

DeploymentMode

encryptionOptions

public final EncryptionOptions encryptionOptions()

Encryption options for the broker.

Returns:

Encryption options for the broker.

engineType

public final EngineType 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 return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().

Returns:

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

See Also:

EngineType

engineTypeAsString

public final String 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 return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().

Returns:

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

See Also:

EngineType

engineVersion

public final String 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

public final String hostInstanceType()

Required. The broker's instance type.

Returns:

Required. The broker's instance type.

ldapServerMetadata

public final LdapServerMetadataInput 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

public final Logs logs()

Enables Amazon CloudWatch logging for brokers.

Returns:

Enables Amazon CloudWatch logging for brokers.

maintenanceWindowStartTime

public final WeeklyStartTime maintenanceWindowStartTime()

The parameters that determine the WeeklyStartTime.

Returns:

The parameters that determine the WeeklyStartTime.

publiclyAccessible

public final 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.

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 the isEmpty() 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

public final List<String> 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

public final BrokerStorageType storageType()

The broker's storage type.

If the service returns an enum value that is not available in the current SDK version, storageType will return BrokerStorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

Returns:

The broker's storage type.

See Also:

BrokerStorageType

storageTypeAsString

public final String storageTypeAsString()

The broker's storage type.

If the service returns an enum value that is not available in the current SDK version, storageType will return BrokerStorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageTypeAsString().

Returns:

The broker's storage type.

See Also:

BrokerStorageType

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 the isEmpty() 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

public final List<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 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 the isEmpty() 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

public final Map<String,String> 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 the isEmpty() 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

public final List<User> 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

public final DataReplicationMode 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 return DataReplicationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataReplicationModeAsString().

Returns:

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

See Also:

DataReplicationMode

dataReplicationModeAsString

public final String 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 return DataReplicationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataReplicationModeAsString().

Returns:

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

See Also:

DataReplicationMode

dataReplicationPrimaryBrokerArn

public final String 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

public CreateBrokerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>

Specified by:

toBuilder in class MqRequest

builder

public static CreateBrokerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBrokerRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo