GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::MQ::CreateBroker(3) User Contributed Perl Documentation Paws::MQ::CreateBroker(3)

Paws::MQ::CreateBroker - Arguments for method CreateBroker on Paws::MQ

This class represents the parameters used for calling the method CreateBroker on the AmazonMQ service. Use the attributes of this class as arguments to method CreateBroker.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBroker.

    my $mq = Paws->service('MQ');
    my $CreateBrokerResponse = $mq->CreateBroker(
      AuthenticationStrategy  => 'SIMPLE',        # OPTIONAL
      AutoMinorVersionUpgrade => 1,               # OPTIONAL
      BrokerName              => 'My__string',    # OPTIONAL
      Configuration           => {
        Id       => 'My__string',
        Revision => 1,                            # OPTIONAL
      },    # OPTIONAL
      CreatorRequestId  => 'My__string',         # OPTIONAL
      DeploymentMode    => 'SINGLE_INSTANCE',    # OPTIONAL
      EncryptionOptions => {
        UseAwsOwnedKey => 1,
        KmsKeyId       => 'My__string',
      },                                         # OPTIONAL
      EngineType         => 'ACTIVEMQ',          # OPTIONAL
      EngineVersion      => 'My__string',        # OPTIONAL
      HostInstanceType   => 'My__string',        # OPTIONAL
      LdapServerMetadata => {
        Hosts                  => [ 'My__string', ... ],    # OPTIONAL
        RoleBase               => 'My__string',
        RoleName               => 'My__string',
        RoleSearchMatching     => 'My__string',
        RoleSearchSubtree      => 1,
        ServiceAccountPassword => 'My__string',
        ServiceAccountUsername => 'My__string',
        UserBase               => 'My__string',
        UserRoleName           => 'My__string',
        UserSearchMatching     => 'My__string',
        UserSearchSubtree      => 1,
      },    # OPTIONAL
      Logs => {
        Audit   => 1,
        General => 1,
      },    # OPTIONAL
      MaintenanceWindowStartTime => {
        DayOfWeek => 'MONDAY'
        , # values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY; OPTIONAL
        TimeOfDay => 'My__string',
        TimeZone  => 'My__string',
      },    # OPTIONAL
      PubliclyAccessible => 1,                                    # OPTIONAL
      SecurityGroups     => [ 'My__string', ... ],                # OPTIONAL
      StorageType        => 'EBS',                                # OPTIONAL
      SubnetIds          => [ 'My__string', ... ],                # OPTIONAL
      Tags               => { 'My__string' => 'My__string', },    # OPTIONAL
      Users              => [
        {
          ConsoleAccess => 1,
          Groups        => [ 'My__string', ... ],                 # OPTIONAL
          Password      => 'My__string',
          Username      => 'My__string',
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $BrokerArn = $CreateBrokerResponse->BrokerArn;
    my $BrokerId  = $CreateBrokerResponse->BrokerId;
    # Returns a L<Paws::MQ::CreateBrokerResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/mq/CreateBroker>

The authentication strategy used to secure the broker.

Valid values are: "SIMPLE", "LDAP"

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.

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.

A list of information about the configuration.

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.

Required. The deployment mode of the broker.

Valid values are: "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ", "CLUSTER_MULTI_AZ"

Encryption options for the broker.

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

Valid values are: "ACTIVEMQ", "RABBITMQ"

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

Required. The broker's instance type.

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

Enables Amazon CloudWatch logging for brokers.

The parameters that determine the WeeklyStartTime.

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

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

The broker's storage type.

Valid values are: "EBS", "EFS"

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.

Create tags when creating the broker.

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.

This class forms part of Paws, documenting arguments for method CreateBroker in Paws::MQ

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.