CreateBrokerRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateBrokerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationStrategy`	`authenticationStrategy()` The authentication strategy used to secure the broker.
`String`	`authenticationStrategyAsString()` The authentication strategy used to secure the broker.
`Boolean`	`autoMinorVersionUpgrade()` Required.
`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.
`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()` Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSubnetIds()` Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUsers()` Returns true if the Users property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`hostInstanceType()` Required.
`LdapServerMetadataInput`	`ldapServerMetadata()` The metadata of the LDAP server used to authenticate and authorize connections to the broker.
`Logs`	`logs()` Enables Amazon CloudWatch logging for brokers.
`WeeklyStartTime`	`maintenanceWindowStartTime()` The parameters that determine the WeeklyStartTime.
`Boolean`	`publiclyAccessible()` Required.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` The list of security groups (1 minimum, 5 maximum) that authorizes 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()` Required.

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()
```
    The authentication strategy used to secure the broker.
    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:
    
    The authentication strategy used to secure the broker.
    
    See Also:
    
    AuthenticationStrategy
  - authenticationStrategyAsString
```
public final String authenticationStrategyAsString()
```
    The authentication strategy used to secure the broker.
    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:
    
    The authentication strategy used to secure the broker.
    
    See Also:
    
    AuthenticationStrategy
  - autoMinorVersionUpgrade
```
public final Boolean 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.
    
    Returns:
    
    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.
  - brokerName
```
public final String 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.
    
    Returns:
    
    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.
  - 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. 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.
  - deploymentMode
```
public final DeploymentMode deploymentMode()
```
    Required. The deployment mode of the broker.
    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 deployment mode of the broker.
    
    See Also:
    
    DeploymentMode
  - deploymentModeAsString
```
public final String deploymentModeAsString()
```
    Required. The deployment mode of the broker.
    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 deployment mode of the broker.
    
    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. Note: 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. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    See Also:
    
    EngineType
  - engineTypeAsString
```
public final String engineTypeAsString()
```
    Required. The type of broker engine. Note: 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. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
    
    See Also:
    
    EngineType
  - engineVersion
```
public final String 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.html
    
    Returns:
    
    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.html
  - hostInstanceType
```
public final String hostInstanceType()
```
    Required. The broker's instance type.
    
    Returns:
    
    Required. The broker's instance type.
  - ldapServerMetadata
```
public final LdapServerMetadataInput ldapServerMetadata()
```
    The metadata of the LDAP server used to authenticate and authorize connections to the broker.
    
    Returns:
    
    The metadata of the LDAP server used to authenticate and authorize connections to the broker.
  - 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()
```
    Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
    
    Returns:
    
    Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroups
```
public final List<String> securityGroups()
```
    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    The list of security groups (1 minimum, 5 maximum) that authorizes 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()
```
    Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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. 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSubnetIds() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Create tags when creating the broker.
  - hasUsers
```
public final boolean hasUsers()
```
    Returns true if the Users property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - users
```
public final List<User> 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUsers() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - 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

Class CreateBrokerRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

authenticationStrategy

authenticationStrategyAsString

autoMinorVersionUpgrade

brokerName

configuration

creatorRequestId

deploymentMode

deploymentModeAsString

encryptionOptions

engineType

engineTypeAsString

engineVersion

hostInstanceType

ldapServerMetadata

logs

maintenanceWindowStartTime

publiclyAccessible

hasSecurityGroups

securityGroups

storageType

storageTypeAsString

hasSubnetIds

subnetIds

hasTags

tags

hasUsers

users

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields