AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Data Lifecycle Manager UpdateLifecyclePolicy API operation.

Syntax

Update-DLMLifecyclePolicy
-PolicyId <String>
-PolicyDetails_Action <Action[]>
-Description <String>
-Parameters_DescriptionRegex <String>
-Parameters_EventType <EventTypeValues>
-Parameters_ExcludeBootVolume <Boolean>
-ExecutionRoleArn <String>
-Parameters_NoReboot <Boolean>
-PolicyDetails_PolicyType <PolicyTypeValues>
-PolicyDetails_ResourceLocation <String[]>
-PolicyDetails_ResourceType <String[]>
-PolicyDetails_Schedule <Schedule[]>
-Parameters_SnapshotOwner <String[]>
-State <SettablePolicyStateValues>
-PolicyDetails_TargetTag <Tag[]>
-EventSource_Type <EventSourceValues>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Updates the specified lifecycle policy.

Parameters

-Description <String>
A description of the lifecycle policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventSource_Type <EventSourceValues>
The source of the event. Currently only managed CloudWatch Events rules are supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_EventSource_Type
-ExecutionRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Parameters_DescriptionRegex <String>
The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_EventSource_Parameters_DescriptionRegex
-Parameters_EventType <EventTypeValues>
The type of event. Currently, only snapshot sharing events are supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_EventSource_Parameters_EventType
-Parameters_ExcludeBootVolume <Boolean>
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_Parameters_ExcludeBootVolume
-Parameters_NoReboot <Boolean>
Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_Parameters_NoReboot
-Parameters_SnapshotOwner <String[]>
The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_EventSource_Parameters_SnapshotOwner
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the PolicyId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyDetails_Action <Action[]>
The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_Actions
-PolicyDetails_PolicyType <PolicyTypeValues>
The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.The default is EBS_SNAPSHOT_MANAGEMENT.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyDetails_ResourceLocation <String[]>
The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST. If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_ResourceLocations
-PolicyDetails_ResourceType <String[]>
The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_ResourceTypes
-PolicyDetails_Schedule <Schedule[]>
The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_Schedules
-PolicyDetails_TargetTag <Tag[]>
The single tag that identifies targeted resources for this policy.This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPolicyDetails_TargetTags
-PolicyId <String>
The identifier of the lifecycle policy.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DLM.Model.UpdateLifecyclePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
The desired activation state of the lifecycle policy after creation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet does not generate any output.The service response (type Amazon.DLM.Model.UpdateLifecyclePolicyResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z