CfnMapping

class aws_cdk.core.CfnMapping(scope, id, *, mapping=None)

Bases: aws_cdk.core.CfnRefElement

Represents a CloudFormation mapping.

__init__(scope, id, *, mapping=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • mapping (Optional[Mapping[str, Mapping[str, Any]]]) – Mapping of key to a set of corresponding set of named values. The key identifies a map of name-value pairs and must be unique within the mapping. For example, if you want to set values based on a region, you can create a mapping that uses the region name as a key and contains the values you want to specify for each specific region. Default: - No mapping.

Return type

None

Methods

find_in_map(key1, key2)
Parameters
  • key1 (str) –

  • key2 (str) –

return :rtype: str :return: A reference to a value in the map based on the two keys.

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

set_value(key1, key2, value)

Sets a value in the map based on the two keys.

Parameters
  • key1 (str) –

  • key2 (str) –

  • value (Any) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

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.

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.

node

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

Return type

ConstructNode

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

stack

The stack in which this element is defined.

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

Return type

Stack

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_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool