< Back
Use-CfnPseudoParameter
Post
NAME Use-CfnPseudoParameter
SYNOPSIS
Pseudo Parameters are parameters that are predefined by AWS CloudFormation. You do not declare them in your
template.
SYNTAX
Use-CfnPseudoParameter [-Parameter] <String> [-NameOnly] [<CommonParameters>]
DESCRIPTION
You use them the same way as you would a Template Parameter, except that this cmdlet already returns the Pseudo
Parameter in a "Ref function form" by default.
The following Pseudo Parameters are defined:
* AccountId: Returns the AWS account ID of the account in which the stack is being created.
o Type: String
o Full: AWS::AccountId
* NotificationARNs: Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
o Type: Array (String)
o Full: AWS::NotificationARNs
* NoValue: Used to unset a property for conditional properties.
o Type: String
o Full: AWS::NoValue
* Region: Returns a string representing the AWS Region in which the encompassing resource is being created.
o Type: String
o Full: AWS::Region
* StackId: Returns the ID of the stack.
o Type: String
o Full: AWS::StackId
* StackName: Returns the name of the stack.
o Type: String
o Full: AWS::StackName
PARAMETERS
-Parameter <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NameOnly [<SwitchParameter>]
Required? false
Position? named
Default value False
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
docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html
SYNOPSIS
Pseudo Parameters are parameters that are predefined by AWS CloudFormation. You do not declare them in your
template.
SYNTAX
Use-CfnPseudoParameter [-Parameter] <String> [-NameOnly] [<CommonParameters>]
DESCRIPTION
You use them the same way as you would a Template Parameter, except that this cmdlet already returns the Pseudo
Parameter in a "Ref function form" by default.
The following Pseudo Parameters are defined:
* AccountId: Returns the AWS account ID of the account in which the stack is being created.
o Type: String
o Full: AWS::AccountId
* NotificationARNs: Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
o Type: Array (String)
o Full: AWS::NotificationARNs
* NoValue: Used to unset a property for conditional properties.
o Type: String
o Full: AWS::NoValue
* Region: Returns a string representing the AWS Region in which the encompassing resource is being created.
o Type: String
o Full: AWS::Region
* StackId: Returns the ID of the stack.
o Type: String
o Full: AWS::StackId
* StackName: Returns the name of the stack.
o Type: String
o Full: AWS::StackName
PARAMETERS
-Parameter <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NameOnly [<SwitchParameter>]
Required? false
Position? named
Default value False
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
docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html