AWS.Tools.DLM.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.DLM</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DLM.AddDLMResourceTagCmdlet"> <summary> Adds the specified tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.AddDLMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.AddDLMResourceTagCmdlet.Tag"> <summary> <para> <para>One or more tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.AddDLMResourceTagCmdlet.Select"> <summary> 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.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.AddDLMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.AddDLMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicyCmdlet"> <summary> Gets detailed information about the specified lifecycle policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicyCmdlet.PolicyId"> <summary> <para> <para>The identifier of the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DLM.Model.GetLifecyclePolicyResponse). Specifying the name of a property of type Amazon.DLM.Model.GetLifecyclePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicySummaryCmdlet"> <summary> Gets summary information about all or the specified data lifecycle policies. <para> To get complete information about a policy, use <a href="https://docs.aws.amazon.com/dlm/latest/APIReference/API_GetLifecyclePolicy.html">GetLifecyclePolicy</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicySummaryCmdlet.DefaultPolicyType"> <summary> <para> <para><b>[Default policies only]</b> Specifies the type of default policy to get. Specify one of the following:</para><ul><li><para><c>VOLUME</c> - To get only the default policy for EBS snapshots</para></li><li><para><c>INSTANCE</c> - To get only the default policy for EBS-backed AMIs</para></li><li><para><c>ALL</c> - To get all default policies</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicySummaryCmdlet.PolicyId"> <summary> <para> <para>The identifiers of the data lifecycle policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicySummaryCmdlet.ResourceType"> <summary> <para> <para>The resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicySummaryCmdlet.State"> <summary> <para> <para>The activation state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicySummaryCmdlet.TagsToAdd"> <summary> <para> <para>The tags to add to objects created by the policy.</para><para>Tags are strings in the format <c>key=value</c>.</para><para>These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicySummaryCmdlet.TargetTag"> <summary> <para> <para>The target tag for a policy.</para><para>Tags are strings in the format <c>key=value</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMLifecyclePolicySummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DLM.Model.GetLifecyclePoliciesResponse). Specifying the name of a property of type Amazon.DLM.Model.GetLifecyclePoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DLM.GetDLMResourceTagCmdlet"> <summary> Lists the tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DLM.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.DLM.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.GetDLMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet"> <summary> Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types: <ul><li><para> Custom EBS snapshot policy </para></li><li><para> Custom EBS-backed AMI policy </para></li><li><para> Cross-account copy event policy </para></li><li><para> Default policy for EBS snapshots </para></li><li><para> Default policy for EBS-backed AMIs </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/policy-differences.html"> Default policies vs custom policies</a>. </para><important><para> If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_Action"> <summary> <para> <para><b>[Event-based policies only]</b> The actions to be performed when the event-based policy is activated. You can specify only one action per policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.CopyTag"> <summary> <para> <para><b>[Default policies only]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is <c>false</c>.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_CopyTag"> <summary> <para> <para><b>[Default policies only]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is <c>false</c>.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.CreateInterval"> <summary> <para> <para><b>[Default policies only]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.</para><para>Default: 1</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_CreateInterval"> <summary> <para> <para><b>[Default policies only]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.</para><para>Default: 1</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.CrossRegionCopyTarget"> <summary> <para> <para><b>[Default policies only]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_CrossRegionCopyTarget"> <summary> <para> <para><b>[Default policies only]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.DefaultPolicy"> <summary> <para> <para><b>[Default policies only]</b> Specify the type of default policy to create.</para><ul><li><para>To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify <c>VOLUME</c>.</para></li><li><para>To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify <c>INSTANCE</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Description"> <summary> <para> <para>A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Parameters_DescriptionRegex"> <summary> <para> <para>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.</para><para>For example, specifying <c>^.*Created for policy: policy-1234567890abcdef0.*$</c> configures the policy to run only if snapshots created by policy <c>policy-1234567890abcdef0</c> are shared with your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Parameters_EventType"> <summary> <para> <para>The type of event. Currently, only snapshot sharing events are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Parameters_ExcludeBootVolume"> <summary> <para> <para><b>[Custom snapshot policies that target instances only]</b> Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is <c>false</c>. If you specify <c>true</c>, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Exclusions_ExcludeBootVolume"> <summary> <para> <para><b>[Default policies for EBS snapshots only]</b> Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_Exclusions_ExcludeBootVolumes"> <summary> <para> <para><b>[Default policies for EBS snapshots only]</b> Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Parameters_ExcludeDataVolumeTag"> <summary> <para> <para><b>[Custom snapshot policies that target instances only]</b> The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.</para><para>If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Exclusions_ExcludeTag"> <summary> <para> <para><b>[Default policies for EBS-backed AMIs only]</b> Specifies whether to exclude volumes that have specific tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_Exclusions_ExcludeTags"> <summary> <para> <para><b>[Default policies for EBS-backed AMIs only]</b> Specifies whether to exclude volumes that have specific tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Exclusions_ExcludeVolumeType"> <summary> <para> <para><b>[Default policies for EBS snapshots only]</b> Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_Exclusions_ExcludeVolumeTypes"> <summary> <para> <para><b>[Default policies for EBS snapshots only]</b> Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.ExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.ExtendDeletion"> <summary> <para> <para><b>[Default policies only]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</para><para>By default (<b>ExtendDeletion=false</b>):</para><ul><li><para>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <c>true</c>.</para></li><li><para>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <c>true</c>.</para></li></ul><para>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</para><para>If you do not specify a value, the default is <c>false</c>.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_ExtendDeletion"> <summary> <para> <para><b>[Default policies only]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</para><para>By default (<b>ExtendDeletion=false</b>):</para><ul><li><para>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <c>true</c>.</para></li><li><para>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <c>true</c>.</para></li></ul><para>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</para><para>If you do not specify a value, the default is <c>false</c>.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Parameters_NoReboot"> <summary> <para> <para><b>[Custom AMI policies only]</b> Indicates whether targeted instances are rebooted when the lifecycle policy runs. <c>true</c> indicates that targeted instances are not rebooted when the policy runs. <c>false</c> indicates that target instances are rebooted when the policy runs. The default is <c>true</c> (instances are not rebooted).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_PolicyLanguage"> <summary> <para> <para>The type of policy to create. Specify one of the following:</para><ul><li><para><c>SIMPLIFIED</c> To create a default policy.</para></li><li><para><c>STANDARD</c> To create a custom policy.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_PolicyType"> <summary> <para> <para><b>[Custom policies only]</b> The valid target resource types and actions a policy can manage. Specify <c>EBS_SNAPSHOT_MANAGEMENT</c> to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify <c>IMAGE_MANAGEMENT</c> to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify <c>EVENT_BASED_POLICY </c> to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.</para><para>The default is <c>EBS_SNAPSHOT_MANAGEMENT</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_ResourceLocation"> <summary> <para> <para><b>[Custom snapshot and AMI policies only]</b> The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify <c>CLOUD</c>. If the source resources are located on an Outpost in your account, specify <c>OUTPOST</c>.</para><para>If you specify <c>OUTPOST</c>, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_SimplifiedResourceType"> <summary> <para> <para><b>[Default policies only]</b> Specify the type of default policy to create.</para><ul><li><para>To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify <c>VOLUME</c>.</para></li><li><para>To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify <c>INSTANCE</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_ResourceType"> <summary> <para> <para><b>[Custom snapshot policies only]</b> The target resource type for snapshot and AMI lifecycle policies. Use <c>VOLUME </c>to create snapshots of individual volumes or use <c>INSTANCE</c> to create multi-volume snapshots from the volumes for an instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_RetainInterval"> <summary> <para> <para><b>[Default policies only]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.</para><para>Default: 7</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.RetainInterval"> <summary> <para> <para><b>[Default policies only]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.</para><para>Default: 7</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_Schedule"> <summary> <para> <para><b>[Custom snapshot and AMI policies only]</b> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Parameters_SnapshotOwner"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.State"> <summary> <para> <para>The activation state of the lifecycle policy after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Tag"> <summary> <para> <para>The tags to apply to the lifecycle policy during creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_TargetTag"> <summary> <para> <para><b>[Custom snapshot and AMI policies only]</b> The single tag that identifies targeted resources for this policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.EventSource_Type"> <summary> <para> <para>The source of the event. Currently only managed CloudWatch Events rules are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DLM.Model.CreateLifecyclePolicyResponse). Specifying the name of a property of type Amazon.DLM.Model.CreateLifecyclePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExecutionRoleArn parameter. The -PassThru parameter is deprecated, use -Select '^ExecutionRoleArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMLifecyclePolicyCmdlet"> <summary> Deletes the specified lifecycle policy and halts the automated operations that the policy specified. <para> For more information about deleting a policy, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#delete">Delete lifecycle policies</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMLifecyclePolicyCmdlet.PolicyId"> <summary> <para> <para>The identifier of the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMLifecyclePolicyCmdlet.Select"> <summary> 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.DeleteLifecyclePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMLifecyclePolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMLifecyclePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMResourceTagCmdlet"> <summary> Removes the specified tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMResourceTagCmdlet.Select"> <summary> 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.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.RemoveDLMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet"> <summary> Updates the specified lifecycle policy. <para> For more information about updating a policy, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#modify">Modify lifecycle policies</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_Action"> <summary> <para> <para><b>[Event-based policies only]</b> The actions to be performed when the event-based policy is activated. You can specify only one action per policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.CopyTag"> <summary> <para> <para><b>[Default policies only]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_CopyTag"> <summary> <para> <para><b>[Default policies only]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is <c>false</c>.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.CreateInterval"> <summary> <para> <para><b>[Default policies only]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_CreateInterval"> <summary> <para> <para><b>[Default policies only]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.</para><para>Default: 1</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.CrossRegionCopyTarget"> <summary> <para> <para><b>[Default policies only]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_CrossRegionCopyTarget"> <summary> <para> <para><b>[Default policies only]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Description"> <summary> <para> <para>A description of the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Parameters_DescriptionRegex"> <summary> <para> <para>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.</para><para>For example, specifying <c>^.*Created for policy: policy-1234567890abcdef0.*$</c> configures the policy to run only if snapshots created by policy <c>policy-1234567890abcdef0</c> are shared with your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Parameters_EventType"> <summary> <para> <para>The type of event. Currently, only snapshot sharing events are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Parameters_ExcludeBootVolume"> <summary> <para> <para><b>[Custom snapshot policies that target instances only]</b> Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is <c>false</c>. If you specify <c>true</c>, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Exclusions_ExcludeBootVolume"> <summary> <para> <para><b>[Default policies for EBS snapshots only]</b> Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_Exclusions_ExcludeBootVolumes"> <summary> <para> <para><b>[Default policies for EBS snapshots only]</b> Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify <c>true</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Parameters_ExcludeDataVolumeTag"> <summary> <para> <para><b>[Custom snapshot policies that target instances only]</b> The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.</para><para>If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Exclusions_ExcludeTag"> <summary> <para> <para><b>[Default policies for EBS-backed AMIs only]</b> Specifies whether to exclude volumes that have specific tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_Exclusions_ExcludeTags"> <summary> <para> <para><b>[Default policies for EBS-backed AMIs only]</b> Specifies whether to exclude volumes that have specific tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Exclusions_ExcludeVolumeType"> <summary> <para> <para><b>[Default policies for EBS snapshots only]</b> Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_Exclusions_ExcludeVolumeTypes"> <summary> <para> <para><b>[Default policies for EBS snapshots only]</b> Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.ExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.ExtendDeletion"> <summary> <para> <para><b>[Default policies only]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</para><para>By default (<b>ExtendDeletion=false</b>):</para><ul><li><para>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <c>true</c>.</para></li><li><para>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <c>true</c>.</para></li></ul><para>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_ExtendDeletion"> <summary> <para> <para><b>[Default policies only]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</para><para>By default (<b>ExtendDeletion=false</b>):</para><ul><li><para>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <c>true</c>.</para></li><li><para>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <c>true</c>.</para></li></ul><para>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</para><para>If you do not specify a value, the default is <c>false</c>.</para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Parameters_NoReboot"> <summary> <para> <para><b>[Custom AMI policies only]</b> Indicates whether targeted instances are rebooted when the lifecycle policy runs. <c>true</c> indicates that targeted instances are not rebooted when the policy runs. <c>false</c> indicates that target instances are rebooted when the policy runs. The default is <c>true</c> (instances are not rebooted).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyId"> <summary> <para> <para>The identifier of the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_PolicyLanguage"> <summary> <para> <para>The type of policy to create. Specify one of the following:</para><ul><li><para><c>SIMPLIFIED</c> To create a default policy.</para></li><li><para><c>STANDARD</c> To create a custom policy.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_PolicyType"> <summary> <para> <para><b>[Custom policies only]</b> The valid target resource types and actions a policy can manage. Specify <c>EBS_SNAPSHOT_MANAGEMENT</c> to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify <c>IMAGE_MANAGEMENT</c> to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify <c>EVENT_BASED_POLICY </c> to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.</para><para>The default is <c>EBS_SNAPSHOT_MANAGEMENT</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_ResourceLocation"> <summary> <para> <para><b>[Custom snapshot and AMI policies only]</b> The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify <c>CLOUD</c>. If the source resources are located on an Outpost in your account, specify <c>OUTPOST</c>.</para><para>If you specify <c>OUTPOST</c>, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_SimplifiedResourceType"> <summary> <para> <para><b>[Default policies only]</b> Specify the type of default policy to create.</para><ul><li><para>To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify <c>VOLUME</c>.</para></li><li><para>To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify <c>INSTANCE</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_ResourceType"> <summary> <para> <para><b>[Custom snapshot policies only]</b> The target resource type for snapshot and AMI lifecycle policies. Use <c>VOLUME </c>to create snapshots of individual volumes or use <c>INSTANCE</c> to create multi-volume snapshots from the volumes for an instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_RetainInterval"> <summary> <para> <para><b>[Default policies only]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.</para><para>Default: 7</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.RetainInterval"> <summary> <para> <para><b>[Default policies only]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_Schedule"> <summary> <para> <para><b>[Custom snapshot and AMI policies only]</b> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Parameters_SnapshotOwner"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.State"> <summary> <para> <para>The desired activation state of the lifecycle policy after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_TargetTag"> <summary> <para> <para><b>[Custom snapshot and AMI policies only]</b> The single tag that identifies targeted resources for this policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.EventSource_Type"> <summary> <para> <para>The source of the event. Currently only managed CloudWatch Events rules are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |