class CfnBroker (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.AmazonMQ.CfnBroker`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsamazonmq#CfnBroker`
Java	`software.amazon.awscdk.services.amazonmq.CfnBroker`
Python	`aws_cdk.aws_amazonmq.CfnBroker`
TypeScript	`aws-cdk-lib` » `aws_amazonmq` » `CfnBroker`

Implements IConstruct, IDependable, IInspectable, ITaggable

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amazonmq as amazonmq } from 'aws-cdk-lib';
const cfnBroker = new amazonmq.CfnBroker(this, 'MyCfnBroker', {
  brokerName: 'brokerName',
  deploymentMode: 'deploymentMode',
  engineType: 'engineType',
  hostInstanceType: 'hostInstanceType',
  publiclyAccessible: false,
  users: [{
    password: 'password',
    username: 'username',

    // the properties below are optional
    consoleAccess: false,
    groups: ['groups'],
    replicationUser: false,
  }],

  // the properties below are optional
  authenticationStrategy: 'authenticationStrategy',
  autoMinorVersionUpgrade: false,
  configuration: {
    id: 'id',
    revision: 123,
  },
  dataReplicationMode: 'dataReplicationMode',
  dataReplicationPrimaryBrokerArn: 'dataReplicationPrimaryBrokerArn',
  encryptionOptions: {
    useAwsOwnedKey: false,

    // the properties below are optional
    kmsKeyId: 'kmsKeyId',
  },
  engineVersion: 'engineVersion',
  ldapServerMetadata: {
    hosts: ['hosts'],
    roleBase: 'roleBase',
    roleSearchMatching: 'roleSearchMatching',
    serviceAccountPassword: 'serviceAccountPassword',
    serviceAccountUsername: 'serviceAccountUsername',
    userBase: 'userBase',
    userSearchMatching: 'userSearchMatching',

    // the properties below are optional
    roleName: 'roleName',
    roleSearchSubtree: false,
    userRoleName: 'userRoleName',
    userSearchSubtree: false,
  },
  logs: {
    audit: false,
    general: false,
  },
  maintenanceWindowStartTime: {
    dayOfWeek: 'dayOfWeek',
    timeOfDay: 'timeOfDay',
    timeZone: 'timeZone',
  },
  securityGroups: ['securityGroups'],
  storageType: 'storageType',
  subnetIds: ['subnetIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnBroker(scope: Construct, id: string, props: CfnBrokerProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnBrokerProps — Resource properties.

Construct Props

Name	Type	Description
brokerName	`string`	The name of the broker.
deploymentMode	`string`	The deployment mode of the broker. Available values:.
engineType	`string`	The type of broker engine.
hostInstanceType	`string`	The broker's instance type.
publiclyAccessible	`boolean \|` `IResolvable`	Enables connections from applications outside of the VPC that hosts the broker's subnets.
users	`IResolvable` `\|` `IResolvable` `\|` `UserProperty[]`	The list of broker users (persons or applications) who can access queues and topics.
authenticationStrategy?	`string`	Optional.
autoMinorVersionUpgrade?	`boolean \|` `IResolvable`	Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.
configuration?	`IResolvable` `\|` `ConfigurationIdProperty`	A list of information about the configuration.
dataReplicationMode?	`string`	Defines whether this broker is a part of a data replication pair.
dataReplicationPrimaryBrokerArn?	`string`	The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker.
encryptionOptions?	`IResolvable` `\|` `EncryptionOptionsProperty`	Encryption options for the broker.
engineVersion?	`string`	The version of the broker engine.
ldapServerMetadata?	`IResolvable` `\|` `LdapServerMetadataProperty`	Optional.
logs?	`IResolvable` `\|` `LogListProperty`	Enables Amazon CloudWatch logging for brokers.
maintenanceWindowStartTime?	`IResolvable` `\|` `MaintenanceWindowProperty`	The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
securityGroups?	`string[]`	The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
storageType?	`string`	The broker's storage type.
subnetIds?	`string[]`	The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
tags?	`TagsEntryProperty[]`	An array of key-value pairs.

brokerName

Type: string

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.

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.

deploymentMode

Type: string

The deployment mode of the broker. Available values:.

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

engineType

Type: string

The type of broker engine.

Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

hostInstanceType

Type: string

The broker's instance type.

publiclyAccessible

Type: boolean | IResolvable

Enables connections from applications outside of the VPC that hosts the broker's subnets.

users

Type: IResolvable | IResolvable | UserProperty[]

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.

authenticationStrategy?

Type: string (optional)

Optional.

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

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

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?

Type: IResolvable | ConfigurationIdProperty (optional)

A list of information about the configuration.

Does not apply to RabbitMQ brokers.

dataReplicationMode?

Type: string (optional)

Defines whether this broker is a part of a data replication pair.

dataReplicationPrimaryBrokerArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker.

Must be set when dataReplicationMode is set to CRDR.

encryptionOptions?

Type: IResolvable | EncryptionOptionsProperty (optional)

Encryption options for the broker.

Does not apply to RabbitMQ brokers.

engineVersion?

Type: string (optional)

The version of the broker engine.

For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .

ldapServerMetadata?

Type: IResolvable | LdapServerMetadataProperty (optional)

Optional.

The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

logs?

Type: IResolvable | LogListProperty (optional)

Enables Amazon CloudWatch logging for brokers.

maintenanceWindowStartTime?

Type: IResolvable | MaintenanceWindowProperty (optional)

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

securityGroups?

Type: string[] (optional)

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

storageType?

Type: string (optional)

The broker's storage type.

subnetIds?

Type: string[] (optional)

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.

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?

Type: TagsEntryProperty[] (optional)

An array of key-value pairs.

For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

Properties

Name	Type	Description
attrAmqpEndpoints	`string[]`	The AMQP endpoints of each broker instance as a list of strings.
attrArn	`string`	The Amazon Resource Name (ARN) of the Amazon MQ broker.
attrConfigurationId	`string`	The unique ID that Amazon MQ generates for the configuration.
attrConfigurationRevision	`number`	The revision number of the configuration.
attrId	`string`	Required.
attrIpAddresses	`string[]`	The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
attrMqttEndpoints	`string[]`	The MQTT endpoints of each broker instance as a list of strings.
attrOpenWireEndpoints	`string[]`	The OpenWire endpoints of each broker instance as a list of strings.
attrStompEndpoints	`string[]`	The STOMP endpoints of each broker instance as a list of strings.
attrWssEndpoints	`string[]`	The WSS endpoints of each broker instance as a list of strings.
brokerName	`string`	The name of the broker.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
deploymentMode	`string`	The deployment mode of the broker.
engineType	`string`	The type of broker engine.
hostInstanceType	`string`	The broker's instance type.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
publiclyAccessible	`boolean \|` `IResolvable`	Enables connections from applications outside of the VPC that hosts the broker's subnets.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
users	`IResolvable` `\|` `IResolvable` `\|` `UserProperty[]`	The list of broker users (persons or applications) who can access queues and topics.
authenticationStrategy?	`string`	Optional.
autoMinorVersionUpgrade?	`boolean \|` `IResolvable`	Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.
configuration?	`IResolvable` `\|` `ConfigurationIdProperty`	A list of information about the configuration.
dataReplicationMode?	`string`	Defines whether this broker is a part of a data replication pair.
dataReplicationPrimaryBrokerArn?	`string`	The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker.
encryptionOptions?	`IResolvable` `\|` `EncryptionOptionsProperty`	Encryption options for the broker.
engineVersion?	`string`	The version of the broker engine.
ldapServerMetadata?	`IResolvable` `\|` `LdapServerMetadataProperty`	Optional.
logs?	`IResolvable` `\|` `LogListProperty`	Enables Amazon CloudWatch logging for brokers.
maintenanceWindowStartTime?	`IResolvable` `\|` `MaintenanceWindowProperty`	The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
securityGroups?	`string[]`	The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
storageType?	`string`	The broker's storage type.
subnetIds?	`string[]`	The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
tagsRaw?	`TagsEntryProperty[]`	An array of key-value pairs.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrAmqpEndpoints

Type: 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

attrArn

Type: 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

attrConfigurationId

Type: string

The unique ID that Amazon MQ generates for the configuration.

c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

attrConfigurationRevision

Type: number

The revision number of the configuration.

1

attrId

Type: string

Required.

The unique ID that Amazon MQ generates for the configuration.

attrIpAddresses

Type: 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']

attrMqttEndpoints

Type: 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

attrOpenWireEndpoints

Type: string[]

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

attrStompEndpoints

Type: 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

attrWssEndpoints

Type: 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

brokerName

Type: string

The name of the broker.

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

deploymentMode

Type: string

The deployment mode of the broker.

Available values:.

engineType

Type: string

The type of broker engine.

hostInstanceType

Type: string

The broker's instance type.

logicalId

Type: string

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

node

Type: Node

The tree node.

publiclyAccessible

Type: boolean | IResolvable

Enables connections from applications outside of the VPC that hosts the broker's subnets.

ref

Type: string

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

stack

Type: Stack

The stack in which this element is defined.

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

users

Type: IResolvable | IResolvable | UserProperty[]

The list of broker users (persons or applications) who can access queues and topics.

authenticationStrategy?

Type: string (optional)

Optional.

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ.

configuration?

Type: IResolvable | ConfigurationIdProperty (optional)

A list of information about the configuration.

dataReplicationMode?

Type: string (optional)

Defines whether this broker is a part of a data replication pair.

dataReplicationPrimaryBrokerArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker.

encryptionOptions?

Type: IResolvable | EncryptionOptionsProperty (optional)

Encryption options for the broker.

engineVersion?

Type: string (optional)

The version of the broker engine.

ldapServerMetadata?

Type: IResolvable | LdapServerMetadataProperty (optional)

Optional.

logs?

Type: IResolvable | LogListProperty (optional)

Enables Amazon CloudWatch logging for brokers.

maintenanceWindowStartTime?

Type: IResolvable | MaintenanceWindowProperty (optional)

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

securityGroups?

Type: string[] (optional)

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

storageType?

Type: string (optional)

The broker's storage type.

subnetIds?

Type: string[] (optional)

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

tagsRaw?

Type: TagsEntryProperty[] (optional)

An array of key-value pairs.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

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.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The 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.

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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride 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.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }