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>GetLifecyclePolicy</a>. </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 <code>key=value</code>.</para><para>These user-defined tags are added in addition to the AWS-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 <code>key=value</code>.</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 a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies. </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_ExcludeBootVolume"> <summary> <para> <para>[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html">CreateSnapshots</a>. The default is false.</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.PolicyDetails_PolicyType"> <summary> <para> <para>The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_ResourceType"> <summary> <para> <para>The resource type. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.PolicyDetails_Schedule"> <summary> <para> <para>The schedule of policy-defined actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.NewDLMLifecyclePolicyCmdlet.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.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>The single tag that identifies targeted resources for this policy.</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. </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. </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_ExcludeBootVolume"> <summary> <para> <para>[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html">CreateSnapshots</a>. The default is false.</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.PolicyId"> <summary> <para> <para>The identifier of the lifecycle policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_PolicyType"> <summary> <para> <para>The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_ResourceType"> <summary> <para> <para>The resource type. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DLM.UpdateDLMLifecyclePolicyCmdlet.PolicyDetails_Schedule"> <summary> <para> <para>The schedule of policy-defined actions.</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>The single tag that identifies targeted resources for this policy.</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> |