Package software.amazon.awssdk.services.mq.model

Interface DescribeBrokerResponse.Builder

    • Method Detail

      • actionsRequired

        DescribeBrokerResponse.Builder actionsRequired​(Collection<ActionRequired> actionsRequired)

        Actions required for a broker.

        Parameters:
        actionsRequired - Actions required for a broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actionsRequired

        DescribeBrokerResponse.Builder actionsRequired​(ActionRequired... actionsRequired)

        Actions required for a broker.

        Parameters:
        actionsRequired - Actions required for a broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authenticationStrategy

        DescribeBrokerResponse.Builder authenticationStrategy​(String authenticationStrategy)

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

        Parameters:
        authenticationStrategy - 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, AuthenticationStrategy

      • autoMinorVersionUpgrade

        DescribeBrokerResponse.Builder autoMinorVersionUpgrade​(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.

        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • brokerArn

        DescribeBrokerResponse.Builder brokerArn​(String brokerArn)

        The broker's Amazon Resource Name (ARN).

        Parameters:
        brokerArn - The broker's Amazon Resource Name (ARN).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • brokerId

        DescribeBrokerResponse.Builder brokerId​(String brokerId)

        The unique ID that Amazon MQ generates for the broker.

        Parameters:
        brokerId - The unique ID that Amazon MQ generates for the broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • brokerInstances

        DescribeBrokerResponse.Builder brokerInstances​(Collection<BrokerInstance> brokerInstances)

        A list of information about allocated brokers.

        Parameters:
        brokerInstances - A list of information about allocated brokers.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • brokerInstances

        DescribeBrokerResponse.Builder brokerInstances​(BrokerInstance... brokerInstances)

        A list of information about allocated brokers.

        Parameters:
        brokerInstances - A list of information about allocated brokers.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • brokerName

        DescribeBrokerResponse.Builder brokerName​(String brokerName)

        The broker's name. This value must be unique in your Amazon Web Services account 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 - The broker's name. This value must be unique in your Amazon Web Services account 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.

      • configurations

        DescribeBrokerResponse.Builder configurations​(Configurations configurations)

        The list of all revisions for the specified configuration.

        Parameters:
        configurations - The list of all revisions for the specified configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • created

        DescribeBrokerResponse.Builder created​(Instant created)

        The time when the broker was created.

        Parameters:
        created - The time when the broker was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encryptionOptions

        DescribeBrokerResponse.Builder encryptionOptions​(EncryptionOptions encryptionOptions)

        Encryption options for the broker.

        Parameters:
        encryptionOptions - Encryption options for the broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineType

        DescribeBrokerResponse.Builder engineType​(String engineType)

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

        Parameters:
        engineType - 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, EngineType

      • engineType

        DescribeBrokerResponse.Builder engineType​(EngineType engineType)

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

        Parameters:
        engineType - 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, EngineType

      • engineVersion

        DescribeBrokerResponse.Builder engineVersion​(String engineVersion)

        The broker engine's version. For a list of supported engine versions, see Supported engines.

        Parameters:
        engineVersion - 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.

      • hostInstanceType

        DescribeBrokerResponse.Builder hostInstanceType​(String hostInstanceType)

        The broker's instance type.

        Parameters:
        hostInstanceType - The broker's instance type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ldapServerMetadata

        DescribeBrokerResponse.Builder ldapServerMetadata​(LdapServerMetadataOutput ldapServerMetadata)

        The metadata of the LDAP server used to authenticate and authorize connections to the broker.

        Parameters:
        ldapServerMetadata - The metadata of the LDAP server used to authenticate and authorize connections to the broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logs

        DescribeBrokerResponse.Builder logs​(LogsSummary logs)

        The list of information about logs currently enabled and pending to be deployed for the specified broker.

        Parameters:
        logs - The list of information about logs currently enabled and pending to be deployed for the specified broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maintenanceWindowStartTime

        DescribeBrokerResponse.Builder maintenanceWindowStartTime​(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.

      • pendingAuthenticationStrategy

        DescribeBrokerResponse.Builder pendingAuthenticationStrategy​(String pendingAuthenticationStrategy)

        The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

        Parameters:
        pendingAuthenticationStrategy - The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthenticationStrategy, AuthenticationStrategy

      • pendingAuthenticationStrategy

        DescribeBrokerResponse.Builder pendingAuthenticationStrategy​(AuthenticationStrategy pendingAuthenticationStrategy)

        The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

        Parameters:
        pendingAuthenticationStrategy - The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthenticationStrategy, AuthenticationStrategy

      • pendingEngineVersion

        DescribeBrokerResponse.Builder pendingEngineVersion​(String pendingEngineVersion)

        The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

        Parameters:
        pendingEngineVersion - The broker engine version to upgrade to. 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.

      • pendingHostInstanceType

        DescribeBrokerResponse.Builder pendingHostInstanceType​(String pendingHostInstanceType)

        The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

        Parameters:
        pendingHostInstanceType - The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingLdapServerMetadata

        DescribeBrokerResponse.Builder pendingLdapServerMetadata​(LdapServerMetadataOutput pendingLdapServerMetadata)

        The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

        Parameters:
        pendingLdapServerMetadata - The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingSecurityGroups

        DescribeBrokerResponse.Builder pendingSecurityGroups​(Collection<String> pendingSecurityGroups)

        The list of pending security groups to authorize connections to brokers.

        Parameters:
        pendingSecurityGroups - The list of pending security groups to authorize connections to brokers.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingSecurityGroups

        DescribeBrokerResponse.Builder pendingSecurityGroups​(String... pendingSecurityGroups)

        The list of pending security groups to authorize connections to brokers.

        Parameters:
        pendingSecurityGroups - The list of pending security groups to authorize connections to brokers.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publiclyAccessible

        DescribeBrokerResponse.Builder publiclyAccessible​(Boolean publiclyAccessible)

        Enables connections from applications outside of the VPC that hosts the broker's subnets.

        Parameters:
        publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroups

        DescribeBrokerResponse.Builder securityGroups​(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.

      • securityGroups

        DescribeBrokerResponse.Builder securityGroups​(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.

      • subnetIds

        DescribeBrokerResponse.Builder subnetIds​(Collection<String> subnetIds)

        The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

        Parameters:
        subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subnetIds

        DescribeBrokerResponse.Builder subnetIds​(String... subnetIds)

        The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

        Parameters:
        subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        DescribeBrokerResponse.Builder tags​(Map<String,​String> tags)

        The list of all tags associated with this broker.

        Parameters:
        tags - The list of all tags associated with this broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • users

        DescribeBrokerResponse.Builder users​(Collection<UserSummary> users)

        The list of all broker usernames for the specified broker.

        Parameters:
        users - The list of all broker usernames for the specified broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • users

        DescribeBrokerResponse.Builder users​(UserSummary... users)

        The list of all broker usernames for the specified broker.

        Parameters:
        users - The list of all broker usernames for the specified broker.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataReplicationMetadata

        DescribeBrokerResponse.Builder dataReplicationMetadata​(DataReplicationMetadataOutput dataReplicationMetadata)

        The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

        Parameters:
        dataReplicationMetadata - The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataReplicationMode

        DescribeBrokerResponse.Builder dataReplicationMode​(String dataReplicationMode)

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

        Parameters:
        dataReplicationMode - Describes whether this broker is a part of a data replication pair.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataReplicationMode, DataReplicationMode

      • pendingDataReplicationMetadata

        DescribeBrokerResponse.Builder pendingDataReplicationMetadata​(DataReplicationMetadataOutput pendingDataReplicationMetadata)

        The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

        Parameters:
        pendingDataReplicationMetadata - The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingDataReplicationMode

        DescribeBrokerResponse.Builder pendingDataReplicationMode​(String pendingDataReplicationMode)

        Describes whether this broker will be a part of a data replication pair after reboot.

        Parameters:
        pendingDataReplicationMode - Describes whether this broker will be a part of a data replication pair after reboot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataReplicationMode, DataReplicationMode

      • pendingDataReplicationMode

        DescribeBrokerResponse.Builder pendingDataReplicationMode​(DataReplicationMode pendingDataReplicationMode)

        Describes whether this broker will be a part of a data replication pair after reboot.

        Parameters:
        pendingDataReplicationMode - Describes whether this broker will be a part of a data replication pair after reboot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataReplicationMode, DataReplicationMode