CfnBroker
- class aws_cdk.aws_amazonmq.CfnBroker(scope, id, *, auto_minor_version_upgrade, broker_name, deployment_mode, engine_type, engine_version, host_instance_type, publicly_accessible, users, authentication_strategy=None, configuration=None, encryption_options=None, ldap_server_metadata=None, logs=None, maintenance_window_start_time=None, security_groups=None, storage_type=None, subnet_ids=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::AmazonMQ::Broker
.A broker is a message broker environment running on Amazon MQ . It is the basic building block of Amazon MQ .
The
AWS::AmazonMQ::Broker
resource lets you create Amazon MQ for ActiveMQ and Amazon MQ for RabbitMQ brokers, add configuration changes or modify users for a speified ActiveMQ broker, return information about the specified broker, and delete the broker. For more information, see How Amazon MQ works in the Amazon MQ Developer Guide .ec2:CreateNetworkInterface
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
ec2:CreateNetworkInterfacePermission
This permission is required to attach the ENI to the broker instance.
ec2:DeleteNetworkInterface
ec2:DeleteNetworkInterfacePermission
ec2:DetachNetworkInterface
ec2:DescribeInternetGateways
ec2:DescribeNetworkInterfaces
ec2:DescribeNetworkInterfacePermissions
ec2:DescribeRouteTables
ec2:DescribeSecurityGroups
ec2:DescribeSubnets
ec2:DescribeVpcs
- CloudformationResource:
AWS::AmazonMQ::Broker
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amazonmq as amazonmq cfn_broker = amazonmq.CfnBroker(self, "MyCfnBroker", auto_minor_version_upgrade=False, broker_name="brokerName", deployment_mode="deploymentMode", engine_type="engineType", engine_version="engineVersion", host_instance_type="hostInstanceType", publicly_accessible=False, users=[amazonmq.CfnBroker.UserProperty( password="password", username="username", # the properties below are optional console_access=False, groups=["groups"] )], # the properties below are optional authentication_strategy="authenticationStrategy", configuration=amazonmq.CfnBroker.ConfigurationIdProperty( id="id", revision=123 ), encryption_options=amazonmq.CfnBroker.EncryptionOptionsProperty( use_aws_owned_key=False, # the properties below are optional kms_key_id="kmsKeyId" ), ldap_server_metadata=amazonmq.CfnBroker.LdapServerMetadataProperty( hosts=["hosts"], role_base="roleBase", role_search_matching="roleSearchMatching", service_account_password="serviceAccountPassword", service_account_username="serviceAccountUsername", user_base="userBase", user_search_matching="userSearchMatching", # the properties below are optional role_name="roleName", role_search_subtree=False, user_role_name="userRoleName", user_search_subtree=False ), logs=amazonmq.CfnBroker.LogListProperty( audit=False, general=False ), maintenance_window_start_time=amazonmq.CfnBroker.MaintenanceWindowProperty( day_of_week="dayOfWeek", time_of_day="timeOfDay", time_zone="timeZone" ), security_groups=["securityGroups"], storage_type="storageType", subnet_ids=["subnetIds"], tags=[amazonmq.CfnBroker.TagsEntryProperty( key="key", value="value" )] )
Create a new
AWS::AmazonMQ::Broker
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
auto_minor_version_upgrade (
Union
[bool
,IResolvable
]) – 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.broker_name (
str
) – 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 white spaces, brackets, wildcard characters, or special characters. .. epigraph:: Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.deployment_mode (
str
) – The deployment mode of the broker. Available values:. -SINGLE_INSTANCE
-ACTIVE_STANDBY_MULTI_AZ
-CLUSTER_MULTI_AZ
engine_type (
str
) – The type of broker engine. Currently, Amazon MQ supportsACTIVEMQ
andRABBITMQ
.engine_version (
str
) – The version of the broker engine. For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .host_instance_type (
str
) – The broker’s instance type.publicly_accessible (
Union
[bool
,IResolvable
]) – Enables connections from applications outside of the VPC that hosts the broker’s subnets.users (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,UserProperty
,Dict
[str
,Any
]]]]) – 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 RabbitMQ users are created by via the RabbitMQ web console or by using the RabbitMQ management API.authentication_strategy (
Optional
[str
]) – Optional. The authentication strategy used to secure the broker. The default isSIMPLE
.configuration (
Union
[IResolvable
,ConfigurationIdProperty
,Dict
[str
,Any
],None
]) – A list of information about the configuration. Does not apply to RabbitMQ brokers.encryption_options (
Union
[IResolvable
,EncryptionOptionsProperty
,Dict
[str
,Any
],None
]) – Encryption options for the broker. Does not apply to RabbitMQ brokers.ldap_server_metadata (
Union
[IResolvable
,LdapServerMetadataProperty
,Dict
[str
,Any
],None
]) – Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.logs (
Union
[IResolvable
,LogListProperty
,Dict
[str
,Any
],None
]) – Enables Amazon CloudWatch logging for brokers.maintenance_window_start_time (
Union
[IResolvable
,MaintenanceWindowProperty
,Dict
[str
,Any
],None
]) – The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.security_groups (
Optional
[Sequence
[str
]]) – The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.storage_type (
Optional
[str
]) – The broker’s storage type.subnet_ids (
Optional
[Sequence
[str
]]) – 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 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. .. epigraph:: 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 AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .tags (
Optional
[Sequence
[Union
[TagsEntryProperty
,Dict
[str
,Any
]]]]) – An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::AmazonMQ::Broker'
- attr_amqp_endpoints
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
- CloudformationAttribute:
AmqpEndpoints
- attr_arn
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
- CloudformationAttribute:
Arn
- attr_configuration_id
The unique ID that Amazon MQ generates for the configuration.
c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
- CloudformationAttribute:
ConfigurationId
- attr_configuration_revision
The revision number of the configuration.
1
- CloudformationAttribute:
ConfigurationRevision
- attr_ip_addresses
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']
- CloudformationAttribute:
IpAddresses
- attr_mqtt_endpoints
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
- CloudformationAttribute:
MqttEndpoints
- attr_open_wire_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
- CloudformationAttribute:
OpenWireEndpoints
- attr_stomp_endpoints
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
- CloudformationAttribute:
StompEndpoints
- attr_wss_endpoints
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
- CloudformationAttribute:
WssEndpoints
- authentication_strategy
Optional.
The authentication strategy used to secure the broker. The default is
SIMPLE
.
- auto_minor_version_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.
- broker_name
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 white spaces, brackets, wildcard characters, or special characters. .. epigraph:
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- configuration
A list of information about the configuration.
Does not apply to RabbitMQ brokers.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- deployment_mode
.
SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ
- Link:
- Type:
The deployment mode of the broker. Available values
- encryption_options
Encryption options for the broker.
Does not apply to RabbitMQ brokers.
- engine_type
The type of broker engine.
Currently, Amazon MQ supports
ACTIVEMQ
andRABBITMQ
.
- engine_version
The version of the broker engine.
For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .
- host_instance_type
The broker’s instance type.
- 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.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- logs
Enables Amazon CloudWatch logging for brokers.
- maintenance_window_start_time
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
- node
The construct tree node associated with this construct.
- publicly_accessible
Enables connections from applications outside of the VPC that hosts the broker’s subnets.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- security_groups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- storage_type
The broker’s storage type.
- subnet_ids
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 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. .. epigraph:
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 AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .
- tags
An array of key-value pairs.
For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
- users
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 RabbitMQ users are created by via the RabbitMQ web console or by using the RabbitMQ management API.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
ConfigurationIdProperty
- class CfnBroker.ConfigurationIdProperty(*, id, revision)
Bases:
object
A list of information about the configuration.
Does not apply to RabbitMQ brokers.
- Parameters:
id (
str
) – The unique ID that Amazon MQ generates for the configuration.revision (
Union
[int
,float
]) – The revision number of the configuration.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amazonmq as amazonmq configuration_id_property = amazonmq.CfnBroker.ConfigurationIdProperty( id="id", revision=123 )
Attributes
- id
The unique ID that Amazon MQ generates for the configuration.
- revision
The revision number of the configuration.
EncryptionOptionsProperty
- class CfnBroker.EncryptionOptionsProperty(*, use_aws_owned_key, kms_key_id=None)
Bases:
object
Encryption options for the broker.
Does not apply to RabbitMQ brokers.
- Parameters:
use_aws_owned_key (
Union
[bool
,IResolvable
]) – Enables the use of an AWS owned CMK using AWS KMS (KMS). Set totrue
by default, if no value is provided, for example, for RabbitMQ brokers.kms_key_id (
Optional
[str
]) – The customer master key (CMK) to use for the A AWS KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amazonmq as amazonmq encryption_options_property = amazonmq.CfnBroker.EncryptionOptionsProperty( use_aws_owned_key=False, # the properties below are optional kms_key_id="kmsKeyId" )
Attributes
- kms_key_id
The customer master key (CMK) to use for the A AWS KMS (KMS).
This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.
- use_aws_owned_key
Enables the use of an AWS owned CMK using AWS KMS (KMS).
Set to
true
by default, if no value is provided, for example, for RabbitMQ brokers.
LdapServerMetadataProperty
- class CfnBroker.LdapServerMetadataProperty(*, hosts, role_base, role_search_matching, service_account_password, service_account_username, user_base, user_search_matching, role_name=None, role_search_subtree=None, user_role_name=None, user_search_subtree=None)
Bases:
object
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Does not apply to RabbitMQ brokers.
- Parameters:
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_matching (
str
) – 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=janedoe
under the subtree selected by theRoleBases
.service_account_password (
str
) – 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
.service_account_username (
str
) – 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 toou=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_matching (
str
) – The LDAP search filter used to find users within theuserBase
. 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 (
Optional
[str
]) – The group name attribute in a role entry whose value is the name of that role. For example, you can specifycn
for a group entry’s common name. If authentication succeeds, then the user is assigned the the value of thecn
attribute for each role entry that they are a member of.role_search_subtree (
Union
[bool
,IResolvable
,None
]) – The directory search scope for the role. If set to true, scope is to search the entire subtree.user_role_name (
Optional
[str
]) – 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. TheUserRoleName
option allows you to provide the name of this attribute.user_search_subtree (
Union
[bool
,IResolvable
,None
]) – The directory search scope for the user. If set to true, scope is to search the entire subtree.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amazonmq as amazonmq ldap_server_metadata_property = amazonmq.CfnBroker.LdapServerMetadataProperty( hosts=["hosts"], role_base="roleBase", role_search_matching="roleSearchMatching", service_account_password="serviceAccountPassword", service_account_username="serviceAccountUsername", user_base="userBase", user_search_matching="userSearchMatching", # the properties below are optional role_name="roleName", role_search_subtree=False, user_role_name="userRoleName", user_search_subtree=False )
Attributes
- hosts
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory .
Optional failover server.
- role_base
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_name
The group name attribute in a role entry whose value is the name of that role.
For example, you can specify
cn
for a group entry’s common name. If authentication succeeds, then the user is assigned the the value of thecn
attribute for each role entry that they are a member of.
- role_search_matching
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=janedoe
under the subtree selected by theRoleBases
.
- role_search_subtree
The directory search scope for the role.
If set to true, scope is to search the entire subtree.
- service_account_password
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
.
- service_account_username
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
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_role_name
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
UserRoleName
option allows you to provide the name of this attribute.
- user_search_matching
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
.
- user_search_subtree
The directory search scope for the user.
If set to true, scope is to search the entire subtree.
LogListProperty
- class CfnBroker.LogListProperty(*, audit=None, general=None)
Bases:
object
The list of information about logs to be enabled for the specified broker.
- Parameters:
audit (
Union
[bool
,IResolvable
,None
]) – Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.general (
Union
[bool
,IResolvable
,None
]) – Enables general logging.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amazonmq as amazonmq log_list_property = amazonmq.CfnBroker.LogListProperty( audit=False, general=False )
Attributes
- audit
Enables audit logging.
Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
- general
Enables general logging.
MaintenanceWindowProperty
- class CfnBroker.MaintenanceWindowProperty(*, day_of_week, time_of_day, time_zone)
Bases:
object
The parameters that determine the
WeeklyStartTime
to apply pending updates or patches to the broker.- Parameters:
day_of_week (
str
) – The day of the week.time_of_day (
str
) – The time, in 24-hour format.time_zone (
str
) – The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amazonmq as amazonmq maintenance_window_property = amazonmq.CfnBroker.MaintenanceWindowProperty( day_of_week="dayOfWeek", time_of_day="timeOfDay", time_zone="timeZone" )
Attributes
- day_of_week
The day of the week.
- time_of_day
The time, in 24-hour format.
- time_zone
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
UserProperty
- class CfnBroker.UserProperty(*, password, username, console_access=None, groups=None)
Bases:
object
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 via the RabbitMQ web console or by using the RabbitMQ management API.
- Parameters:
password (
str
) – The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).username (
str
) – The username of the broker user. For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long. .. epigraph:: Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.console_access (
Union
[bool
,IResolvable
,None
]) – Enables access to the ActiveMQ web console for the ActiveMQ user. Does not apply to RabbitMQ brokers.groups (
Optional
[Sequence
[str
]]) – The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_amazonmq as amazonmq user_property = amazonmq.CfnBroker.UserProperty( password="password", username="username", # the properties below are optional console_access=False, groups=["groups"] )
Attributes
- console_access
Enables access to the ActiveMQ web console for the ActiveMQ user.
Does not apply to RabbitMQ brokers.
- groups
The list of groups (20 maximum) to which the ActiveMQ user belongs.
This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
- password
The password of the user.
This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
- username
The username of the broker user.
For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long. .. epigraph:
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.