New-VaporOutput

SYNOPSIS

Adds an Output object to the template

SYNTAX

New-VaporOutput [-LogicalId] <String> [[-Description] <String>] [-Value] <Object> [[-Export] <Object>]
 [[-Condition] <Object>] [<CommonParameters>]

DESCRIPTION

The optional Outputs section declares output values that you can import into other stacks (to create cross-stack references), return in response (to describe stack calls), or view on the AWS CloudFormation console. For example, you can output the S3 bucket name for a stack to make the bucket easier to find.

EXAMPLES

EXAMPLE 1

$template = Initialize-Vaporshell -Description "Testing Output"
$template.AddOutput(
    (
        New-VaporOutput -LogicalId "BackupLoadBalancerDNSName" -Description "The DNSName of the backup load balancer" -Value (Add-FnGetAtt -LogicalNameOfResource "BackupLoadBalancer" -AttributeName "DNSName") -Condition "CreateProdResources"
    )
)

When the template is exported, this will convert to: { “AWSTemplateFormatVersion”: “2010-09-09”, “Description”: “Testing Output”, “Outputs”: { “BackupLoadBalancerDNSName”: { “Description”: “The DNSName of the backup load balancer”, “Value”: { “Fn::GetAtt”: [ “BackupLoadBalancer”, “DNSName” ] }, “Condition”: “CreateProdResources” } } }

PARAMETERS

-LogicalId

An identifier for the current output. The logical ID must be alphanumeric (a-z, A-Z, 0-9) and unique within the template.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

A String type that describes the output value. The description can be a maximum of 4 K in length.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

The value of the property returned by the aws cloudformation describe-stacks command. The value of an output can include literals, parameter references, pseudo-parameters, a mapping value, or intrinsic functions.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Export

The name of the resource output to be exported for a cross-stack reference.

Note The following restrictions apply to cross-stack references: * For each AWS account, Export names must be unique within a region. * You can’t create cross-stack references across regions. You can use the intrinsic function Fn::ImportValue to import only values that have been exported within the same region. * For outputs, the value of the Name property of an Export can’t use Ref or GetAtt functions that depend on a resource. * Similarly, the ImportValue function can’t include Ref or GetAtt functions that depend on a resource. * You can’t delete a stack if another stack references one of its outputs. * You can’t modify or remove an output value that is referenced by another stack. * You can use intrinsic functions to customize the Name value of an export.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Condition

Logical ID of the condition that this output needs to be true in order to be provisioned.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Vaporshell.Output

NOTES

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html