Skip to content

Directive_Template

Eugene Bekker edited this page Apr 15, 2016 · 2 revisions

Template (New-CfnTemplate)

SYNOPSIS

A template describes your AWS infrastructure.

SYNTAX

New-CfnTemplate [-TemplateBlock] <ScriptBlock> [-Version <String>] [-Description <String>] [-Metadata <IDictionary>] [-JSON] [-Compress] [<CommonParameters>]

DESCRIPTION

Templates include several major sections. The Resources section is the only section that is required:

  • Parameters
  • Mappings
  • Conditions
  • Resources
  • Outputs

Some sections in a template can be in any order. However, as you build your template, it might be helpful to use the logical ordering of the previous example, as values in one section might refer to values from a previous section.

PARAMETERS

-TemplateBlock <ScriptBlock>

Required?                    true
Position?                    1
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-Version <String>

Required?                    false
Position?                    named
Default value                2010-09-09
Accept pipeline input?       false
Accept wildcard characters?  false

-Description <String>

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-Metadata <IDictionary>

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-JSON <SwitchParameter>

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Accept wildcard characters?  false

-Compress <SwitchParameter>

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Accept wildcard characters?  false

INPUTS

OUTPUTS

NOTES

EXAMPLES