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, configuration=None, encryption_options=None, logs=None, maintenance_window_start_time=None, security_groups=None, storage_type=None, subnet_ids=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::AmazonMQ::Broker.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html cloudformationResource: :cloudformationResource:: AWS::AmazonMQ::Broker

__init__(scope, id, *, auto_minor_version_upgrade, broker_name, deployment_mode, engine_type, engine_version, host_instance_type, publicly_accessible, users, configuration=None, encryption_options=None, logs=None, maintenance_window_start_time=None, security_groups=None, storage_type=None, subnet_ids=None, tags=None)

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]) – AWS::AmazonMQ::Broker.AutoMinorVersionUpgrade.

  • broker_name (str) – AWS::AmazonMQ::Broker.BrokerName.

  • deployment_mode (str) – AWS::AmazonMQ::Broker.DeploymentMode.

  • engine_type (str) – AWS::AmazonMQ::Broker.EngineType.

  • engine_version (str) – AWS::AmazonMQ::Broker.EngineVersion.

  • host_instance_type (str) – AWS::AmazonMQ::Broker.HostInstanceType.

  • publicly_accessible (Union[bool, IResolvable]) – AWS::AmazonMQ::Broker.PubliclyAccessible.

  • users (Union[IResolvable, List[Union[IResolvable, Forwardref]]]) – AWS::AmazonMQ::Broker.Users.

  • configuration (Union[IResolvable, None, Forwardref]) – AWS::AmazonMQ::Broker.Configuration.

  • encryption_options (Union[IResolvable, None, Forwardref]) – AWS::AmazonMQ::Broker.EncryptionOptions.

  • logs (Union[IResolvable, None, Forwardref]) – AWS::AmazonMQ::Broker.Logs.

  • maintenance_window_start_time (Union[IResolvable, None, Forwardref]) – AWS::AmazonMQ::Broker.MaintenanceWindowStartTime.

  • security_groups (Optional[List[str]]) – AWS::AmazonMQ::Broker.SecurityGroups.

  • storage_type (Optional[str]) – AWS::AmazonMQ::Broker.StorageType.

  • subnet_ids (Optional[List[str]]) – AWS::AmazonMQ::Broker.SubnetIds.

  • tags (Optional[List[Forwardref]]) – AWS::AmazonMQ::Broker.Tags.

Return type

None

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_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path 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.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
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.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (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

Reference

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

stability :stability: experimental

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 :rtype: str :return: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AmazonMQ::Broker'
attr_amqp_endpoints

cloudformationAttribute: :cloudformationAttribute:: AmqpEndpoints

Return type

List[str]

attr_arn

cloudformationAttribute: :cloudformationAttribute:: Arn

Return type

str

attr_configuration_id

cloudformationAttribute: :cloudformationAttribute:: ConfigurationId

Return type

str

attr_configuration_revision

cloudformationAttribute: :cloudformationAttribute:: ConfigurationRevision

Return type

Union[int, float]

attr_ip_addresses

cloudformationAttribute: :cloudformationAttribute:: IpAddresses

Return type

List[str]

attr_mqtt_endpoints

cloudformationAttribute: :cloudformationAttribute:: MqttEndpoints

Return type

List[str]

attr_open_wire_endpoints

cloudformationAttribute: :cloudformationAttribute:: OpenWireEndpoints

Return type

List[str]

attr_stomp_endpoints

cloudformationAttribute: :cloudformationAttribute:: StompEndpoints

Return type

List[str]

attr_wss_endpoints

cloudformationAttribute: :cloudformationAttribute:: WssEndpoints

Return type

List[str]

auto_minor_version_upgrade

AWS::AmazonMQ::Broker.AutoMinorVersionUpgrade.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-autominorversionupgrade

Return type

Union[bool, IResolvable]

broker_name

AWS::AmazonMQ::Broker.BrokerName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-brokername

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

configuration

AWS::AmazonMQ::Broker.Configuration.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration

Return type

Union[IResolvable, None, Forwardref]

creation_stack

return :rtype: List[str] :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

AWS::AmazonMQ::Broker.DeploymentMode.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode

Return type

str

encryption_options

AWS::AmazonMQ::Broker.EncryptionOptions.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-encryptionoptions

Return type

Union[IResolvable, None, Forwardref]

engine_type

AWS::AmazonMQ::Broker.EngineType.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-enginetype

Return type

str

engine_version

AWS::AmazonMQ::Broker.EngineVersion.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-engineversion

Return type

str

host_instance_type

AWS::AmazonMQ::Broker.HostInstanceType.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-hostinstancetype

Return type

str

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).

return :rtype: str :return:

the logical ID as a stringified token. This value will only get resolved during synthesis.

logs

AWS::AmazonMQ::Broker.Logs.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs

Return type

Union[IResolvable, None, Forwardref]

maintenance_window_start_time

AWS::AmazonMQ::Broker.MaintenanceWindowStartTime.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime

Return type

Union[IResolvable, None, Forwardref]

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

publicly_accessible

AWS::AmazonMQ::Broker.PubliclyAccessible.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-publiclyaccessible

Return type

Union[bool, IResolvable]

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 }).

Return type

str

security_groups

AWS::AmazonMQ::Broker.SecurityGroups.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-securitygroups

Return type

Optional[List[str]]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

storage_type

AWS::AmazonMQ::Broker.StorageType.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-storagetype

Return type

Optional[str]

subnet_ids

AWS::AmazonMQ::Broker.SubnetIds.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-subnetids

Return type

Optional[List[str]]

tags

AWS::AmazonMQ::Broker.Tags.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-tags

Return type

TagManager

users

AWS::AmazonMQ::Broker.Users.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-users

Return type

Union[IResolvable, List[Union[IResolvable, Forwardref]]]

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 :rtype: bool :return: 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