VaporShell.DLM.psm1
|
# PSM1 Contents function Format-Json { [CmdletBinding()] Param ( [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)] [String] $Json ) Begin { $cleaner = { param([String]$Line) Process{ [Regex]::Replace( $Line, "\\u(?<Value>[a-zA-Z0-9]{4})", { param($m)([char]([int]::Parse( $m.Groups['Value'].Value, [System.Globalization.NumberStyles]::HexNumber ))).ToString() } ) } } } Process { if ($PSVersionTable.PSVersion.Major -lt 6) { try { $indent = 0; $res = $Json -split '\n' | ForEach-Object { if ($_ -match '[\}\]]') { # This line contains ] or }, decrement the indentation level $indent-- } $line = (' ' * $indent * 2) + $_.TrimStart().Replace(': ', ': ') if ($_ -match '[\{\[]') { # This line contains [ or {, increment the indentation level $indent++ } $cleaner.Invoke($line) } $res -join "`n" } catch { ($Json -split '\n' | ForEach-Object {$cleaner.Invoke($_)}) -join "`n" } } else { ($Json -split '\n' | ForEach-Object {$cleaner.Invoke($_)}) -join "`n" } } } function Get-TrueCount { Param ( [parameter(Mandatory = $false,Position = 0,ValueFromPipeline = $true)] $Array ) Process { if ($array) { if ($array.Count) { $count = $array.Count } else { $count = 1 } } else { $count = 0 } } End { return $count } } function New-VSError { <# .SYNOPSIS Error generator function to use in tandem with $PSCmdlet.ThrowTerminatingError() .PARAMETER Result Allows input of an error from AWS SDK, resulting in the Exception message being parsed out. .PARAMETER String Used to create basic String message errors in the same wrapper #> [cmdletbinding(DefaultParameterSetName="Result")] param( [parameter(Position=0,ParameterSetName="Result")] $Result, [parameter(Position=0,ParameterSetName="String")] $String ) switch ($PSCmdlet.ParameterSetName) { Result { $Exception = "$($result.Exception.InnerException.Message)" } String { $Exception = "$String" } } $e = New-Object "System.Exception" $Exception $errorRecord = New-Object 'System.Management.Automation.ErrorRecord' $e, $null, ([System.Management.Automation.ErrorCategory]::InvalidOperation), $null return $errorRecord } function ResolveS3Endpoint { <# .SYNOPSIS Resolves the S3 endpoint most appropriate for each region. #> Param ( [parameter(Mandatory=$true,Position=0)] [ValidateSet("eu-west-2","ap-south-1","us-east-2","sa-east-1","us-west-1","us-west-2","eu-west-1","ap-southeast-2","ca-central-1","ap-northeast-2","us-east-1","eu-central-1","ap-southeast-1","ap-northeast-1")] [String] $Region ) $endpointMap = @{ "us-east-2" = "s3.us-east-2.amazonaws.com" "us-east-1" = "s3.amazonaws.com" "us-west-1" = "s3-us-west-1.amazonaws.com" "us-west-2" = "s3-us-west-2.amazonaws.com" "ca-central-1" = "s3.ca-central-1.amazonaws.com" "ap-south-1" = "s3.ap-south-1.amazonaws.com" "ap-northeast-2" = "s3.ap-northeast-2.amazonaws.com" "ap-southeast-1" = "s3-ap-southeast-1.amazonaws.com" "ap-southeast-2" = "s3-ap-southeast-2.amazonaws.com" "ap-northeast-1" = "s3-ap-northeast-1.amazonaws.com" "eu-central-1" = "s3.eu-central-1.amazonaws.com" "eu-west-1" = "s3-eu-west-1.amazonaws.com" "eu-west-2" = "s3.eu-west-2.amazonaws.com" "sa-east-1" = "s3-sa-east-1.amazonaws.com" } return $endpointMap[$Region] } function Add-VSDLMLifecyclePolicyAction { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.Action resource property to the template. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.Action resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html .PARAMETER CrossRegionCopy Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html#cfn-dlm-lifecyclepolicy-action-crossregioncopy ItemType: CrossRegionCopyAction UpdateType: Mutable .PARAMETER Name Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html#cfn-dlm-lifecyclepolicy-action-name PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyAction])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $CrossRegionCopy, [parameter(Mandatory = $true)] [object] $Name ) Process { $obj = [DLMLifecyclePolicyAction]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyAction' function Add-VSDLMLifecyclePolicyCreateRule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.CreateRule resource property to the template. Specifies when to create snapshots of EBS volumes. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.CreateRule resource property to the template. Specifies when to create snapshots of EBS volumes. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html .PARAMETER IntervalUnit The interval unit. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Times The time, in UTC, to start the operation. The supported format is hh:mm. The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon DLM selects a time within the next 24 hours. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-times UpdateType: Mutable .PARAMETER CronExpression *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-cronexpression PrimitiveType: String UpdateType: Mutable .PARAMETER Interval The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-interval PrimitiveType: Integer UpdateType: Mutable .PARAMETER Location *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html#cfn-dlm-lifecyclepolicy-createrule-location PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyCreateRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IntervalUnit, [parameter(Mandatory = $false)] $Times, [parameter(Mandatory = $false)] [object] $CronExpression, [parameter(Mandatory = $false)] [object] $Interval, [parameter(Mandatory = $false)] [object] $Location ) Process { $obj = [DLMLifecyclePolicyCreateRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyCreateRule' function Add-VSDLMLifecyclePolicyCrossRegionCopyAction { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyAction resource property to the template. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyAction resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html .PARAMETER Target Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html#cfn-dlm-lifecyclepolicy-crossregioncopyaction-target PrimitiveType: String UpdateType: Mutable .PARAMETER EncryptionConfiguration Type: EncryptionConfiguration Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html#cfn-dlm-lifecyclepolicy-crossregioncopyaction-encryptionconfiguration UpdateType: Mutable .PARAMETER RetainRule Type: CrossRegionCopyRetainRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html#cfn-dlm-lifecyclepolicy-crossregioncopyaction-retainrule UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyCrossRegionCopyAction])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Target, [parameter(Mandatory = $true)] $EncryptionConfiguration, [parameter(Mandatory = $false)] $RetainRule ) Process { $obj = [DLMLifecyclePolicyCrossRegionCopyAction]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyCrossRegionCopyAction' function Add-VSDLMLifecyclePolicyCrossRegionCopyDeprecateRule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyDeprecateRule resource property to the template. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyDeprecateRule resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html .PARAMETER IntervalUnit Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html#cfn-dlm-lifecyclepolicy-crossregioncopydeprecaterule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Interval Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html#cfn-dlm-lifecyclepolicy-crossregioncopydeprecaterule-interval PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyCrossRegionCopyDeprecateRule])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $IntervalUnit, [parameter(Mandatory = $true)] [object] $Interval ) Process { $obj = [DLMLifecyclePolicyCrossRegionCopyDeprecateRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyCrossRegionCopyDeprecateRule' function Add-VSDLMLifecyclePolicyCrossRegionCopyRetainRule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule resource property to the template. Specifies the retention rule for cross-Region snapshot copies. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule resource property to the template. Specifies the retention rule for cross-Region snapshot copies. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html .PARAMETER IntervalUnit The unit of time for time-based retention. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyretainrule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Interval The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyretainrule-interval PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyCrossRegionCopyRetainRule])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $IntervalUnit, [parameter(Mandatory = $true)] [object] $Interval ) Process { $obj = [DLMLifecyclePolicyCrossRegionCopyRetainRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyCrossRegionCopyRetainRule' function Add-VSDLMLifecyclePolicyCrossRegionCopyRule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRule resource property to the template. Specifies a rule for cross-Region snapshot copies. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.CrossRegionCopyRule resource property to the template. Specifies a rule for cross-Region snapshot copies. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html .PARAMETER TargetRegion The target Region. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-targetregion PrimitiveType: String UpdateType: Mutable .PARAMETER Target *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-target PrimitiveType: String UpdateType: Mutable .PARAMETER DeprecateRule *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: CrossRegionCopyDeprecateRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-deprecaterule UpdateType: Mutable .PARAMETER Encrypted To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CmkArn The Amazon Resource Name ARN of the AWS KMS customer master key CMK to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-cmkarn PrimitiveType: String UpdateType: Mutable .PARAMETER RetainRule The retention rule. Type: CrossRegionCopyRetainRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-retainrule UpdateType: Mutable .PARAMETER CopyTags Copy all user-defined tags from the source snapshot to the copied snapshot. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html#cfn-dlm-lifecyclepolicy-crossregioncopyrule-copytags PrimitiveType: Boolean UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyCrossRegionCopyRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $TargetRegion, [parameter(Mandatory = $false)] [object] $Target, [parameter(Mandatory = $false)] $DeprecateRule, [parameter(Mandatory = $true)] [object] $Encrypted, [parameter(Mandatory = $false)] [object] $CmkArn, [parameter(Mandatory = $false)] $RetainRule, [parameter(Mandatory = $false)] [object] $CopyTags ) Process { $obj = [DLMLifecyclePolicyCrossRegionCopyRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyCrossRegionCopyRule' function Add-VSDLMLifecyclePolicyDeprecateRule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.DeprecateRule resource property to the template. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.DeprecateRule resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html .PARAMETER IntervalUnit Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html#cfn-dlm-lifecyclepolicy-deprecaterule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Count Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html#cfn-dlm-lifecyclepolicy-deprecaterule-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Interval Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html#cfn-dlm-lifecyclepolicy-deprecaterule-interval PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyDeprecateRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IntervalUnit, [parameter(Mandatory = $false)] [object] $Count, [parameter(Mandatory = $false)] [object] $Interval ) Process { $obj = [DLMLifecyclePolicyDeprecateRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyDeprecateRule' function Add-VSDLMLifecyclePolicyEncryptionConfiguration { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.EncryptionConfiguration resource property to the template. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.EncryptionConfiguration resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-encryptionconfiguration.html .PARAMETER Encrypted Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-encryptionconfiguration.html#cfn-dlm-lifecyclepolicy-encryptionconfiguration-encrypted PrimitiveType: Boolean UpdateType: Mutable .PARAMETER CmkArn Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-encryptionconfiguration.html#cfn-dlm-lifecyclepolicy-encryptionconfiguration-cmkarn PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyEncryptionConfiguration])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Encrypted, [parameter(Mandatory = $false)] [object] $CmkArn ) Process { $obj = [DLMLifecyclePolicyEncryptionConfiguration]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyEncryptionConfiguration' function Add-VSDLMLifecyclePolicyEventParameters { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.EventParameters resource property to the template. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.EventParameters resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html .PARAMETER EventType Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-eventtype PrimitiveType: String UpdateType: Mutable .PARAMETER SnapshotOwner PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-snapshotowner UpdateType: Mutable .PARAMETER DescriptionRegex Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventparameters.html#cfn-dlm-lifecyclepolicy-eventparameters-descriptionregex PrimitiveType: String UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyEventParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $EventType, [parameter(Mandatory = $true)] $SnapshotOwner, [parameter(Mandatory = $false)] [object] $DescriptionRegex ) Process { $obj = [DLMLifecyclePolicyEventParameters]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyEventParameters' function Add-VSDLMLifecyclePolicyEventSource { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.EventSource resource property to the template. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.EventSource resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html .PARAMETER Type Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html#cfn-dlm-lifecyclepolicy-eventsource-type PrimitiveType: String UpdateType: Mutable .PARAMETER Parameters Type: EventParameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html#cfn-dlm-lifecyclepolicy-eventsource-parameters UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyEventSource])] [cmdletbinding()] Param( [parameter(Mandatory = $true)] [object] $Type, [parameter(Mandatory = $false)] $Parameters ) Process { $obj = [DLMLifecyclePolicyEventSource]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyEventSource' function Add-VSDLMLifecyclePolicyFastRestoreRule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.FastRestoreRule resource property to the template. Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.FastRestoreRule resource property to the template. Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html .PARAMETER IntervalUnit The unit of time for enabling fast snapshot restore. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER AvailabilityZones The Availability Zones in which to enable fast snapshot restore. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-availabilityzones UpdateType: Mutable .PARAMETER Count The number of snapshots to be enabled with fast snapshot restore. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Interval The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html#cfn-dlm-lifecyclepolicy-fastrestorerule-interval PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyFastRestoreRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IntervalUnit, [parameter(Mandatory = $false)] $AvailabilityZones, [parameter(Mandatory = $false)] [object] $Count, [parameter(Mandatory = $false)] [object] $Interval ) Process { $obj = [DLMLifecyclePolicyFastRestoreRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyFastRestoreRule' function Add-VSDLMLifecyclePolicyParameters { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.Parameters resource property to the template. Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.Parameters resource property to the template. Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html .PARAMETER ExcludeBootVolume EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html. The default is false. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-excludebootvolume PrimitiveType: Boolean UpdateType: Mutable .PARAMETER NoReboot *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html#cfn-dlm-lifecyclepolicy-parameters-noreboot PrimitiveType: Boolean UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyParameters])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ExcludeBootVolume, [parameter(Mandatory = $false)] [object] $NoReboot ) Process { $obj = [DLMLifecyclePolicyParameters]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyParameters' function Add-VSDLMLifecyclePolicyPolicyDetails { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.PolicyDetails resource property to the template. Specifies the configuration of a lifecycle policy. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.PolicyDetails resource property to the template. Specifies the configuration of a lifecycle policy. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html .PARAMETER ResourceTypes The resource type. PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcetypes UpdateType: Mutable .PARAMETER Schedules The schedule of policy-defined actions. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-schedules ItemType: Schedule UpdateType: Mutable .PARAMETER PolicyType The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-policytype PrimitiveType: String UpdateType: Mutable .PARAMETER EventSource + PolicyDetails: https://docs.aws.amazon.com/dlm/latest/APIReference/API_PolicyDetails.html in the *Amazon Data Lifecycle Manager API Reference* Type: EventSource Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-eventsource UpdateType: Mutable .PARAMETER Parameters A set of optional parameters for the policy. Type: Parameters Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-parameters UpdateType: Mutable .PARAMETER Actions + PolicyDetails: https://docs.aws.amazon.com/dlm/latest/APIReference/API_PolicyDetails.html in the *Amazon Data Lifecycle Manager API Reference* Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-actions ItemType: Action UpdateType: Mutable .PARAMETER TargetTags The single tag that identifies targeted resources for this policy. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-targettags ItemType: Tag UpdateType: Mutable .PARAMETER ResourceLocations + PolicyDetails: https://docs.aws.amazon.com/dlm/latest/APIReference/API_PolicyDetails.html in the *Amazon Data Lifecycle Manager API Reference* PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcelocations UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyPolicyDetails])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $ResourceTypes, [parameter(Mandatory = $false)] [object] $Schedules, [parameter(Mandatory = $false)] [object] $PolicyType, [parameter(Mandatory = $false)] $EventSource, [parameter(Mandatory = $false)] $Parameters, [parameter(Mandatory = $false)] [object] $Actions, [TransformTag()] [object] [parameter(Mandatory = $false)] $TargetTags, [parameter(Mandatory = $false)] $ResourceLocations ) Process { $obj = [DLMLifecyclePolicyPolicyDetails]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyPolicyDetails' function Add-VSDLMLifecyclePolicyRetainRule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.RetainRule resource property to the template. Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.RetainRule resource property to the template. Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html .PARAMETER IntervalUnit The unit of time for time-based retention. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-intervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER Count The number of snapshots to retain for each volume, up to a maximum of 1000. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-count PrimitiveType: Integer UpdateType: Mutable .PARAMETER Interval The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html#cfn-dlm-lifecyclepolicy-retainrule-interval PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyRetainRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $IntervalUnit, [parameter(Mandatory = $false)] [object] $Count, [parameter(Mandatory = $false)] [object] $Interval ) Process { $obj = [DLMLifecyclePolicyRetainRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyRetainRule' function Add-VSDLMLifecyclePolicySchedule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.Schedule resource property to the template. Specifies a backup schedule. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.Schedule resource property to the template. Specifies a backup schedule. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html .PARAMETER ShareRules *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-sharerules ItemType: ShareRule UpdateType: Mutable .PARAMETER DeprecateRule *Update requires*: No interruption: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt Type: DeprecateRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-deprecaterule UpdateType: Mutable .PARAMETER TagsToAdd The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-tagstoadd ItemType: Tag UpdateType: Mutable .PARAMETER CreateRule The creation rule. Type: CreateRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-createrule UpdateType: Mutable .PARAMETER VariableTags A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $instance-id or $timestamp. Variable tags are only valid for EBS Snapshot Management – Instance policies. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-variabletags ItemType: Tag UpdateType: Mutable .PARAMETER FastRestoreRule The rule for enabling fast snapshot restore. Type: FastRestoreRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-fastrestorerule UpdateType: Mutable .PARAMETER RetainRule The retention rule. Type: RetainRule Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-retainrule UpdateType: Mutable .PARAMETER CrossRegionCopyRules The rule for cross-Region snapshot copies. Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-crossregioncopyrules ItemType: CrossRegionCopyRule UpdateType: Mutable .PARAMETER Name The name of the schedule. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-name PrimitiveType: String UpdateType: Mutable .PARAMETER CopyTags Copy all user-defined tags on a source volume to snapshots of the volume created by this policy. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-copytags PrimitiveType: Boolean UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicySchedule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] [object] $ShareRules, [parameter(Mandatory = $false)] $DeprecateRule, [TransformTag()] [object] [parameter(Mandatory = $false)] $TagsToAdd, [parameter(Mandatory = $false)] $CreateRule, [TransformTag()] [object] [parameter(Mandatory = $false)] $VariableTags, [parameter(Mandatory = $false)] $FastRestoreRule, [parameter(Mandatory = $false)] $RetainRule, [parameter(Mandatory = $false)] [object] $CrossRegionCopyRules, [parameter(Mandatory = $false)] [object] $Name, [parameter(Mandatory = $false)] [object] $CopyTags ) Process { $obj = [DLMLifecyclePolicySchedule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicySchedule' function Add-VSDLMLifecyclePolicyShareRule { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy.ShareRule resource property to the template. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy.ShareRule resource property to the template. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html .PARAMETER TargetAccounts PrimitiveItemType: String Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html#cfn-dlm-lifecyclepolicy-sharerule-targetaccounts UpdateType: Mutable .PARAMETER UnshareIntervalUnit Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html#cfn-dlm-lifecyclepolicy-sharerule-unshareintervalunit PrimitiveType: String UpdateType: Mutable .PARAMETER UnshareInterval Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html#cfn-dlm-lifecyclepolicy-sharerule-unshareinterval PrimitiveType: Integer UpdateType: Mutable .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicyShareRule])] [cmdletbinding()] Param( [parameter(Mandatory = $false)] $TargetAccounts, [parameter(Mandatory = $false)] [object] $UnshareIntervalUnit, [parameter(Mandatory = $false)] [object] $UnshareInterval ) Process { $obj = [DLMLifecyclePolicyShareRule]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'Add-VSDLMLifecyclePolicyShareRule' function New-VSDLMLifecyclePolicy { <# .SYNOPSIS Adds an AWS::DLM::LifecyclePolicy resource to the template. Specifies a lifecycle policy, which is used to automate operations on Amazon EBS resources. .DESCRIPTION Adds an AWS::DLM::LifecyclePolicy resource to the template. Specifies a lifecycle policy, which is used to automate operations on Amazon EBS resources. The properties are required when you add a lifecycle policy and optional when you update a lifecycle policy. .LINK http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html .PARAMETER LogicalId The logical ID must be alphanumeric (A-Za-z0-9) and unique within the template. Use the logical name to reference the resource in other parts of the template. For example, if you want to map an Amazon Elastic Block Store volume to an Amazon EC2 instance, you reference the logical IDs to associate the block stores with the instance. .PARAMETER ExecutionRoleArn The Amazon Resource Name ARN of the IAM role used to run the operations specified by the lifecycle policy. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-executionrolearn PrimitiveType: String UpdateType: Mutable .PARAMETER Description A description of the lifecycle policy. The characters ^0-9A-Za-z _-]+$ are supported. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-description PrimitiveType: String UpdateType: Mutable .PARAMETER State The activation state of the lifecycle policy. Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-state PrimitiveType: String UpdateType: Mutable .PARAMETER PolicyDetails The configuration details of the lifecycle policy. Type: PolicyDetails Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-policydetails UpdateType: Mutable .PARAMETER Tags + Automating the Amazon EBS Snapshot Lifecycle: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html in the *Amazon Elastic Compute Cloud User Guide* Type: List Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dlm-lifecyclepolicy.html#cfn-dlm-lifecyclepolicy-tags ItemType: Tag UpdateType: Mutable .PARAMETER DeletionPolicy With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to use or modify those resources after you delete their stacks. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER UpdateReplacePolicy Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. When you initiate a stack update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template and parameters. If you update a resource property that requires that the resource be replaced, AWS CloudFormation recreates the resource during the update. Recreating the resource generates a new physical ID. AWS CloudFormation creates the replacement resource first, and then changes references from other dependent resources to point to the replacement resource. By default, AWS CloudFormation then deletes the old resource. Using the UpdateReplacePolicy, you can specify that AWS CloudFormation retain or (in some cases) create a snapshot of the old resource. For resources that support snapshots, such as AWS::EC2::Volume, specify Snapshot to have AWS CloudFormation create a snapshot before deleting the old resource instance. You can apply the UpdateReplacePolicy attribute to any resource. UpdateReplacePolicy is only executed if you update a resource property whose update behavior is specified as Replacement, thereby causing AWS CloudFormation to replace the old resource with a new one with a new physical ID. For example, if you update the Engine property of an AWS::RDS::DBInstance resource type, AWS CloudFormation creates a new resource and replaces the current DB instance resource with the new one. The UpdateReplacePolicy attribute would then dictate whether AWS CloudFormation deleted, retained, or created a snapshot of the old DB instance. The update behavior for each property of a resource is specified in the reference topic for that resource in the AWS Resource and Property Types Reference. For more information on resource update behavior, see Update Behaviors of Stack Resources. The UpdateReplacePolicy attribute applies to stack updates you perform directly, as well as stack updates performed using change sets. Note Resources that are retained continue to exist and continue to incur applicable charges until you delete those resources. Snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots. UpdateReplacePolicy retains the old physical resource or snapshot, but removes it from AWS CloudFormation's scope. UpdateReplacePolicy differs from the DeletionPolicy attribute in that it only applies to resources replaced during stack updates. Use DeletionPolicy for resources deleted when a stack is deleted, or when the resource definition itself is deleted from the template as part of a stack update. You must use one of the following options: "Delete","Retain","Snapshot" .PARAMETER DependsOn With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. This parameter takes a string or list of strings representing Logical IDs of resources that must be created prior to this resource being created. .PARAMETER Metadata The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values. This will be returned when describing the resource using AWS CLI. .PARAMETER UpdatePolicy Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. You must use the "Add-UpdatePolicy" function or the [UpdatePolicy] class here. .PARAMETER Condition Logical ID of the condition that this resource needs to be true in order for this resource to be provisioned. .FUNCTIONALITY Vaporshell #> [OutputType([DLMLifecyclePolicy])] [cmdletbinding()] Param( [parameter(Mandatory = $true,Position = 0)] [ValidateLogicalId()] [string] $LogicalId, [parameter(Mandatory = $false)] [object] $ExecutionRoleArn, [parameter(Mandatory = $false)] [object] $Description, [parameter(Mandatory = $false)] [object] $State, [parameter(Mandatory = $false)] $PolicyDetails, [TransformTag()] [object] [parameter(Mandatory = $false)] $Tags, [parameter()] [DeletionPolicy] $DeletionPolicy, [parameter()] [UpdateReplacePolicy] $UpdateReplacePolicy, [parameter(Mandatory = $false)] [string[]] $DependsOn, [parameter(Mandatory = $false)] [VSJson] $Metadata, [parameter(Mandatory = $false)] [UpdatePolicy] $UpdatePolicy, [parameter(Mandatory = $false)] [string] $Condition ) Process { $obj = [DLMLifecyclePolicy]::new($PSBoundParameters) Write-Debug "$($MyInvocation.MyCommand) PSBoundParameters:`n$($PSBoundParameters | ConvertTo-Json -Depth 20 | Format-Json)" Write-Verbose "Resulting object from $($MyInvocation.MyCommand): `n$($obj.ToJson() | Format-Json)" $obj } } Export-ModuleMember -Function 'New-VSDLMLifecyclePolicy' |