< Back

Use-CfnRefFunction

Sat Jan 11, 2020 8:02 am

NAME Use-CfnRefFunction



SYNOPSIS

The intrinsic function Ref returns the value of the specified parameter or resource.





SYNTAX

Use-CfnRefFunction [-LogicalName] <String> [<CommonParameters>]





DESCRIPTION

* When you specify a parameter's logical name, it returns the value of the parameter.

* When you specify a resource's logical name, it returns a value that you can typically use to refer to that

resource, such as a physical ID.

When you are declaring a resource in a template and you need to specify another template resource by name, you can

use the Ref to refer to that other resource. In general, Ref returns the name of the resource.



Tip

You can also use Ref to add values to Output messages.





PARAMETERS

-LogicalName <String>



Required? true

Position? 1

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 ... e-ref.html