Class: Aws::MQ::Types::CreateBrokerRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_strategy ⇒ String

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

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ Boolean

Returns:

  • (Boolean) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#broker_name ⇒ String

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::ConfigurationId

A list of information about the configuration.

Returns:



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#creator_request_id ⇒ String

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_replication_mode ⇒ String

Specifies whether a broker is a part of a data replication pair.

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_replication_primary_broker_arn ⇒ String

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_mode ⇒ String

The broker's deployment mode.

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_options ⇒ Types::EncryptionOptions

Encryption options for the broker.

Returns:



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_type ⇒ String

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#host_instance_type ⇒ String

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  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.

Returns:



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#logs ⇒ Types::Logs

The list of information about logs to be enabled for the specified broker.

Returns:



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_window_start_time ⇒ Types::WeeklyStartTime

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

Returns:



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

Returns:

  • (Boolean) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#security_groups ⇒ Array<String>

Returns:

  • (Array<String>) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

The broker's storage type.

EFS is not supported for RabbitMQ engine type.

Returns:

  • (String) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

Returns:

  • (Array<String>) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Returns:

  • (Hash<String,String>) 


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end

#users ⇒ Array<Types::User>

Returns:



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 688

class CreateBrokerRequest < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_name,
  :configuration,
  :creator_request_id,
  :deployment_mode,
  :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,
  :data_replication_mode,
  :data_replication_primary_broker_arn)
  SENSITIVE = []
  include Aws::Structure
end