< Back

Add-CfnMapping

Sat Jan 11, 2020 7:12 am

NAME Add-CfnMapping



SYNOPSIS

The optional Mappings section matches a key to a corresponding set of named values.





SYNTAX

Add-CfnMapping [-MappingName] <String> [-Map] <IDictionary> [<CommonParameters>]





DESCRIPTION

As an 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. You use the Fn::FindInMap intrinsic

function to retrieve values in a map.



You cannot include parameters, pseudo parameters, or intrinsic functions in the Mappings section.



The keys and values in mappings must be literal strings. For each mapping, you must declare a logical name and the

sets of values to map. The following example shows a Mappings section containing a single mapping named Mapping01.





PARAMETERS

-MappingName <String>

For each Mapping, you must declare a logical name. The logical name must be alphanumeric and unique among all

logical names within the tTemplate.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Map <IDictionary>

The keys and values in mappings must resolve to literal strings.



AWS-specific parameter types are AWS values such as Amazon EC2 key pair names and VPC IDs. AWS CloudFormation

validates these parameter values against existing values in users' AWS accounts. AWS-specific parameter types

are helpful in catching invalid values at the start of creating or updating a stack.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS

http://docs.aws.amazon.com/AWSCloudForm ... cture.html