We recommend new projects start with resources from the AWS provider.
aws-native.amazonmq.getBroker
We recommend new projects start with resources from the AWS provider.
Resource type definition for AWS::AmazonMQ::Broker
Using getBroker
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBroker(args: GetBrokerArgs, opts?: InvokeOptions): Promise<GetBrokerResult>
function getBrokerOutput(args: GetBrokerOutputArgs, opts?: InvokeOptions): Output<GetBrokerResult>def get_broker(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBrokerResult
def get_broker_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBrokerResult]func LookupBroker(ctx *Context, args *LookupBrokerArgs, opts ...InvokeOption) (*LookupBrokerResult, error)
func LookupBrokerOutput(ctx *Context, args *LookupBrokerOutputArgs, opts ...InvokeOption) LookupBrokerResultOutput> Note: This function is named LookupBroker in the Go SDK.
public static class GetBroker
{
public static Task<GetBrokerResult> InvokeAsync(GetBrokerArgs args, InvokeOptions? opts = null)
public static Output<GetBrokerResult> Invoke(GetBrokerInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetBrokerResult> getBroker(GetBrokerArgs args, InvokeOptions options)
public static Output<GetBrokerResult> getBroker(GetBrokerArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:amazonmq:getBroker
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- Required. The unique ID that Amazon MQ generates for the configuration.
- Id string
- Required. The unique ID that Amazon MQ generates for the configuration.
- id String
- Required. The unique ID that Amazon MQ generates for the configuration.
- id string
- Required. The unique ID that Amazon MQ generates for the configuration.
- id str
- Required. The unique ID that Amazon MQ generates for the configuration.
- id String
- Required. The unique ID that Amazon MQ generates for the configuration.
getBroker Result
The following output properties are available:
- Amqp
Endpoints List<string> The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- Arn string
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- Auto
Minor boolVersion Upgrade - Enables automatic upgrades to new minor versions for brokers, as new broker engine 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.
- Configuration
Id string - The ID of the current actual configuration.
- Configuration
Revision string - The revision of the current actual configuration.
- Console
Urls List<string> - Data
Replication Pulumi.Mode Aws | stringNative. Amazon Mq. Broker Data Replication Mode - Defines whether this broker is a part of a data replication pair.
- Engine
Version stringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- Host
Instance stringType - The broker's instance type.
- Id string
- Required. The unique ID that Amazon MQ generates for the configuration.
- Ip
Addresses List<string> The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- Ldap
Server Pulumi.Metadata Aws Native. Amazon Mq. Outputs. Broker Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- Logs
Pulumi.
Aws Native. Amazon Mq. Outputs. Broker Log List - Enables Amazon CloudWatch logging for brokers.
- Maintenance
Window Pulumi.Start Time Aws Native. Amazon Mq. Outputs. Broker Maintenance Window - The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
- Mqtt
Endpoints List<string> The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- Open
Wire List<string>Endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- Security
Groups List<string> - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- Stomp
Endpoints List<string> The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614-
List<Pulumi.
Aws Native. Outputs. Tag> - An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- Wss
Endpoints List<string> The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- Amqp
Endpoints []string The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- Arn string
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- Auto
Minor boolVersion Upgrade - Enables automatic upgrades to new minor versions for brokers, as new broker engine 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.
- Configuration
Id string - The ID of the current actual configuration.
- Configuration
Revision string - The revision of the current actual configuration.
- Console
Urls []string - Data
Replication BrokerMode Data | stringReplication Mode - Defines whether this broker is a part of a data replication pair.
- Engine
Version stringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- Host
Instance stringType - The broker's instance type.
- Id string
- Required. The unique ID that Amazon MQ generates for the configuration.
- Ip
Addresses []string The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- Ldap
Server BrokerMetadata Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- Logs
Broker
Log List - Enables Amazon CloudWatch logging for brokers.
- Maintenance
Window BrokerStart Time Maintenance Window - The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
- Mqtt
Endpoints []string The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- Open
Wire []stringEndpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- Security
Groups []string - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- Stomp
Endpoints []string The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- Tag
- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- Wss
Endpoints []string The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- amqp
Endpoints List<String> The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- arn String
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- auto
Minor BooleanVersion Upgrade - Enables automatic upgrades to new minor versions for brokers, as new broker engine 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.
- configuration
Id String - The ID of the current actual configuration.
- configuration
Revision String - The revision of the current actual configuration.
- console
Urls List<String> - data
Replication BrokerMode Data | StringReplication Mode - Defines whether this broker is a part of a data replication pair.
- engine
Version StringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- host
Instance StringType - The broker's instance type.
- id String
- Required. The unique ID that Amazon MQ generates for the configuration.
- ip
Addresses List<String> The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- ldap
Server BrokerMetadata Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- logs
Broker
Log List - Enables Amazon CloudWatch logging for brokers.
- maintenance
Window BrokerStart Time Maintenance Window - The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
- mqtt
Endpoints List<String> The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- open
Wire List<String>Endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- security
Groups List<String> - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stomp
Endpoints List<String> The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- List<Tag>
- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- wss
Endpoints List<String> The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- amqp
Endpoints string[] The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- arn string
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- auto
Minor booleanVersion Upgrade - Enables automatic upgrades to new minor versions for brokers, as new broker engine 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.
- configuration
Id string - The ID of the current actual configuration.
- configuration
Revision string - The revision of the current actual configuration.
- console
Urls string[] - data
Replication BrokerMode Data | stringReplication Mode - Defines whether this broker is a part of a data replication pair.
- engine
Version stringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- host
Instance stringType - The broker's instance type.
- id string
- Required. The unique ID that Amazon MQ generates for the configuration.
- ip
Addresses string[] The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- ldap
Server BrokerMetadata Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- logs
Broker
Log List - Enables Amazon CloudWatch logging for brokers.
- maintenance
Window BrokerStart Time Maintenance Window - The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
- mqtt
Endpoints string[] The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- open
Wire string[]Endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- security
Groups string[] - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stomp
Endpoints string[] The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- Tag[]
- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- wss
Endpoints string[] The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- amqp_
endpoints Sequence[str] The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- arn str
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- auto_
minor_ boolversion_ upgrade - Enables automatic upgrades to new minor versions for brokers, as new broker engine 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.
- configuration_
id str - The ID of the current actual configuration.
- configuration_
revision str - The revision of the current actual configuration.
- console_
urls Sequence[str] - data_
replication_ Brokermode Data | strReplication Mode - Defines whether this broker is a part of a data replication pair.
- engine_
version_ strcurrent - The version in use. This may have more precision than the specified EngineVersion.
- host_
instance_ strtype - The broker's instance type.
- id str
- Required. The unique ID that Amazon MQ generates for the configuration.
- ip_
addresses Sequence[str] The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- ldap_
server_ Brokermetadata Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- logs
Broker
Log List - Enables Amazon CloudWatch logging for brokers.
- maintenance_
window_ Brokerstart_ time Maintenance Window - The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
- mqtt_
endpoints Sequence[str] The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- open_
wire_ Sequence[str]endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- security_
groups Sequence[str] - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stomp_
endpoints Sequence[str] The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- Sequence[root_Tag]
- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- wss_
endpoints Sequence[str] The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- amqp
Endpoints List<String> The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- arn String
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- auto
Minor BooleanVersion Upgrade - Enables automatic upgrades to new minor versions for brokers, as new broker engine 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.
- configuration
Id String - The ID of the current actual configuration.
- configuration
Revision String - The revision of the current actual configuration.
- console
Urls List<String> - data
Replication "NONE" | "CRDR" | StringMode - Defines whether this broker is a part of a data replication pair.
- engine
Version StringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- host
Instance StringType - The broker's instance type.
- id String
- Required. The unique ID that Amazon MQ generates for the configuration.
- ip
Addresses List<String> The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- ldap
Server Property MapMetadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- logs Property Map
- Enables Amazon CloudWatch logging for brokers.
- maintenance
Window Property MapStart Time - The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
- mqtt
Endpoints List<String> The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- open
Wire List<String>Endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- security
Groups List<String> - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stomp
Endpoints List<String> The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- List<Property Map>
- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- wss
Endpoints List<String> The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
Supporting Types
BrokerDataReplicationMode
BrokerLdapServerMetadata
- Hosts List<string>
- Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
- Role
Base string - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example,
ou=group,ou=corp,dc=corp,dc=example,dc=com. - Role
Search stringMatching - The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the
{0}placeholder in the search filter. The client's username is substituted into the{1}placeholder. For example, if you set this option to(member=uid={1})for the user janedoe, the search filter becomes(member=uid=janedoe)after string substitution. It matches all role entries that have a member attribute equal touid=janedoeunder the subtree selected by theRoleBases. - Service
Account stringUsername - Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,ou=corp,dc=corp,dc=example,dc=com. - User
Base string - Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to
ou=Users,ou=corp,dc=corp,dc=example,dc=com, the search for user entries is restricted to the subtree beneathou=Users,ou=corp,dc=corp,dc=example,dc=com. - User
Search stringMatching - The LDAP search filter used to find users within the
userBase. The client's username is substituted into the{0}placeholder in the search filter. For example, if this option is set to(uid={0})and the received username isjanedoe, the search filter becomes(uid=janedoe)after string substitution. It will result in matching an entry likeuid=janedoe,ou=Users,ou=corp,dc=corp,dc=example,dc=com. - Role
Name string - The group name attribute in a role entry whose value is the name of that role. For example, you can specify
cnfor a group entry's common name. If authentication succeeds, then the user is assigned the the value of thecnattribute for each role entry that they are a member of. - Role
Search boolSubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
- Service
Account stringPassword - Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,dc=corp,dc=example,dc=com. - User
Role stringName - The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The
UserRoleNameoption allows you to provide the name of this attribute. - User
Search boolSubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
- Hosts []string
- Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
- Role
Base string - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example,
ou=group,ou=corp,dc=corp,dc=example,dc=com. - Role
Search stringMatching - The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the
{0}placeholder in the search filter. The client's username is substituted into the{1}placeholder. For example, if you set this option to(member=uid={1})for the user janedoe, the search filter becomes(member=uid=janedoe)after string substitution. It matches all role entries that have a member attribute equal touid=janedoeunder the subtree selected by theRoleBases. - Service
Account stringUsername - Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,ou=corp,dc=corp,dc=example,dc=com. - User
Base string - Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to
ou=Users,ou=corp,dc=corp,dc=example,dc=com, the search for user entries is restricted to the subtree beneathou=Users,ou=corp,dc=corp,dc=example,dc=com. - User
Search stringMatching - The LDAP search filter used to find users within the
userBase. The client's username is substituted into the{0}placeholder in the search filter. For example, if this option is set to(uid={0})and the received username isjanedoe, the search filter becomes(uid=janedoe)after string substitution. It will result in matching an entry likeuid=janedoe,ou=Users,ou=corp,dc=corp,dc=example,dc=com. - Role
Name string - The group name attribute in a role entry whose value is the name of that role. For example, you can specify
cnfor a group entry's common name. If authentication succeeds, then the user is assigned the the value of thecnattribute for each role entry that they are a member of. - Role
Search boolSubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
- Service
Account stringPassword - Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,dc=corp,dc=example,dc=com. - User
Role stringName - The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The
UserRoleNameoption allows you to provide the name of this attribute. - User
Search boolSubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
- hosts List<String>
- Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
- role
Base String - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example,
ou=group,ou=corp,dc=corp,dc=example,dc=com. - role
Search StringMatching - The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the
{0}placeholder in the search filter. The client's username is substituted into the{1}placeholder. For example, if you set this option to(member=uid={1})for the user janedoe, the search filter becomes(member=uid=janedoe)after string substitution. It matches all role entries that have a member attribute equal touid=janedoeunder the subtree selected by theRoleBases. - service
Account StringUsername - Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,ou=corp,dc=corp,dc=example,dc=com. - user
Base String - Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to
ou=Users,ou=corp,dc=corp,dc=example,dc=com, the search for user entries is restricted to the subtree beneathou=Users,ou=corp,dc=corp,dc=example,dc=com. - user
Search StringMatching - The LDAP search filter used to find users within the
userBase. The client's username is substituted into the{0}placeholder in the search filter. For example, if this option is set to(uid={0})and the received username isjanedoe, the search filter becomes(uid=janedoe)after string substitution. It will result in matching an entry likeuid=janedoe,ou=Users,ou=corp,dc=corp,dc=example,dc=com. - role
Name String - The group name attribute in a role entry whose value is the name of that role. For example, you can specify
cnfor a group entry's common name. If authentication succeeds, then the user is assigned the the value of thecnattribute for each role entry that they are a member of. - role
Search BooleanSubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
- service
Account StringPassword - Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,dc=corp,dc=example,dc=com. - user
Role StringName - The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The
UserRoleNameoption allows you to provide the name of this attribute. - user
Search BooleanSubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
- hosts string[]
- Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
- role
Base string - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example,
ou=group,ou=corp,dc=corp,dc=example,dc=com. - role
Search stringMatching - The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the
{0}placeholder in the search filter. The client's username is substituted into the{1}placeholder. For example, if you set this option to(member=uid={1})for the user janedoe, the search filter becomes(member=uid=janedoe)after string substitution. It matches all role entries that have a member attribute equal touid=janedoeunder the subtree selected by theRoleBases. - service
Account stringUsername - Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,ou=corp,dc=corp,dc=example,dc=com. - user
Base string - Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to
ou=Users,ou=corp,dc=corp,dc=example,dc=com, the search for user entries is restricted to the subtree beneathou=Users,ou=corp,dc=corp,dc=example,dc=com. - user
Search stringMatching - The LDAP search filter used to find users within the
userBase. The client's username is substituted into the{0}placeholder in the search filter. For example, if this option is set to(uid={0})and the received username isjanedoe, the search filter becomes(uid=janedoe)after string substitution. It will result in matching an entry likeuid=janedoe,ou=Users,ou=corp,dc=corp,dc=example,dc=com. - role
Name string - The group name attribute in a role entry whose value is the name of that role. For example, you can specify
cnfor a group entry's common name. If authentication succeeds, then the user is assigned the the value of thecnattribute for each role entry that they are a member of. - role
Search booleanSubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
- service
Account stringPassword - Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,dc=corp,dc=example,dc=com. - user
Role stringName - The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The
UserRoleNameoption allows you to provide the name of this attribute. - user
Search booleanSubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
- hosts Sequence[str]
- Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
- role_
base str - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example,
ou=group,ou=corp,dc=corp,dc=example,dc=com. - role_
search_ strmatching - The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the
{0}placeholder in the search filter. The client's username is substituted into the{1}placeholder. For example, if you set this option to(member=uid={1})for the user janedoe, the search filter becomes(member=uid=janedoe)after string substitution. It matches all role entries that have a member attribute equal touid=janedoeunder the subtree selected by theRoleBases. - service_
account_ strusername - Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,ou=corp,dc=corp,dc=example,dc=com. - user_
base str - Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to
ou=Users,ou=corp,dc=corp,dc=example,dc=com, the search for user entries is restricted to the subtree beneathou=Users,ou=corp,dc=corp,dc=example,dc=com. - user_
search_ strmatching - The LDAP search filter used to find users within the
userBase. The client's username is substituted into the{0}placeholder in the search filter. For example, if this option is set to(uid={0})and the received username isjanedoe, the search filter becomes(uid=janedoe)after string substitution. It will result in matching an entry likeuid=janedoe,ou=Users,ou=corp,dc=corp,dc=example,dc=com. - role_
name str - The group name attribute in a role entry whose value is the name of that role. For example, you can specify
cnfor a group entry's common name. If authentication succeeds, then the user is assigned the the value of thecnattribute for each role entry that they are a member of. - role_
search_ boolsubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
- service_
account_ strpassword - Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,dc=corp,dc=example,dc=com. - user_
role_ strname - The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The
UserRoleNameoption allows you to provide the name of this attribute. - user_
search_ boolsubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
- hosts List<String>
- Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
- role
Base String - The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example,
ou=group,ou=corp,dc=corp,dc=example,dc=com. - role
Search StringMatching - The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the
{0}placeholder in the search filter. The client's username is substituted into the{1}placeholder. For example, if you set this option to(member=uid={1})for the user janedoe, the search filter becomes(member=uid=janedoe)after string substitution. It matches all role entries that have a member attribute equal touid=janedoeunder the subtree selected by theRoleBases. - service
Account StringUsername - Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,ou=corp,dc=corp,dc=example,dc=com. - user
Base String - Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to
ou=Users,ou=corp,dc=corp,dc=example,dc=com, the search for user entries is restricted to the subtree beneathou=Users,ou=corp,dc=corp,dc=example,dc=com. - user
Search StringMatching - The LDAP search filter used to find users within the
userBase. The client's username is substituted into the{0}placeholder in the search filter. For example, if this option is set to(uid={0})and the received username isjanedoe, the search filter becomes(uid=janedoe)after string substitution. It will result in matching an entry likeuid=janedoe,ou=Users,ou=corp,dc=corp,dc=example,dc=com. - role
Name String - The group name attribute in a role entry whose value is the name of that role. For example, you can specify
cnfor a group entry's common name. If authentication succeeds, then the user is assigned the the value of thecnattribute for each role entry that they are a member of. - role
Search BooleanSubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
- service
Account StringPassword - Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example,
cn=admin,dc=corp,dc=example,dc=com. - user
Role StringName - The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The
UserRoleNameoption allows you to provide the name of this attribute. - user
Search BooleanSubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
BrokerLogList
BrokerMaintenanceWindow
- Day
Of Pulumi.Week Aws | stringNative. Amazon Mq. Broker Maintenance Window Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- Time
Of stringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- Time
Zone string - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- Day
Of BrokerWeek Maintenance | stringWindow Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- Time
Of stringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- Time
Zone string - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- day
Of BrokerWeek Maintenance | StringWindow Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- time
Of StringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- time
Zone String - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- day
Of BrokerWeek Maintenance | stringWindow Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- time
Of stringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- time
Zone string - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- day_
of_ Brokerweek Maintenance | strWindow Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- time_
of_ strday - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- time_
zone str - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- day
Of "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY" | StringWeek - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- time
Of StringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- time
Zone String - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
BrokerMaintenanceWindowDayOfWeek
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
