Class: Aws::MQ::Types::CreateBrokerInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::MQ::Types::CreateBrokerInput
- Defined in:
- gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb
Overview
Creates a broker.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#authentication_strategy ⇒ String
Optional.
-
#auto_minor_version_upgrade ⇒ Boolean
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
-
#broker_name ⇒ String
Required.
-
#configuration ⇒ Types::ConfigurationId
A list of information about the configuration.
-
#creator_request_id ⇒ String
The unique ID that the requester receives for the created broker.
-
#data_replication_mode ⇒ String
Defines whether this broker is a part of a data replication pair.
-
#data_replication_primary_broker_arn ⇒ 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.
-
#deployment_mode ⇒ String
Required.
-
#encryption_options ⇒ Types::EncryptionOptions
Encryption options for the broker.
-
#engine_type ⇒ String
Required.
-
#engine_version ⇒ String
Required.
-
#host_instance_type ⇒ String
Required.
-
#ldap_server_metadata ⇒ Types::LdapServerMetadataInput
Optional.
-
#logs ⇒ Types::Logs
Enables Amazon CloudWatch logging for brokers.
-
#maintenance_window_start_time ⇒ Types::WeeklyStartTime
The parameters that determine the WeeklyStartTime.
-
#publicly_accessible ⇒ Boolean
Enables connections from applications outside of the VPC that hosts the broker's subnets.
-
#security_groups ⇒ Array<String>
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
-
#storage_type ⇒ String
The broker's storage type.
-
#subnet_ids ⇒ Array<String>
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
-
#tags ⇒ Hash<String,String>
Create tags when creating the broker.
-
#users ⇒ Array<Types::User>
The list of broker users (persons or applications) who can access queues and topics.
Instance Attribute Details
#authentication_strategy ⇒ String
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#auto_minor_version_upgrade ⇒ Boolean
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.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#broker_name ⇒ String
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.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#configuration ⇒ Types::ConfigurationId
A list of information about the configuration.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#creator_request_id ⇒ String
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.
A suitable default value is auto-generated. You should normally not need to pass this option.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#data_replication_mode ⇒ String
Defines whether this broker is a part of a data replication pair.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#data_replication_primary_broker_arn ⇒ 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. Must be set when dataReplicationMode is set to CRDR.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#deployment_mode ⇒ String
Required. The broker's deployment mode.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#encryption_options ⇒ Types::EncryptionOptions
Encryption options for the broker.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#engine_type ⇒ String
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#engine_version ⇒ String
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#host_instance_type ⇒ String
Required. The broker's instance type.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#ldap_server_metadata ⇒ Types::LdapServerMetadataInput
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#logs ⇒ Types::Logs
Enables Amazon CloudWatch logging for brokers.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#maintenance_window_start_time ⇒ Types::WeeklyStartTime
The parameters that determine the WeeklyStartTime.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#publicly_accessible ⇒ Boolean
Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#security_groups ⇒ Array<String>
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#storage_type ⇒ String
The broker's storage type.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#subnet_ids ⇒ Array<String>
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.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
Create tags when creating the broker.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |
#users ⇒ Array<Types::User>
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.
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 558 class CreateBrokerInput < Struct.new( :authentication_strategy, :auto_minor_version_upgrade, :broker_name, :configuration, :creator_request_id, :deployment_mode, :data_replication_mode, :data_replication_primary_broker_arn, :encryption_options, :engine_type, :engine_version, :host_instance_type, :ldap_server_metadata, :logs, :maintenance_window_start_time, :publicly_accessible, :security_groups, :storage_type, :subnet_ids, :tags, :users) SENSITIVE = [] include Aws::Structure end |